IChatClient.CompleteAsync 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.
Sends chat messages to the model and returns the response messages.
public System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatCompletion> CompleteAsync (System.Collections.Generic.IList<Microsoft.Extensions.AI.ChatMessage> chatMessages, Microsoft.Extensions.AI.ChatOptions? options = default, System.Threading.CancellationToken cancellationToken = default);abstract member CompleteAsync : System.Collections.Generic.IList<Microsoft.Extensions.AI.ChatMessage> * Microsoft.Extensions.AI.ChatOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatCompletion>Public Function CompleteAsync (chatMessages As IList(Of ChatMessage), Optional options As ChatOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatCompletion)Parameters
- chatMessages
- IList<ChatMessage>
The chat content to send.
- options
- ChatOptions
The chat options to configure the request.
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests. The default is None.
Returns
The response messages generated by the client.
Remarks
The returned messages will not have been added to chatMessages. However, any intermediate messages generated implicitly by the client, including any messages for roundtrips to the model as part of the implementation of this request, will be included.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
