KnowledgeBaseRetrievalClient Constructors

Definition

Namespace:: Azure.Search.Documents.KnowledgeBases

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v12.0.0

Package:: Azure.Search.Documents v11.8.0-beta.1

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 KnowledgeBaseRetrievalClient for mocking.
KnowledgeBaseRetrievalClient(KnowledgeBaseRetrievalClientSettings)	Initializes a new instance of KnowledgeBaseRetrievalClient from a KnowledgeBaseRetrievalClientSettings.
KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential)	Initializes a new instance of KnowledgeBaseRetrievalClient.
KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential, SearchClientOptions)	Initializes a new instance of KnowledgeBaseRetrievalClient.
KnowledgeBaseRetrievalClient(Uri, String, TokenCredential)	Initializes a new instance of KnowledgeBaseRetrievalClient.
KnowledgeBaseRetrievalClient(Uri, String, TokenCredential, SearchClientOptions)	Initializes a new instance of KnowledgeBaseRetrievalClient.

KnowledgeBaseRetrievalClient()

Source:: KnowledgeBaseRetrievalClient.cs

Source:: KnowledgeBaseRetrievalClient.cs

Initializes a new instance of KnowledgeBaseRetrievalClient for mocking.

protected KnowledgeBaseRetrievalClient();

Protected Sub New ()

Applies to

KnowledgeBaseRetrievalClient(KnowledgeBaseRetrievalClientSettings)

Source:: KnowledgeBaseRetrievalClient.cs

Initializes a new instance of KnowledgeBaseRetrievalClient from a KnowledgeBaseRetrievalClientSettings.

public KnowledgeBaseRetrievalClient(Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClientSettings settings);

new Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient : Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClientSettings -> Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient

Public Sub New (settings As KnowledgeBaseRetrievalClientSettings)

Parameters

settings: KnowledgeBaseRetrievalClientSettings

The settings for KnowledgeBaseRetrievalClient.

Applies to

KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential)

Source:: KnowledgeBaseRetrievalClient.cs

Source:: KnowledgeBaseRetrievalClient.cs

Initializes a new instance of KnowledgeBaseRetrievalClient.

public KnowledgeBaseRetrievalClient(Uri endpoint, string knowledgeBaseName, Azure.AzureKeyCredential credential);

new Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient : Uri * string * Azure.AzureKeyCredential -> Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient

Public Sub New (endpoint As Uri, knowledgeBaseName As String, credential As AzureKeyCredential)

Parameters

endpoint: Uri

Service endpoint.

knowledgeBaseName: String

The name of the knowledge base.

credential: AzureKeyCredential

A credential used to authenticate to the service.

Exceptions

ArgumentNullException

endpoint, knowledgeBaseName or credential is null.

ArgumentException

knowledgeBaseName is an empty string, and was expected to be non-empty.

Applies to

KnowledgeBaseRetrievalClient(Uri, String, AzureKeyCredential, SearchClientOptions)

Source:: KnowledgeBaseRetrievalClient.cs

Source:: KnowledgeBaseRetrievalClient.cs

Initializes a new instance of KnowledgeBaseRetrievalClient.

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.KnowledgeBaseRetrievalClient

Public Sub New (endpoint As Uri, knowledgeBaseName As String, credential As AzureKeyCredential, options As SearchClientOptions)

Parameters

endpoint: Uri

Service endpoint.

knowledgeBaseName: String

The name of the knowledge base.

credential: AzureKeyCredential

A credential used to authenticate to the service.

options: SearchClientOptions

The options for configuring the client.

Exceptions

ArgumentNullException

endpoint, knowledgeBaseName or credential is null.

ArgumentException

knowledgeBaseName is an empty string, and was expected to be non-empty.

Applies to

KnowledgeBaseRetrievalClient(Uri, String, TokenCredential)

Source:: KnowledgeBaseRetrievalClient.cs

Source:: KnowledgeBaseRetrievalClient.cs

Initializes a new instance of KnowledgeBaseRetrievalClient.

public KnowledgeBaseRetrievalClient(Uri endpoint, string knowledgeBaseName, Azure.Core.TokenCredential credential);

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.KnowledgeBaseRetrievalClient

new Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient : Uri * string * Azure.Core.TokenCredential -> Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient

Public Sub New (endpoint As Uri, knowledgeBaseName As String, credential As TokenCredential)

Public Sub New (endpoint As Uri, knowledgeBaseName As String, tokenCredential As TokenCredential)

Parameters

endpoint: Uri

Service endpoint.

knowledgeBaseName: String

The name of the knowledge base.

credentialtokenCredential: TokenCredential

A credential used to authenticate to the service.

Exceptions

ArgumentNullException

endpoint, knowledgeBaseName or credential is null.

ArgumentException

knowledgeBaseName is an empty string, and was expected to be non-empty.

Applies to

KnowledgeBaseRetrievalClient(Uri, String, TokenCredential, SearchClientOptions)

Source:: KnowledgeBaseRetrievalClient.cs

Source:: KnowledgeBaseRetrievalClient.cs

Initializes a new instance of KnowledgeBaseRetrievalClient.

public KnowledgeBaseRetrievalClient(Uri endpoint, string knowledgeBaseName, Azure.Core.TokenCredential credential, Azure.Search.Documents.SearchClientOptions options);

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.KnowledgeBaseRetrievalClient

new Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient : Uri * string * Azure.Core.TokenCredential * Azure.Search.Documents.SearchClientOptions -> Azure.Search.Documents.KnowledgeBases.KnowledgeBaseRetrievalClient

Public Sub New (endpoint As Uri, knowledgeBaseName As String, credential As TokenCredential, options As SearchClientOptions)

Public Sub New (endpoint As Uri, knowledgeBaseName As String, tokenCredential As TokenCredential, options As SearchClientOptions)

Parameters

endpoint: Uri

Service endpoint.

knowledgeBaseName: String

The name of the knowledge base.

credentialtokenCredential: TokenCredential

A credential used to authenticate to the service.

options: SearchClientOptions

The options for configuring the client.

Exceptions

ArgumentNullException

endpoint, knowledgeBaseName or credential is null.

ArgumentException

knowledgeBaseName is an empty string, and was expected to be non-empty.

Applies to

Feedback

Was this page helpful?