KnowledgeBaseRetrievalClient Constructors
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.
Overloads
| Name | Description |
|---|---|
| KnowledgeBaseRetrievalClient() |
Initializes a new instance of the SearchClient class for mocking. |
| KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential) |
Initializes a new instance of the KnowledgeBaseRetrievalClient class. |
| KnowledgeBaseRetrievalClient(Uri, String, TokenCredential) |
Initializes a new instance of the KnowledgeBaseRetrievalClient class. |
| KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential, SearchClientOptions) |
Initializes a new instance of the KnowledgeBaseRetrievalClient class. |
| KnowledgeBaseRetrievalClient(Uri, String, TokenCredential, SearchClientOptions) |
Initializes a new instance of the KnowledgeBaseRetrievalClient class. |
KnowledgeBaseRetrievalClient()
Initializes a new instance of the SearchClient class for mocking.
protected KnowledgeBaseRetrievalClient();Protected Sub New ()Applies to
KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential)
Initializes a new instance of the KnowledgeBaseRetrievalClient class.
public KnowledgeBaseRetrievalClient(Uri endpoint, string knowledgeBaseName, Azure.AzureKeyCredential credential);new Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient : Uri * string * Azure.AzureKeyCredential -> Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClientPublic Sub New (endpoint As Uri, knowledgeBaseName As String, credential As AzureKeyCredential)Parameters
- endpoint
- Uri
Required. The URI endpoint of the Search service. This is likely to be similar to "https://{search_service}.search.windows.net". The URI must use HTTPS.
- knowledgeBaseName
- String
The name of the knowledge base.
- credential
- AzureKeyCredential
Required. The API key credential used to authenticate requests against the Search service. You need to use an admin key to perform any operations on the SearchIndexClient. See Create and manage api-keys for an Azure Cognitive Search service for more information about API keys in Azure Cognitive Search.
Exceptions
Thrown when the endpoint or credential is null.
Thrown when the endpoint is not using HTTPS.
Applies to
KnowledgeBaseRetrievalClient(Uri, String, TokenCredential)
Initializes a new instance of the KnowledgeBaseRetrievalClient class.
public KnowledgeBaseRetrievalClient(Uri endpoint, string knowledgeBaseName, Azure.Core.TokenCredential tokenCredential);new Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient : Uri * string * Azure.Core.TokenCredential -> Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClientPublic Sub New (endpoint As Uri, knowledgeBaseName As String, tokenCredential As TokenCredential)Parameters
- endpoint
- Uri
Required. The URI endpoint of the Search service. This is likely to be similar to "https://{search_service}.search.windows.net". The URI must use HTTPS.
- knowledgeBaseName
- String
The name of the knowledge base.
- tokenCredential
- TokenCredential
Required. The token credential used to authenticate requests against the Search service. See Use role-based authorization in Azure Cognitive Search for more information about role-based authorization in Azure Cognitive Search.
Exceptions
Thrown when the endpoint or tokenCredential is null.
Thrown when the endpoint is not using HTTPS.
Applies to
KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential, SearchClientOptions)
Initializes a new instance of the KnowledgeBaseRetrievalClient class.
public KnowledgeBaseRetrievalClient(Uri endpoint, string knowledgeBaseName, Azure.AzureKeyCredential credential, Azure.Search.Documents.SearchClientOptions options);new Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient : Uri * string * Azure.AzureKeyCredential * Azure.Search.Documents.SearchClientOptions -> Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClientPublic Sub New (endpoint As Uri, knowledgeBaseName As String, credential As AzureKeyCredential, options As SearchClientOptions)Parameters
- endpoint
- Uri
Required. The URI endpoint of the Search service. This is likely to be similar to "https://{search_service}.search.windows.net". The URI must use HTTPS.
- knowledgeBaseName
- String
The name of the knowledge base.
- credential
- AzureKeyCredential
Required. The API key credential used to authenticate requests against the Search service. You need to use an admin key to perform any operations on the SearchIndexClient. See Create and manage api-keys for an Azure Cognitive Search service for more information about API keys in Azure Cognitive Search.
- options
- SearchClientOptions
Client configuration options for connecting to Azure Cognitive Search.
Exceptions
Thrown when the endpoint or credential is null.
Thrown when the endpoint is not using HTTPS.
Applies to
KnowledgeBaseRetrievalClient(Uri, String, TokenCredential, SearchClientOptions)
Initializes a new instance of the KnowledgeBaseRetrievalClient class.
public KnowledgeBaseRetrievalClient(Uri endpoint, string knowledgeBaseName, Azure.Core.TokenCredential tokenCredential, Azure.Search.Documents.SearchClientOptions options);new Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient : Uri * string * Azure.Core.TokenCredential * Azure.Search.Documents.SearchClientOptions -> Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClientPublic Sub New (endpoint As Uri, knowledgeBaseName As String, tokenCredential As TokenCredential, options As SearchClientOptions)Parameters
- endpoint
- Uri
Required. The URI endpoint of the Search service. This is likely to be similar to "https://{search_service}.search.windows.net". The URI must use HTTPS.
- knowledgeBaseName
- String
The name of the knowledge base.
- tokenCredential
- TokenCredential
Required. The token credential used to authenticate requests against the Search service. See Use role-based authorization in Azure Cognitive Search for more information about role-based authorization in Azure Cognitive Search.
- options
- SearchClientOptions
Client configuration options for connecting to Azure Cognitive Search.
Exceptions
Thrown when the endpoint or tokenCredential is null.
Thrown when the endpoint is not using HTTPS.
