azure.search.documents.agent.aio package

class azure.search.documents.agent.aio.KnowledgeAgentRetrievalClient(endpoint: str, agent_name: str, credential: AzureKeyCredential | AsyncTokenCredential, **kwargs: Any)[source]

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 AsyncTokenCredential) – 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.

async close() → None[source]

Close the session.

Returns:

None

Return type:

None

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