KnowledgeBaseRetrievalClient Class

A client that can be used to query a knowledge base.

Constructor

KnowledgeBaseRetrievalClient(endpoint: str, knowledge_base_name: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

Parameters

Name	Description
endpoint Required	str The URL endpoint of an Azure search service.
knowledge_base_name Required	str The name of the knowledge base. Required.
credential Required	AzureKeyCredential or TokenCredential A credential to authorize search client requests.

Keyword-Only Parameters

Name	Description
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.

Methods

close	Close the session.
retrieve

close

Close the session.

close() -> None

Returns

Type	Description
None	None

retrieve

retrieve(retrieval_request: KnowledgeBaseRetrievalRequest | IO[bytes], x_ms_query_source_authorization: str | None = None, request_options: RequestOptions | None = None, **kwargs: Any) -> KnowledgeBaseRetrievalResponse

Parameters

Name	Description
retrieval_request Required
x_ms_query_source_authorization	Default value: None
request_options	Default value: None