ChatResponse.ContinuationToken Property
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.
Gets or sets the continuation token for getting result of the background chat response.
public:
property Microsoft::Extensions::AI::ResponseContinuationToken ^ ContinuationToken { Microsoft::Extensions::AI::ResponseContinuationToken ^ get(); void set(Microsoft::Extensions::AI::ResponseContinuationToken ^ value); };[System.Diagnostics.CodeAnalysis.Experimental("MEAI001")]
[System.Text.Json.Serialization.JsonIgnore]
public Microsoft.Extensions.AI.ResponseContinuationToken? ContinuationToken { get; set; }[System.Text.Json.Serialization.JsonIgnore]
public Microsoft.Extensions.AI.ResponseContinuationToken? ContinuationToken { get; set; }[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001")>]
[<System.Text.Json.Serialization.JsonIgnore>]
member this.ContinuationToken : Microsoft.Extensions.AI.ResponseContinuationToken with get, set[<System.Text.Json.Serialization.JsonIgnore>]
member this.ContinuationToken : Microsoft.Extensions.AI.ResponseContinuationToken with get, setPublic Property ContinuationToken As ResponseContinuationTokenProperty Value
- Attributes
Remarks
IChatClient implementations that support background responses will return a continuation token if background responses are allowed in AllowBackgroundResponses and the result of the response has not been obtained yet. If the response has completed and the result has been obtained, the token will be null.
This property should be used in conjunction with ContinuationToken to continue to poll for the completion of the response. Pass this token to ContinuationToken on subsequent calls to GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) to poll for completion.
