Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
KnowledgeBaseRetrievalRequest Class
Definition
- Namespace:
- Azure.Search.Documents.KnowledgeBases.Models
- Assembly:
- Azure.Search.Documents.dll
- Package:
- Azure.Search.Documents v12.0.0
- Package:
- Azure.Search.Documents v12.1.0-beta.1
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The input contract for the retrieval request.
public class KnowledgeBaseRetrievalRequest : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest>type KnowledgeBaseRetrievalRequest = class
interface IJsonModel<KnowledgeBaseRetrievalRequest>
interface IPersistableModel<KnowledgeBaseRetrievalRequest>Public Class KnowledgeBaseRetrievalRequest
Implements IJsonModel(Of KnowledgeBaseRetrievalRequest), IPersistableModel(Of KnowledgeBaseRetrievalRequest)- Inheritance
-
KnowledgeBaseRetrievalRequest
- Implements
Constructors
| Name | Description |
|---|---|
| KnowledgeBaseRetrievalRequest() |
Initializes a new instance of KnowledgeBaseRetrievalRequest. |
Properties
| Name | Description |
|---|---|
| IncludeActivity |
Indicates retrieval results should include activity information. |
| Intents |
A list of intended queries to execute without model query planning. |
| KnowledgeSourceParams |
A list of runtime parameters for the knowledge sources. |
| MaxOutputDocuments |
Limits the maximum number of documents in the output. |
| MaxOutputSize |
Limits the maximum size of the content in the output. |
| MaxOutputSizeInTokens |
Limits the maximum size of the content in the output. |
| MaxRuntimeInSeconds |
The maximum runtime in seconds. |
| Messages |
A list of chat message style input. |
| OutputMode |
The output configuration for this retrieval. |
| RetrievalReasoningEffort |
The retrieval reasoning effort configuration. |
Methods
Operators
| Name | Description |
|---|---|
| Implicit(KnowledgeBaseRetrievalRequest to RequestContent) | |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<KnowledgeBaseRetrievalRequest>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<KnowledgeBaseRetrievalRequest>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<KnowledgeBaseRetrievalRequest>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<KnowledgeBaseRetrievalRequest>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<KnowledgeBaseRetrievalRequest>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
Applies to
Azure SDK for .NET
Feedback
Was this page helpful?