Skip to content
1 min read · 48 words

Type Alias: OpenAIResponsesStreamEvent ​

ts
type OpenAIResponsesStreamEvent =
  | OpenAIResponsesOutputItemAddedEvent
  | OpenAIResponsesOutputItemDoneEvent
  | OpenAIResponsesOutputTextDeltaEvent
  | OpenAIResponsesOutputTextDoneEvent
  | OpenAIResponsesRefusalDeltaEvent
  | OpenAIResponsesRefusalDoneEvent
  | OpenAIResponsesReasoningSummaryTextDeltaEvent
  | OpenAIResponsesReasoningSummaryTextDoneEvent
  | OpenAIResponsesReasoningTextDeltaEvent
  | OpenAIResponsesReasoningTextDoneEvent
  | OpenAIResponsesFunctionCallArgumentsDeltaEvent
  | OpenAIResponsesFunctionCallArgumentsDoneEvent
  | OpenAIResponsesCompletedEvent
  | OpenAIResponsesIncompleteEvent
  | OpenAIResponsesFailedEvent
  | OpenAIResponsesErrorEvent
  | (OpenAIResponsesStreamEventBase & Record<string, unknown>);

Defined in: src/batteries/llm/openai_responses/types.ts:511

Discriminated union of every streaming event this battery handles explicitly, plus a structural fallback ({type: string, ...}) for the many other event types the Responses API emits (response.created, response.in_progress, response.content_part.added/.done, hosted-tool progress events, etc.) that this battery does not act on.