Azure.Search.Documents.KnowledgeBases.Models Namespace

Parameters for AI Services.

Configuration for an asset store used to store extracted assets such as images.

Specifies runtime parameters for a azure blob knowledge source.

Represents the completed state of the last synchronization.

Specifies runtime parameters for a Fabric Data Agent knowledge source.

Specifies runtime parameters for a Fabric Ontology knowledge source.

Specifies runtime parameters for a File knowledge source.

Configuration for freshness-aware retrieval. When set, newer documents receive a ranking boost during retrieval.

Statistics about image serving during a retrieval activity.

Specifies runtime parameters for a indexed OneLake knowledge source.

Specifies runtime parameters for a indexed SharePoint knowledge source.

Specifies runtime parameters for an indexed SQL knowledge source.

Wraps an activity.completed event payload.

Base type for activity records. Tracks execution details, timing, and errors for knowledge base operations. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseSearchIndexActivityRecord, KnowledgeBaseAzureBlobActivityRecord, KnowledgeBaseIndexedSharePointActivityRecord, KnowledgeBaseIndexedOneLakeActivityRecord, KnowledgeBaseWebActivityRecord, KnowledgeBaseRemoteSharePointActivityRecord, KnowledgeBaseWorkIQActivityRecord, KnowledgeBaseFabricDataAgentActivityRecord, KnowledgeBaseFabricOntologyActivityRecord, KnowledgeBaseMcpServerActivityRecord, KnowledgeBaseFileActivityRecord, KnowledgeBaseIndexedSqlActivityRecord, KnowledgeBaseModelQueryPlanningActivityRecord, KnowledgeBaseModelAnswerSynthesisActivityRecord, KnowledgeBaseModelWebSummarizationActivityRecord, and KnowledgeBaseAgenticReasoningActivityRecord.

Represents the model used for a knowledge base LLM activity, including its model name and deployment identifier.

Emitted immediately before an individual retrieval activity begins executing.

Wraps an activity.started event payload.

Represents an agentic reasoning activity record.

Emitted when a fully validated and post-processed synthesized answer is available.

Wraps an answer.completed event payload.

Represents the arguments the azure blob retrieval activity was run with.

Represents a azure blob retrieval activity record.

Represents an Azure Blob Storage document reference.

The resource management error additional info.

The error details.

Wraps an error event payload.

Represents the arguments the Fabric Data Agent retrieval activity was run with.

Represents a Fabric Data Agent retrieval activity record.

Represents a Fabric Data Agent document reference.

Represents the arguments the Fabric Ontology retrieval activity was run with.

Represents a Fabric Ontology retrieval activity record.

Represents a Fabric Ontology document reference.

Represents the arguments the File retrieval activity was run with.

Represents a File retrieval activity record.

Represents a file document reference.

Image content.

Represents the arguments the indexed OneLake retrieval activity was run with.

Represents a indexed OneLake retrieval activity record.

Represents an indexed OneLake document reference.

Represents the arguments the indexed SharePoint retrieval activity was run with.

Represents a indexed SharePoint retrieval activity record.

Represents an indexed SharePoint document reference.

Represents the arguments the indexed SQL retrieval activity was run with.

Represents an indexed SQL retrieval activity record.

Represents an Azure SQL document reference.

Represents the arguments the MCP server retrieval activity was run with.

Represents an MCP server retrieval activity record.

Represents an MCP server document reference.

The natural language message style object.

Specifies the type of the message content. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseMessageTextContent and KnowledgeBaseMessageImageContent.

Image message type.

Text message type.

Represents an LLM answer synthesis activity record.

Represents an LLM query planning activity record.

Represents an LLM web summarization activity record.

Details about the expressions generated from query hints for a retrieval activity.

Base type for references. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseSearchIndexReference, KnowledgeBaseAzureBlobReference, KnowledgeBaseIndexedSharePointReference, KnowledgeBaseIndexedOneLakeReference, KnowledgeBaseWebReference, KnowledgeBaseRemoteSharePointReference, KnowledgeBaseWorkIQReference, KnowledgeBaseFabricDataAgentReference, KnowledgeBaseFabricOntologyReference, KnowledgeBaseMcpServerReference, KnowledgeBaseFileReference, and KnowledgeBaseIndexedSqlReference.

Wraps a references.completed event payload.

Represents the arguments the remote SharePoint retrieval activity was run with.

Represents a remote SharePoint retrieval activity record.

Represents a remote SharePoint document reference.

Emitted after retrieval completes successfully.

Wraps a response.completed event payload.

The input contract for the retrieval request.

The output contract for the retrieval response.

Emitted once retrieval preflight validation completes, before any activity begins.

Wraps a retrieval.started event payload.

Base type for events emitted by a streaming knowledge base retrieval.

Represents the arguments the search index retrieval activity was run with.

Represents a search index retrieval activity record.

Represents an Azure Search document reference.

Emitted in place of response.completed if retrieval fails after the stream starts.

Represents the arguments the web retrieval activity was run with.

Represents a web retrieval activity record.

Represents a web document reference.

Represents the arguments the WorkIQ retrieval activity was run with.

Represents a WorkIQ retrieval activity record.

Represents a WorkIQ document reference.

Automatically select the reasoning effort during retrieval. The service seeds every request at the cheapest tier and escalates only as far as needed, up to the service's maximum available tier.

An intended query to execute without model query planning. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeRetrievalSemanticIntent.

Run knowledge retrieval with low reasoning effort.

Run knowledge retrieval with medium reasoning effort.

Run knowledge retrieval with minimal reasoning effort.

Base type for reasoning effort. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeRetrievalMinimalReasoningEffort, KnowledgeRetrievalLowReasoningEffort, KnowledgeRetrievalMediumReasoningEffort, and KnowledgeRetrievalAutoReasoningEffort.

A semantic query intent.

Specifies the Azure OpenAI resource used to vectorize a query string.

Consolidates all general ingestion settings for knowledge sources.

Base type for knowledge source runtime parameters. Please note this is the abstract base class. The derived classes available for instantiation are: SearchIndexKnowledgeSourceParams, AzureBlobKnowledgeSourceParams, IndexedSharePointKnowledgeSourceParams, IndexedOneLakeKnowledgeSourceParams, WebKnowledgeSourceParams, RemoteSharePointKnowledgeSourceParams, WorkIQKnowledgeSourceParams, FabricDataAgentKnowledgeSourceParams, FabricOntologyKnowledgeSourceParams, McpServerKnowledgeSourceParams, FileKnowledgeSourceParams, and IndexedSqlKnowledgeSourceParams.

Statistical information about knowledge source synchronization history.

Represents the status and synchronization history of a knowledge source.

Represents a document-level indexing error encountered during a knowledge source synchronization run.

Specifies the vectorization method to be used for knowledge source embedding model. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeSourceAzureOpenAIVectorizer.

Specifies runtime parameters for an MCP server knowledge source.

Information about the sensitivity label applied to a document.

Specifies runtime parameters for a remote SharePoint knowledge source.

Specifies runtime parameters for a search index knowledge source.

Describes a single image that the model selected to be served during a retrieval activity.

Represents the current state of an ongoing synchronization that spans multiple indexer runs.

An event type not recognized by this version of the client library.

Specifies runtime parameters for a web knowledge source.

Specifies runtime parameters for a WorkIQ knowledge source.

The type of activity record.

The semantic HTTP status of a completed streaming retrieval.

The output configuration for this retrieval.

Specifies the network access mode for knowledge source ingestion. Default is 'public'.