models Package

Classes

AIServices	Parameters for AI Services.
AzureBlobKnowledgeSourceParams	Specifies runtime parameters for a azure blob knowledge source.
CompletedSynchronizationState	Represents the completed state of the last synchronization.
IndexedOneLakeKnowledgeSourceParams	Specifies runtime parameters for a indexed OneLake knowledge source.
KnowledgeBaseActivityRecord	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
KnowledgeBaseAgenticReasoningActivityRecord	Represents an agentic reasoning activity record.
KnowledgeBaseAzureBlobReference	Represents an Azure Blob Storage document reference.
KnowledgeBaseErrorAdditionalInfo	The resource management error additional info.
KnowledgeBaseErrorDetail	The error details.
KnowledgeBaseImageContent	Image content.
KnowledgeBaseIndexedOneLakeReference	Represents an indexed OneLake document reference.
KnowledgeBaseMessage	The natural language message style object.
KnowledgeBaseMessageContent	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
KnowledgeBaseMessageImageContent	Image message type.
KnowledgeBaseMessageTextContent	Text message type.
KnowledgeBaseModelWebSummarizationActivityRecord	Represents an LLM web summarization activity record.
KnowledgeBaseReference	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
KnowledgeBaseRetrievalRequest	The input contract for the retrieval request.
KnowledgeBaseRetrievalResponse	The output contract for the retrieval response.
KnowledgeBaseSearchIndexReference	Represents an Azure Search document reference.
KnowledgeBaseWebReference	Represents a web document reference.
KnowledgeRetrievalIntent	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
KnowledgeRetrievalMinimalReasoningEffort	Run knowledge retrieval with minimal reasoning effort.
KnowledgeRetrievalReasoningEffort	Base type for reasoning effort. You probably want to use the sub-classes and not this class directly. Known sub-classes are: KnowledgeRetrievalMinimalReasoningEffort
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. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureBlobKnowledgeSourceParams, IndexedOneLakeKnowledgeSourceParams, SearchIndexKnowledgeSourceParams, WebKnowledgeSourceParams
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. You probably want to use the sub-classes and not this class directly. Known sub-classes are: KnowledgeSourceAzureOpenAIVectorizer
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.

Enums

KnowledgeBaseActivityRecordType	The type of activity record.
KnowledgeBaseMessageContentType	The type of message content.
KnowledgeBaseReferenceType	The type of reference.
KnowledgeRetrievalIntentType	The kind of knowledge base configuration to use.
KnowledgeRetrievalReasoningEffortKind	The amount of effort to use during retrieval.