models Package

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.

Base type for activity records. Tracks execution details, timing, and errors for knowledge base operations.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: KnowledgeBaseAgenticReasoningActivityRecord, KnowledgeBaseModelWebSummarizationActivityRecord

Represents an agentic reasoning activity record.

Represents an Azure Blob Storage document reference.

The resource management error additional info.

The error details.

Image content.

Represents an indexed OneLake document reference.

The natural language message style object.

Specifies the type of the message content.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: KnowledgeBaseMessageImageContent, KnowledgeBaseMessageTextContent

Image message type.

Text message type.

Represents an LLM web summarization activity record.

Base type for references.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: KnowledgeBaseAzureBlobReference, KnowledgeBaseIndexedOneLakeReference, KnowledgeBaseSearchIndexReference, KnowledgeBaseWebReference

The input contract for the retrieval request.

The output contract for the retrieval response.

Represents an Azure Search document reference.

Represents a web document reference.

An intended query to execute without model query planning.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: KnowledgeRetrievalSemanticIntent

Run knowledge retrieval with minimal reasoning effort.

Base type for reasoning effort.

You probably want to use the sub-classes and not this class directly. Known sub-classes 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.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureBlobKnowledgeSourceParams, IndexedOneLakeKnowledgeSourceParams, SearchIndexKnowledgeSourceParams, 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.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: KnowledgeSourceAzureOpenAIVectorizer

Specifies runtime parameters for a search index knowledge source.

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

Specifies runtime parameters for a web knowledge source.

The type of activity record.

The type of message content.

The type of reference.

The kind of knowledge base configuration to use.

The amount of effort to use during retrieval.