KnowledgeBaseRetrievalClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The KnowledgeBaseRetrievalClient.
public class KnowledgeBaseRetrievalClienttype KnowledgeBaseRetrievalClient = classPublic Class KnowledgeBaseRetrievalClient- Inheritance
-
KnowledgeBaseRetrievalClient
Constructors
| Name | Description |
|---|---|
| KnowledgeBaseRetrievalClient() |
Initializes a new instance of KnowledgeBaseRetrievalClient for mocking. |
| KnowledgeBaseRetrievalClient(KnowledgeBaseRetrievalClientSettings) |
Initializes a new instance of KnowledgeBaseRetrievalClient from a KnowledgeBaseRetrievalClientSettings. |
| KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential, SearchClientOptions) |
Initializes a new instance of KnowledgeBaseRetrievalClient. |
| KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential) |
Initializes a new instance of KnowledgeBaseRetrievalClient. |
| KnowledgeBaseRetrievalClient(Uri, String, TokenCredential, SearchClientOptions) |
Initializes a new instance of KnowledgeBaseRetrievalClient. |
| KnowledgeBaseRetrievalClient(Uri, String, TokenCredential) |
Initializes a new instance of KnowledgeBaseRetrievalClient. |
Properties
| Name | Description |
|---|---|
| Endpoint |
Gets the URI endpoint of the Search service. This is likely to be similar to "https://{search_service}.search.windows.net". |
| KnowledgeBaseName |
Gets the name of the knowledge base. |
| Pipeline |
The HTTP pipeline for sending and receiving REST requests and responses. |
Methods
| Name | Description |
|---|---|
| Retrieve(KnowledgeBaseRetrievalRequest, String, String, CancellationToken) |
KnowledgeBase retrieves relevant data from backing stores. |
| Retrieve(RequestContent, RequestContext) |
KnowledgeBase retrieves relevant data from backing stores. |
| Retrieve(RequestContent, String, String, RequestContext) |
[Protocol Method] KnowledgeBase retrieves relevant data from backing stores.
|
| RetrieveAsync(KnowledgeBaseRetrievalRequest, String, String, CancellationToken) |
KnowledgeBase retrieves relevant data from backing stores. |
| RetrieveAsync(RequestContent, RequestContext) |
KnowledgeBase retrieves relevant data from backing stores. |
| RetrieveAsync(RequestContent, String, String, RequestContext) |
[Protocol Method] KnowledgeBase retrieves relevant data from backing stores.
|
| RetrieveStreamAsync(KnowledgeBaseRetrievalRequest, String, String, CancellationToken) |
KnowledgeBase retrieves relevant data from backing stores, streaming progress and results as server-sent events on the same connection as they become available, instead of waiting for the full retrieval to complete. |
| RetrieveStreamAsync(RequestContent, String, String, RequestContext) |
[Protocol Method] Retrieves relevant data from backing stores and streams progress and results as server-sent
events.
Process the response incrementally using server-sent event framing. Each event contains an
event name and a JSON-encoded data payload. The stream ends with either a
|
