Package com.azure.search.documents.knowledgebases.models

package com.azure.search.documents.knowledgebases.models

Package containing the data models for KnowledgeBaseRetrievalClient. Client that can be used to query an knowledge base.

Related Packages

Package	Description
com.azure.search.documents.knowledgebases	For more information about Azure AI Search KnowledgeBases, supported features, and usage guidelines, see the Azure documentation and the Azure SDK for Java guidelines.

Classes

Class	Description
AzureBlobKnowledgeSourceParams	Specifies runtime parameters for a azure blob knowledge source.
IndexedOneLakeKnowledgeSourceParams	Specifies runtime parameters for a indexed OneLake knowledge source.
IndexedSharePointKnowledgeSourceParams	Specifies runtime parameters for a indexed SharePoint knowledge source.
KnowledgeBaseActivityRecord	Base type for activity records.
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.
KnowledgeBaseIndexedOneLakeActivityArguments	Represents the arguments the indexed OneLake retrieval activity was run with.
KnowledgeBaseIndexedOneLakeActivityRecord	Represents a indexed OneLake retrieval activity record.
KnowledgeBaseIndexedOneLakeReference	Represents an Azure Blob Storage 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 Azure Blob Storage document reference.
KnowledgeBaseMessage	The natural language message style object.
KnowledgeBaseMessageContent	Specifies the type of the message content.
KnowledgeBaseMessageContentType	The type of message content.
KnowledgeBaseMessageImageContent	Text message type.
KnowledgeBaseMessageImageContentImage	The KnowledgeBaseMessageImageContentImage model.
KnowledgeBaseMessageTextContent	Text message type.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Represents an LLM answer synthesis activity record.
KnowledgeBaseModelQueryPlanningActivityRecord	Represents an LLM query planning activity record.
KnowledgeBaseReference	Base type for references.
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.
KnowledgeBaseRetrievalActivityRecord	Represents a retrieval activity record.
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.
KnowledgeRetrievalIntent	An intended query to execute without model query planning.
KnowledgeRetrievalIntentType	The kind of knowledge base configuration to use.
KnowledgeRetrievalLowReasoningEffort	Run knowledge retrieval with low reasoning effort.
KnowledgeRetrievalMediumReasoningEffort	Run knowledge retrieval with medium reasoning effort.
KnowledgeRetrievalMinimalReasoningEffort	Run knowledge retrieval with minimal reasoning effort.
KnowledgeRetrievalOutputMode	The output configuration for this retrieval.
KnowledgeRetrievalReasoningEffort	The KnowledgeRetrievalReasoningEffort model.
KnowledgeRetrievalReasoningEffortKind	The amount of effort to use during retrieval.
KnowledgeRetrievalSemanticIntent	The KnowledgeRetrievalSemanticIntent model.
KnowledgeSourceKind	The kind of the knowledge source.
KnowledgeSourceParams	The KnowledgeSourceParams model.
RemoteSharePointKnowledgeSourceParams	Specifies runtime parameters for a remote SharePoint knowledge source.
SearchIndexFieldReference	The SearchIndexFieldReference model.
SearchIndexKnowledgeSourceParams	Specifies runtime parameters for a search index knowledge source.
SharePointSensitivityLabelInfo	Information about the sensitivity label applied to a SharePoint document.
WebKnowledgeSourceParams	Specifies runtime parameters for a web knowledge source.