Table of Contents

Class ResponseStreamEvent

Base class for all response stream events.

public abstract class ResponseStreamEvent : IStreamEvent
Inheritance
object
ResponseStreamEvent
Derived

Fields

Error

public const string Error = "error"

Field Value

string

ExternalConnectorError

public const string ExternalConnectorError = "external_connector_error"

Field Value

string

ResponseCodeInterpreterCallCodeDelta

public const string ResponseCodeInterpreterCallCodeDelta = "response.code_interpreter_call_code.delta"

Field Value

string

ResponseCodeInterpreterCallCodeDone

public const string ResponseCodeInterpreterCallCodeDone = "response.code_interpreter_call_code.done"

Field Value

string

ResponseCodeInterpreterCallCompleted

public const string ResponseCodeInterpreterCallCompleted = "response.code_interpreter_call.completed"

Field Value

string

ResponseCodeInterpreterCallInProgress

public const string ResponseCodeInterpreterCallInProgress = "response.code_interpreter_call.in_progress"

Field Value

string

ResponseCodeInterpreterCallInterpreting

public const string ResponseCodeInterpreterCallInterpreting = "response.code_interpreter_call.interpreting"

Field Value

string

ResponseCompleted

public const string ResponseCompleted = "response.completed"

Field Value

string

ResponseContentPartAdded

public const string ResponseContentPartAdded = "response.content_part.added"

Field Value

string

ResponseContentPartDone

public const string ResponseContentPartDone = "response.content_part.done"

Field Value

string

ResponseCreated

public const string ResponseCreated = "response.created"

Field Value

string

ResponseCustomToolCallInputDelta

public const string ResponseCustomToolCallInputDelta = "response.custom_tool_call_input.delta"

Field Value

string

ResponseCustomToolCallInputDone

public const string ResponseCustomToolCallInputDone = "response.custom_tool_call_input.done"

Field Value

string

ResponseFailed

public const string ResponseFailed = "response.failed"

Field Value

string

ResponseFileSearchCallCompleted

public const string ResponseFileSearchCallCompleted = "response.file_search_call.completed"

Field Value

string

ResponseFileSearchCallInProgress

public const string ResponseFileSearchCallInProgress = "response.file_search_call.in_progress"

Field Value

string

ResponseFileSearchCallSearching

public const string ResponseFileSearchCallSearching = "response.file_search_call.searching"

Field Value

string

ResponseFunctionCallArgumentsDelta

public const string ResponseFunctionCallArgumentsDelta = "response.function_call_arguments.delta"

Field Value

string

ResponseFunctionCallArgumentsDone

public const string ResponseFunctionCallArgumentsDone = "response.function_call_arguments.done"

Field Value

string

ResponseImageGenerationCallCompleted

public const string ResponseImageGenerationCallCompleted = "response.image_generation_call.completed"

Field Value

string

ResponseImageGenerationCallGenerating

public const string ResponseImageGenerationCallGenerating = "response.image_generation_call.generating"

Field Value

string

ResponseImageGenerationCallInProgress

public const string ResponseImageGenerationCallInProgress = "response.image_generation_call.in_progress"

Field Value

string

ResponseImageGenerationCallPartialImage

public const string ResponseImageGenerationCallPartialImage = "response.image_generation_call.partial_image"

Field Value

string

ResponseInProgress

public const string ResponseInProgress = "response.in_progress"

Field Value

string

ResponseIncomplete

public const string ResponseIncomplete = "response.incomplete"

Field Value

string

ResponseMcpCallArgumentsDelta

public const string ResponseMcpCallArgumentsDelta = "response.mcp_call_arguments.delta"

Field Value

string

ResponseMcpCallArgumentsDone

public const string ResponseMcpCallArgumentsDone = "response.mcp_call_arguments.done"

Field Value

string

ResponseMcpCallCompleted

public const string ResponseMcpCallCompleted = "response.mcp_call.completed"

Field Value

string

ResponseMcpCallFailed

public const string ResponseMcpCallFailed = "response.mcp_call.failed"

Field Value

string

ResponseMcpCallInProgress

public const string ResponseMcpCallInProgress = "response.mcp_call.in_progress"

Field Value

string

ResponseMcpListToolsCompleted

public const string ResponseMcpListToolsCompleted = "response.mcp_list_tools.completed"

Field Value

string

ResponseMcpListToolsFailed

public const string ResponseMcpListToolsFailed = "response.mcp_list_tools.failed"

Field Value

string

ResponseMcpListToolsInProgress

public const string ResponseMcpListToolsInProgress = "response.mcp_list_tools.in_progress"

Field Value

string

ResponseOutputItemAdded

public const string ResponseOutputItemAdded = "response.output_item.added"

Field Value

string

ResponseOutputItemDone

public const string ResponseOutputItemDone = "response.output_item.done"

Field Value

string

ResponseOutputTextAnnotationAdded

public const string ResponseOutputTextAnnotationAdded = "response.output_text.annotation.added"

Field Value

string

ResponseOutputTextDelta

public const string ResponseOutputTextDelta = "response.output_text.delta"

Field Value

string

ResponseOutputTextDone

public const string ResponseOutputTextDone = "response.output_text.done"

Field Value

string

ResponseQueued

public const string ResponseQueued = "response.queued"

Field Value

string

ResponseReasoningSummaryPartAdded

public const string ResponseReasoningSummaryPartAdded = "response.reasoning_summary_part.added"

Field Value

string

ResponseReasoningSummaryPartDone

public const string ResponseReasoningSummaryPartDone = "response.reasoning_summary_part.done"

Field Value

string

ResponseReasoningSummaryTextDelta

public const string ResponseReasoningSummaryTextDelta = "response.reasoning_summary_text.delta"

Field Value

string

ResponseReasoningSummaryTextDone

public const string ResponseReasoningSummaryTextDone = "response.reasoning_summary_text.done"

Field Value

string

ResponseReasoningTextDelta

public const string ResponseReasoningTextDelta = "response.reasoning_text.delta"

Field Value

string

ResponseReasoningTextDone

public const string ResponseReasoningTextDone = "response.reasoning_text.done"

Field Value

string

ResponseRefusalDelta

public const string ResponseRefusalDelta = "response.refusal.delta"

Field Value

string

ResponseRefusalDone

public const string ResponseRefusalDone = "response.refusal.done"

Field Value

string

ResponseWebSearchCallCompleted

public const string ResponseWebSearchCallCompleted = "response.web_search_call.completed"

Field Value

string

ResponseWebSearchCallInProgress

public const string ResponseWebSearchCallInProgress = "response.web_search_call.in_progress"

Field Value

string

ResponseWebSearchCallSearching

public const string ResponseWebSearchCallSearching = "response.web_search_call.searching"

Field Value

string

Properties

EventType

The type of the event.

public string EventType { get; set; }

Property Value

string

SequenceNumber

The sequence number for this event.

public int SequenceNumber { get; set; }

Property Value

int

Methods

IsFinal()

public bool IsFinal()

Returns

bool