ResponseEventStream.EmitIncomplete Method

Definition

Produces a response.incomplete event. Sets Status = Incomplete, CompletedAt, IncompleteDetails, and Usage (if provided) before creating the event.

public virtual Azure.AI.AgentServer.Responses.Models.ResponseIncompleteEvent EmitIncomplete(Azure.AI.AgentServer.Responses.Models.ResponseIncompleteDetailsReason? reason = default, Azure.AI.AgentServer.Responses.Models.ResponseUsage? usage = default);
abstract member EmitIncomplete : Nullable<Azure.AI.AgentServer.Responses.Models.ResponseIncompleteDetailsReason> * Azure.AI.AgentServer.Responses.Models.ResponseUsage -> Azure.AI.AgentServer.Responses.Models.ResponseIncompleteEvent
override this.EmitIncomplete : Nullable<Azure.AI.AgentServer.Responses.Models.ResponseIncompleteDetailsReason> * Azure.AI.AgentServer.Responses.Models.ResponseUsage -> Azure.AI.AgentServer.Responses.Models.ResponseIncompleteEvent
Public Overridable Function EmitIncomplete (Optional reason As Nullable(Of ResponseIncompleteDetailsReason) = Nothing, Optional usage As ResponseUsage = Nothing) As ResponseIncompleteEvent

Parameters

reason
Nullable<ResponseIncompleteDetailsReason>

Optional reason for incompleteness.

usage
ResponseUsage

Optional token usage data to include in the response.

Returns

A ResponseIncompleteEvent with the finalized response.

Applies to