KnowledgeBases.SearchAsync 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 |
|---|---|
| SearchAsync(WaitUntil, String, SearchRequest, CancellationToken) |
Search the knowledge base. |
| SearchAsync(WaitUntil, String, RequestContent, RequestContext) |
Search the knowledge base. |
SearchAsync(WaitUntil, String, SearchRequest, CancellationToken)
- Source:
- KnowledgeBases.cs
Search the knowledge base.
public virtual System.Threading.Tasks.Task<Azure.Operation> SearchAsync(Azure.WaitUntil waitUntil, string knowledgeBaseName, Azure.AI.Discovery.SearchRequest body, System.Threading.CancellationToken cancellationToken = default);abstract member SearchAsync : Azure.WaitUntil * string * Azure.AI.Discovery.SearchRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>
override this.SearchAsync : Azure.WaitUntil * string * Azure.AI.Discovery.SearchRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>Public Overridable Function SearchAsync (waitUntil As WaitUntil, knowledgeBaseName As String, body As SearchRequest, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation)Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- knowledgeBaseName
- String
The knowledgeBase name.
- body
- SearchRequest
The search request body.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
knowledgeBaseName or body is null.
knowledgeBaseName is an empty string, and was expected to be non-empty.
Applies to
SearchAsync(WaitUntil, String, RequestContent, RequestContext)
- Source:
- KnowledgeBases.cs
Search the knowledge base.
public virtual System.Threading.Tasks.Task<Azure.Operation> SearchAsync(Azure.WaitUntil waitUntil, string knowledgeBaseName, Azure.Core.RequestContent content, Azure.RequestContext context = default);abstract member SearchAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.SearchAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>Public Overridable Function SearchAsync (waitUntil As WaitUntil, knowledgeBaseName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation)Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- knowledgeBaseName
- String
The knowledgeBase name.
- content
- RequestContent
The content to send as the body of the request.
- 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 or content is null.
knowledgeBaseName is an empty string, and was expected to be non-empty.
