azure.search.documents.agent package

class azure.search.documents.agent.KnowledgeAgentRetrievalClient(endpoint: str, agent_name: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

A client that can be used to query an agent.

Parameters:

• endpoint (str) – The URL endpoint of an Azure search service

• agent_name (str) – The name of the agent. Required.

• credential (AzureKeyCredential or TokenCredential) – A credential to authorize search client requests

Keyword Arguments:

• api_version (str) – The Search API version to use for requests.

• audience (str) – sets the Audience to use for authentication with Microsoft Entra ID. The audience is not considered when using a shared key. If audience is not provided, the public cloud audience will be assumed.

close() → None

Close the session.

Returns:

None

Return type:

None

retrieve(retrieval_request: KnowledgeAgentRetrievalRequest | IO[bytes], x_ms_query_source_authorization: str | None = None, request_options: RequestOptions | None = None, **kwargs: Any) → KnowledgeAgentRetrievalResponse

Subpackages

• azure.search.documents.agent.aio package
  • KnowledgeAgentRetrievalClient
    • KnowledgeAgentRetrievalClient.close()
    • KnowledgeAgentRetrievalClient.retrieve()
• azure.search.documents.agent.models package
  • KnowledgeAgentActivityRecord
    • KnowledgeAgentActivityRecord.deserialize()
    • KnowledgeAgentActivityRecord.enable_additional_properties_sending()
    • KnowledgeAgentActivityRecord.from_dict()
    • KnowledgeAgentActivityRecord.is_xml_model()
    • KnowledgeAgentActivityRecord.as_dict()
    • KnowledgeAgentActivityRecord.serialize()
  • KnowledgeAgentAzureBlobActivityArguments
    • KnowledgeAgentAzureBlobActivityArguments.deserialize()
    • KnowledgeAgentAzureBlobActivityArguments.enable_additional_properties_sending()
    • KnowledgeAgentAzureBlobActivityArguments.from_dict()
    • KnowledgeAgentAzureBlobActivityArguments.is_xml_model()
    • KnowledgeAgentAzureBlobActivityArguments.as_dict()
    • KnowledgeAgentAzureBlobActivityArguments.serialize()
  • KnowledgeAgentAzureBlobActivityRecord
    • KnowledgeAgentAzureBlobActivityRecord.deserialize()
    • KnowledgeAgentAzureBlobActivityRecord.enable_additional_properties_sending()
    • KnowledgeAgentAzureBlobActivityRecord.from_dict()
    • KnowledgeAgentAzureBlobActivityRecord.is_xml_model()
    • KnowledgeAgentAzureBlobActivityRecord.as_dict()
    • KnowledgeAgentAzureBlobActivityRecord.serialize()
  • KnowledgeAgentAzureBlobReference
    • KnowledgeAgentAzureBlobReference.deserialize()
    • KnowledgeAgentAzureBlobReference.enable_additional_properties_sending()
    • KnowledgeAgentAzureBlobReference.from_dict()
    • KnowledgeAgentAzureBlobReference.is_xml_model()
    • KnowledgeAgentAzureBlobReference.as_dict()
    • KnowledgeAgentAzureBlobReference.serialize()
  • KnowledgeAgentMessage
    • KnowledgeAgentMessage.deserialize()
    • KnowledgeAgentMessage.enable_additional_properties_sending()
    • KnowledgeAgentMessage.from_dict()
    • KnowledgeAgentMessage.is_xml_model()
    • KnowledgeAgentMessage.as_dict()
    • KnowledgeAgentMessage.serialize()
  • KnowledgeAgentMessageContent
    • KnowledgeAgentMessageContent.deserialize()
    • KnowledgeAgentMessageContent.enable_additional_properties_sending()
    • KnowledgeAgentMessageContent.from_dict()
    • KnowledgeAgentMessageContent.is_xml_model()
    • KnowledgeAgentMessageContent.as_dict()
    • KnowledgeAgentMessageContent.serialize()
  • KnowledgeAgentMessageContentType
    • KnowledgeAgentMessageContentType.maketrans()
    • KnowledgeAgentMessageContentType.capitalize()
    • KnowledgeAgentMessageContentType.casefold()
    • KnowledgeAgentMessageContentType.center()
    • KnowledgeAgentMessageContentType.count()
    • KnowledgeAgentMessageContentType.encode()
    • KnowledgeAgentMessageContentType.endswith()
    • KnowledgeAgentMessageContentType.expandtabs()
    • KnowledgeAgentMessageContentType.find()
    • KnowledgeAgentMessageContentType.format()
    • KnowledgeAgentMessageContentType.format_map()
    • KnowledgeAgentMessageContentType.index()
    • KnowledgeAgentMessageContentType.isalnum()
    • KnowledgeAgentMessageContentType.isalpha()
    • KnowledgeAgentMessageContentType.isascii()
    • KnowledgeAgentMessageContentType.isdecimal()
    • KnowledgeAgentMessageContentType.isdigit()
    • KnowledgeAgentMessageContentType.isidentifier()
    • KnowledgeAgentMessageContentType.islower()
    • KnowledgeAgentMessageContentType.isnumeric()
    • KnowledgeAgentMessageContentType.isprintable()
    • KnowledgeAgentMessageContentType.isspace()
    • KnowledgeAgentMessageContentType.istitle()
    • KnowledgeAgentMessageContentType.isupper()
    • KnowledgeAgentMessageContentType.join()
    • KnowledgeAgentMessageContentType.ljust()
    • KnowledgeAgentMessageContentType.lower()
    • KnowledgeAgentMessageContentType.lstrip()
    • KnowledgeAgentMessageContentType.partition()
    • KnowledgeAgentMessageContentType.removeprefix()
    • KnowledgeAgentMessageContentType.removesuffix()
    • KnowledgeAgentMessageContentType.replace()
    • KnowledgeAgentMessageContentType.rfind()
    • KnowledgeAgentMessageContentType.rindex()
    • KnowledgeAgentMessageContentType.rjust()
    • KnowledgeAgentMessageContentType.rpartition()
    • KnowledgeAgentMessageContentType.rsplit()
    • KnowledgeAgentMessageContentType.rstrip()
    • KnowledgeAgentMessageContentType.split()
    • KnowledgeAgentMessageContentType.splitlines()
    • KnowledgeAgentMessageContentType.startswith()
    • KnowledgeAgentMessageContentType.strip()
    • KnowledgeAgentMessageContentType.swapcase()
    • KnowledgeAgentMessageContentType.title()
    • KnowledgeAgentMessageContentType.translate()
    • KnowledgeAgentMessageContentType.upper()
    • KnowledgeAgentMessageContentType.zfill()
    • KnowledgeAgentMessageContentType.IMAGE
    • KnowledgeAgentMessageContentType.TEXT
  • KnowledgeAgentMessageImageContent
    • KnowledgeAgentMessageImageContent.deserialize()
    • KnowledgeAgentMessageImageContent.enable_additional_properties_sending()
    • KnowledgeAgentMessageImageContent.from_dict()
    • KnowledgeAgentMessageImageContent.is_xml_model()
    • KnowledgeAgentMessageImageContent.as_dict()
    • KnowledgeAgentMessageImageContent.serialize()
  • KnowledgeAgentMessageImageContentImage
    • KnowledgeAgentMessageImageContentImage.deserialize()
    • KnowledgeAgentMessageImageContentImage.enable_additional_properties_sending()
    • KnowledgeAgentMessageImageContentImage.from_dict()
    • KnowledgeAgentMessageImageContentImage.is_xml_model()
    • KnowledgeAgentMessageImageContentImage.as_dict()
    • KnowledgeAgentMessageImageContentImage.serialize()
  • KnowledgeAgentMessageTextContent
    • KnowledgeAgentMessageTextContent.deserialize()
    • KnowledgeAgentMessageTextContent.enable_additional_properties_sending()
    • KnowledgeAgentMessageTextContent.from_dict()
    • KnowledgeAgentMessageTextContent.is_xml_model()
    • KnowledgeAgentMessageTextContent.as_dict()
    • KnowledgeAgentMessageTextContent.serialize()
  • KnowledgeAgentModelAnswerSynthesisActivityRecord
    • KnowledgeAgentModelAnswerSynthesisActivityRecord.deserialize()
    • KnowledgeAgentModelAnswerSynthesisActivityRecord.enable_additional_properties_sending()
    • KnowledgeAgentModelAnswerSynthesisActivityRecord.from_dict()
    • KnowledgeAgentModelAnswerSynthesisActivityRecord.is_xml_model()
    • KnowledgeAgentModelAnswerSynthesisActivityRecord.as_dict()
    • KnowledgeAgentModelAnswerSynthesisActivityRecord.serialize()
  • KnowledgeAgentModelQueryPlanningActivityRecord
    • KnowledgeAgentModelQueryPlanningActivityRecord.deserialize()
    • KnowledgeAgentModelQueryPlanningActivityRecord.enable_additional_properties_sending()
    • KnowledgeAgentModelQueryPlanningActivityRecord.from_dict()
    • KnowledgeAgentModelQueryPlanningActivityRecord.is_xml_model()
    • KnowledgeAgentModelQueryPlanningActivityRecord.as_dict()
    • KnowledgeAgentModelQueryPlanningActivityRecord.serialize()
  • KnowledgeAgentReference
    • KnowledgeAgentReference.deserialize()
    • KnowledgeAgentReference.enable_additional_properties_sending()
    • KnowledgeAgentReference.from_dict()
    • KnowledgeAgentReference.is_xml_model()
    • KnowledgeAgentReference.as_dict()
    • KnowledgeAgentReference.serialize()
  • KnowledgeAgentRetrievalActivityRecord
    • KnowledgeAgentRetrievalActivityRecord.deserialize()
    • KnowledgeAgentRetrievalActivityRecord.enable_additional_properties_sending()
    • KnowledgeAgentRetrievalActivityRecord.from_dict()
    • KnowledgeAgentRetrievalActivityRecord.is_xml_model()
    • KnowledgeAgentRetrievalActivityRecord.as_dict()
    • KnowledgeAgentRetrievalActivityRecord.serialize()
  • KnowledgeAgentRetrievalRequest
    • KnowledgeAgentRetrievalRequest.deserialize()
    • KnowledgeAgentRetrievalRequest.enable_additional_properties_sending()
    • KnowledgeAgentRetrievalRequest.from_dict()
    • KnowledgeAgentRetrievalRequest.is_xml_model()
    • KnowledgeAgentRetrievalRequest.as_dict()
    • KnowledgeAgentRetrievalRequest.serialize()
  • KnowledgeAgentRetrievalResponse
    • KnowledgeAgentRetrievalResponse.deserialize()
    • KnowledgeAgentRetrievalResponse.enable_additional_properties_sending()
    • KnowledgeAgentRetrievalResponse.from_dict()
    • KnowledgeAgentRetrievalResponse.is_xml_model()
    • KnowledgeAgentRetrievalResponse.as_dict()
    • KnowledgeAgentRetrievalResponse.serialize()
  • KnowledgeAgentSearchIndexActivityArguments
    • KnowledgeAgentSearchIndexActivityArguments.deserialize()
    • KnowledgeAgentSearchIndexActivityArguments.enable_additional_properties_sending()
    • KnowledgeAgentSearchIndexActivityArguments.from_dict()
    • KnowledgeAgentSearchIndexActivityArguments.is_xml_model()
    • KnowledgeAgentSearchIndexActivityArguments.as_dict()
    • KnowledgeAgentSearchIndexActivityArguments.serialize()
  • KnowledgeAgentSearchIndexActivityRecord
    • KnowledgeAgentSearchIndexActivityRecord.deserialize()
    • KnowledgeAgentSearchIndexActivityRecord.enable_additional_properties_sending()
    • KnowledgeAgentSearchIndexActivityRecord.from_dict()
    • KnowledgeAgentSearchIndexActivityRecord.is_xml_model()
    • KnowledgeAgentSearchIndexActivityRecord.as_dict()
    • KnowledgeAgentSearchIndexActivityRecord.serialize()
  • KnowledgeAgentSearchIndexReference
    • KnowledgeAgentSearchIndexReference.deserialize()
    • KnowledgeAgentSearchIndexReference.enable_additional_properties_sending()
    • KnowledgeAgentSearchIndexReference.from_dict()
    • KnowledgeAgentSearchIndexReference.is_xml_model()
    • KnowledgeAgentSearchIndexReference.as_dict()
    • KnowledgeAgentSearchIndexReference.serialize()
  • KnowledgeAgentSemanticRerankerActivityRecord
    • KnowledgeAgentSemanticRerankerActivityRecord.deserialize()
    • KnowledgeAgentSemanticRerankerActivityRecord.enable_additional_properties_sending()
    • KnowledgeAgentSemanticRerankerActivityRecord.from_dict()
    • KnowledgeAgentSemanticRerankerActivityRecord.is_xml_model()
    • KnowledgeAgentSemanticRerankerActivityRecord.as_dict()
    • KnowledgeAgentSemanticRerankerActivityRecord.serialize()
  • KnowledgeSourceParams
    • KnowledgeSourceParams.deserialize()
    • KnowledgeSourceParams.enable_additional_properties_sending()
    • KnowledgeSourceParams.from_dict()
    • KnowledgeSourceParams.is_xml_model()
    • KnowledgeSourceParams.as_dict()
    • KnowledgeSourceParams.serialize()
  • RequestOptions
    • RequestOptions.deserialize()
    • RequestOptions.enable_additional_properties_sending()
    • RequestOptions.from_dict()
    • RequestOptions.is_xml_model()
    • RequestOptions.as_dict()
    • RequestOptions.serialize()
  • SearchIndexKnowledgeSourceParams
    • SearchIndexKnowledgeSourceParams.deserialize()
    • SearchIndexKnowledgeSourceParams.enable_additional_properties_sending()
    • SearchIndexKnowledgeSourceParams.from_dict()
    • SearchIndexKnowledgeSourceParams.is_xml_model()
    • SearchIndexKnowledgeSourceParams.as_dict()
    • SearchIndexKnowledgeSourceParams.serialize()