SearchIndexClient.GetKnowledgeBase Method

Definition

Namespace:: Azure.Search.Documents.Indexes

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
GetKnowledgeBase(String, RequestContext)	[Protocol Method] Retrieves a knowledge base definition. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeBase(String, CancellationToken)	Retrieves a knowledge base definition.

Name

Description

GetKnowledgeBase(String, RequestContext)

[Protocol Method] Retrieves a knowledge base definition.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetKnowledgeBase(String, CancellationToken)

Retrieves a knowledge base definition.

GetKnowledgeBase(String, RequestContext)

Source:: SearchIndexClient.cs

[Protocol Method] Retrieves a knowledge base definition.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response GetKnowledgeBase(string knowledgeBaseName, Azure.RequestContext context);

abstract member GetKnowledgeBase : string * Azure.RequestContext -> Azure.Response
override this.GetKnowledgeBase : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetKnowledgeBase (knowledgeBaseName As String, context As RequestContext) As Response

Parameters

knowledgeBaseName: String

The name of the knowledge base.

context: RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

knowledgeBaseName is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Applies to

GetKnowledgeBase(String, CancellationToken)

Source:: SearchIndexClient.cs

Source:: SearchIndexClient.KnowledgeBases.cs

Retrieves a knowledge base definition.

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeBase> GetKnowledgeBase(string knowledgeBaseName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetKnowledgeBase : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeBase>
override this.GetKnowledgeBase : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeBase>

Public Overridable Function GetKnowledgeBase (knowledgeBaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of KnowledgeBase)