SearchIndexClient.GetKnowledgeBaseAsync Method
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 |
|---|---|
| GetKnowledgeBaseAsync(String, RequestContext) |
[Protocol Method] Retrieves a knowledge base definition.
|
| GetKnowledgeBaseAsync(String, CancellationToken) |
Retrieves a knowledge base definition. |
GetKnowledgeBaseAsync(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 System.Threading.Tasks.Task<Azure.Response> GetKnowledgeBaseAsync(string knowledgeBaseName, Azure.RequestContext context);abstract member GetKnowledgeBaseAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetKnowledgeBaseAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetKnowledgeBaseAsync (knowledgeBaseName As String, context As RequestContext) As Task(Of 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
The response returned from the service.
Exceptions
knowledgeBaseName is null.
knowledgeBaseName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetKnowledgeBaseAsync(String, CancellationToken)
- Source:
- SearchIndexClient.cs
Retrieves a knowledge base definition.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeBase>> GetKnowledgeBaseAsync(string knowledgeBaseName, System.Threading.CancellationToken cancellationToken = default);abstract member GetKnowledgeBaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeBase>>
override this.GetKnowledgeBaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeBase>>Public Overridable Function GetKnowledgeBaseAsync (knowledgeBaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KnowledgeBase))Parameters
- knowledgeBaseName
- String
The name of the knowledge base.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
knowledgeBaseName is null.
knowledgeBaseName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
