Azure.Search.Documents.KnowledgeBases.Models Namespace
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.
Classes
| Name | Description |
|---|---|
| AIServices |
Parameters for AI Services. |
| AssetStore |
Configuration for an asset store used to store extracted assets such as images. |
| AzureBlobKnowledgeSourceParams |
Specifies runtime parameters for a azure blob knowledge source. |
| CompletedSynchronizationState |
Represents the completed state of the last synchronization. |
| FabricDataAgentKnowledgeSourceParams |
Specifies runtime parameters for a Fabric Data Agent knowledge source. |
| FabricOntologyKnowledgeSourceParams |
Specifies runtime parameters for a Fabric Ontology knowledge source. |
| FileKnowledgeSourceParams |
Specifies runtime parameters for a File knowledge source. |
| FreshnessPolicy |
Configuration for freshness-aware retrieval. When set, newer documents receive a ranking boost during retrieval. |
| ImageServingStatistics |
Statistics about image serving during a retrieval activity. |
| IndexedOneLakeKnowledgeSourceParams |
Specifies runtime parameters for a indexed OneLake knowledge source. |
| IndexedSharePointKnowledgeSourceParams |
Specifies runtime parameters for a indexed SharePoint knowledge source. |
| IndexedSqlKnowledgeSourceParams |
Specifies runtime parameters for an indexed SQL knowledge source. |
| KnowledgeBaseActivityRecord |
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. |
| KnowledgeBaseAgenticReasoningActivityRecord |
Represents an agentic reasoning activity record. |
| KnowledgeBaseAzureBlobActivityArguments |
Represents the arguments the azure blob retrieval activity was run with. |
| KnowledgeBaseAzureBlobActivityRecord |
Represents a azure blob retrieval activity record. |
| KnowledgeBaseAzureBlobReference |
Represents an Azure Blob Storage document reference. |
| KnowledgeBaseErrorAdditionalInfo |
The resource management error additional info. |
| KnowledgeBaseErrorDetail |
The error details. |
| KnowledgeBaseFabricDataAgentActivityArguments |
Represents the arguments the Fabric Data Agent retrieval activity was run with. |
| KnowledgeBaseFabricDataAgentActivityRecord |
Represents a Fabric Data Agent retrieval activity record. |
| KnowledgeBaseFabricDataAgentReference |
Represents a Fabric Data Agent document reference. |
| KnowledgeBaseFabricOntologyActivityArguments |
Represents the arguments the Fabric Ontology retrieval activity was run with. |
| KnowledgeBaseFabricOntologyActivityRecord |
Represents a Fabric Ontology retrieval activity record. |
| KnowledgeBaseFabricOntologyReference |
Represents a Fabric Ontology document reference. |
| KnowledgeBaseFileActivityArguments |
Represents the arguments the File retrieval activity was run with. |
| KnowledgeBaseFileActivityRecord |
Represents a File retrieval activity record. |
| KnowledgeBaseFileReference |
Represents a file document reference. |
| KnowledgeBaseImageContent |
Image content. |
| KnowledgeBaseIndexedOneLakeActivityArguments |
Represents the arguments the indexed OneLake retrieval activity was run with. |
| KnowledgeBaseIndexedOneLakeActivityRecord |
Represents a indexed OneLake retrieval activity record. |
| KnowledgeBaseIndexedOneLakeReference |
Represents an indexed OneLake document reference. |
| KnowledgeBaseIndexedSharePointActivityArguments |
Represents the arguments the indexed SharePoint retrieval activity was run with. |
| KnowledgeBaseIndexedSharePointActivityRecord |
Represents a indexed SharePoint retrieval activity record. |
| KnowledgeBaseIndexedSharePointReference |
Represents an indexed SharePoint document reference. |
| KnowledgeBaseIndexedSqlActivityArguments |
Represents the arguments the indexed SQL retrieval activity was run with. |
| KnowledgeBaseIndexedSqlActivityRecord |
Represents an indexed SQL retrieval activity record. |
| KnowledgeBaseIndexedSqlReference |
Represents an Azure SQL document reference. |
| KnowledgeBaseMcpServerActivityArguments |
Represents the arguments the MCP server retrieval activity was run with. |
| KnowledgeBaseMcpServerActivityRecord |
Represents an MCP server retrieval activity record. |
| KnowledgeBaseMcpServerReference |
Represents an MCP server document reference. |
| KnowledgeBaseMessage |
The natural language message style object. |
| KnowledgeBaseMessageContent |
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. |
| KnowledgeBaseMessageImageContent |
Image message type. |
| KnowledgeBaseMessageTextContent |
Text message type. |
| KnowledgeBaseModelAnswerSynthesisActivityRecord |
Represents an LLM answer synthesis activity record. |
| KnowledgeBaseModelQueryPlanningActivityRecord |
Represents an LLM query planning activity record. |
| KnowledgeBaseModelWebSummarizationActivityRecord |
Represents an LLM web summarization activity record. |
| KnowledgeBaseReference |
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. |
| KnowledgeBaseRemoteSharePointActivityArguments |
Represents the arguments the remote SharePoint retrieval activity was run with. |
| KnowledgeBaseRemoteSharePointActivityRecord |
Represents a remote SharePoint retrieval activity record. |
| KnowledgeBaseRemoteSharePointReference |
Represents a remote SharePoint document reference. |
| KnowledgeBaseRetrievalRequest |
The input contract for the retrieval request. |
| KnowledgeBaseRetrievalResponse |
The output contract for the retrieval response. |
| KnowledgeBaseSearchIndexActivityArguments |
Represents the arguments the search index retrieval activity was run with. |
| KnowledgeBaseSearchIndexActivityRecord |
Represents a search index retrieval activity record. |
| KnowledgeBaseSearchIndexReference |
Represents an Azure Search document reference. |
| KnowledgeBaseWebActivityArguments |
Represents the arguments the web retrieval activity was run with. |
| KnowledgeBaseWebActivityRecord |
Represents a web retrieval activity record. |
| KnowledgeBaseWebReference |
Represents a web document reference. |
| KnowledgeBaseWorkIQActivityArguments |
Represents the arguments the WorkIQ retrieval activity was run with. |
| KnowledgeBaseWorkIQActivityRecord |
Represents a WorkIQ retrieval activity record. |
| KnowledgeBaseWorkIQReference |
Represents a WorkIQ document reference. |
| KnowledgeRetrievalIntent |
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. |
| KnowledgeRetrievalLowReasoningEffort |
Run knowledge retrieval with low reasoning effort. |
| KnowledgeRetrievalMediumReasoningEffort |
Run knowledge retrieval with medium reasoning effort. |
| KnowledgeRetrievalMinimalReasoningEffort |
Run knowledge retrieval with minimal reasoning effort. |
| KnowledgeRetrievalReasoningEffort |
Base type for reasoning effort. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeRetrievalMinimalReasoningEffort, KnowledgeRetrievalLowReasoningEffort, and KnowledgeRetrievalMediumReasoningEffort. |
| KnowledgeRetrievalSemanticIntent |
A semantic query intent. |
| KnowledgeSourceAzureOpenAIVectorizer |
Specifies the Azure OpenAI resource used to vectorize a query string. |
| KnowledgeSourceIngestionParameters |
Consolidates all general ingestion settings for knowledge sources. |
| KnowledgeSourceParams |
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. |
| KnowledgeSourceStatistics |
Statistical information about knowledge source synchronization history. |
| KnowledgeSourceStatus |
Represents the status and synchronization history of a knowledge source. |
| KnowledgeSourceSynchronizationError |
Represents a document-level indexing error encountered during a knowledge source synchronization run. |
| KnowledgeSourceVectorizer |
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. |
| McpServerKnowledgeSourceParams |
Specifies runtime parameters for an MCP server knowledge source. |
| PurviewSensitivityLabelInfo |
Information about the sensitivity label applied to a document. |
| RemoteSharePointKnowledgeSourceParams |
Specifies runtime parameters for a remote SharePoint knowledge source. |
| SearchIndexKnowledgeSourceParams |
Specifies runtime parameters for a search index knowledge source. |
| SynchronizationState |
Represents the current state of an ongoing synchronization that spans multiple indexer runs. |
| WebKnowledgeSourceParams |
Specifies runtime parameters for a web knowledge source. |
| WorkIQAttribution |
Attribution information for a WorkIQ reference. |
| WorkIQKnowledgeSourceParams |
Specifies runtime parameters for a WorkIQ knowledge source. |
Structs
| Name | Description |
|---|---|
| KnowledgeRetrievalOutputMode |
The output configuration for this retrieval. |
