Azure.Search.Documents.KnowledgeBases.Models Namespace

Parameters for AI Services.

Specifies runtime parameters for a azure blob knowledge source.

Represents the completed state of the last synchronization.

Specifies runtime parameters for a indexed OneLake knowledge source.

Specifies runtime parameters for a indexed SharePoint knowledge source.

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: KnowledgeBaseModelWebSummarizationActivityRecord and KnowledgeBaseAgenticReasoningActivityRecord.

Represents an agentic reasoning activity record.

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.

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 Azure Blob Storage 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.

Base type for references. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseSearchIndexReference, KnowledgeBaseAzureBlobReference, KnowledgeBaseIndexedOneLakeReference, and KnowledgeBaseWebReference.

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

Represents a remote SharePoint retrieval activity record.

Represents a remote SharePoint document reference.

Represents a retrieval activity record. Please note KnowledgeBaseRetrievalActivityRecord is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include KnowledgeBaseAzureBlobActivityRecord, KnowledgeBaseIndexedOneLakeActivityRecord, KnowledgeBaseIndexedSharePointActivityRecord, KnowledgeBaseRemoteSharePointActivityRecord, KnowledgeBaseSearchIndexActivityRecord and KnowledgeBaseWebActivityRecord.

The input contract for the retrieval request.

The output contract for the retrieval response.

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

Represents a search index retrieval activity record.

Represents an Azure Search document reference.

Represents the arguments the web retrieval activity was run with.

Represents a web retrieval activity record.

Represents a web document reference.

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.

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, IndexedOneLakeKnowledgeSourceParams, and WebKnowledgeSourceParams.

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 a remote SharePoint knowledge source.

Specifies runtime parameters for a search index knowledge source.

Information about the sensitivity label applied to a SharePoint document.

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

Specifies runtime parameters for a web knowledge source.

The type of message content.

The kind of knowledge base configuration to use.

The output configuration for this retrieval.

The amount of effort to use during retrieval.