StreamEvents - TypeScript SDK

1
const value: models.ErrorEvent = {
2
  code: null,
3
  message: "<value>",
4
  param: null,
5
  sequenceNumber: 0,
6
  type: "error",
7
};

1
const value: models.ApplyPatchCallOperationDiffDeltaEvent = {
2
  delta: "<value>",
3
  itemId: "<id>",
4
  outputIndex: 162755,
5
  sequenceNumber: 0,
6
  type: "response.apply_patch_call_operation_diff.delta",
7
};

1
const value: models.ApplyPatchCallOperationDiffDoneEvent = {
2
  diff: "<value>",
3
  itemId: "<id>",
4
  outputIndex: 786722,
5
  sequenceNumber: 0,
6
  type: "response.apply_patch_call_operation_diff.done",
7
};

1
const value: models.StreamEventsResponseCompleted = {
2
  response: {
3
    completedAt: 773930,
4
    createdAt: 1704067200,
5
    error: null,
6
    frequencyPenalty: null,
7
    id: "resp-abc123",
8
    incompleteDetails: null,
9
    instructions: null,
10
    metadata: null,
11
    model: "gpt-4",
12
    object: "response",
13
    output: [],
14
    parallelToolCalls: true,
15
    presencePenalty: 4244.7,
16
    status: "in_progress",
17
    temperature: null,
18
    toolChoice: "auto",
19
    tools: [],
20
    topP: null,
21
  },
22
  sequenceNumber: 0,
23
  type: "response.completed",
24
};

1
const value: models.ContentPartAddedEvent = {
2
  contentIndex: 899905,
3
  itemId: "<id>",
4
  outputIndex: 34601,
5
  part: {
6
    text: "The capital of France is Paris.",
7
    type: "output_text",
8
  },
9
  sequenceNumber: 0,
10
  type: "response.content_part.added",
11
};

1
const value: models.ContentPartDoneEvent = {
2
  contentIndex: 112041,
3
  itemId: "<id>",
4
  outputIndex: 546268,
5
  part: {
6
    text: "The capital of France is Paris.",
7
    type: "output_text",
8
  },
9
  sequenceNumber: 0,
10
  type: "response.content_part.done",
11
};

1
const value: models.OpenResponsesCreatedEvent = {
2
  response: {
3
    completedAt: null,
4
    createdAt: 1704067200,
5
    error: null,
6
    frequencyPenalty: 864.34,
7
    id: "resp-abc123",
8
    incompleteDetails: null,
9
    instructions: null,
10
    metadata: null,
11
    model: "gpt-4",
12
    object: "response",
13
    output: [],
14
    parallelToolCalls: true,
15
    presencePenalty: 9232.89,
16
    status: "in_progress",
17
    temperature: null,
18
    toolChoice: "auto",
19
    tools: [],
20
    topP: null,
21
  },
22
  sequenceNumber: 0,
23
  type: "response.created",
24
};

1
const value: models.CustomToolCallInputDeltaEvent = {
2
  delta: "<value>",
3
  itemId: "<id>",
4
  outputIndex: 98568,
5
  sequenceNumber: 0,
6
  type: "response.custom_tool_call_input.delta",
7
};

1
const value: models.CustomToolCallInputDoneEvent = {
2
  input: "<value>",
3
  itemId: "<id>",
4
  outputIndex: 963378,
5
  sequenceNumber: 0,
6
  type: "response.custom_tool_call_input.done",
7
};

1
const value: models.StreamEventsResponseFailed = {
2
  response: {
3
    completedAt: 845103,
4
    createdAt: 1704067200,
5
    error: null,
6
    frequencyPenalty: 4081.29,
7
    id: "resp-abc123",
8
    incompleteDetails: null,
9
    instructions: null,
10
    metadata: null,
11
    model: "gpt-4",
12
    object: "response",
13
    output: [],
14
    parallelToolCalls: true,
15
    presencePenalty: null,
16
    status: "in_progress",
17
    temperature: null,
18
    toolChoice: "auto",
19
    tools: [],
20
    topP: null,
21
  },
22
  sequenceNumber: 0,
23
  type: "response.failed",
24
};

1
const value: models.FunctionCallArgsDeltaEvent = {
2
  delta: "<value>",
3
  itemId: "<id>",
4
  outputIndex: 234869,
5
  sequenceNumber: 0,
6
  type: "response.function_call_arguments.delta",
7
};

1
const value: models.FunctionCallArgsDoneEvent = {
2
  arguments: "<value>",
3
  itemId: "<id>",
4
  name: "<value>",
5
  outputIndex: 603359,
6
  sequenceNumber: 0,
7
  type: "response.function_call_arguments.done",
8
};

1
const value: models.FusionCallAnalysisCompletedEvent = {
2
  analysis: {
3
    blindSpots: [
4
      "No model considered the impact on existing API consumers.",
5
    ],
6
    consensus: [
7
      "All panel models agree the request is asking for a concise summary.",
8
    ],
9
    contradictions: [
10
      {
11
        stances: [
12
          {
13
            model: "openai/gpt-5",
14
            stance: "Favors an incremental rollout.",
15
          },
16
          {
17
            model: "anthropic/claude-sonnet-4.5",
18
            stance: "Favors a single coordinated migration.",
19
          },
20
        ],
21
        topic: "Recommended approach",
22
      },
23
    ],
24
    partialCoverage: [
25
      {
26
        models: [
27
          "openai/gpt-5",
28
        ],
29
        point: "Only one model addressed the rollback strategy.",
30
      },
31
    ],
32
    uniqueInsights: [
33
      {
34
        insight:
35
          "Highlighted a backwards-compatibility risk the other models missed.",
36
        model: "anthropic/claude-sonnet-4.5",
37
      },
38
    ],
39
  },
40
  itemId: "<id>",
41
  outputIndex: 74526,
42
  sequenceNumber: 0,
43
  type: "response.fusion_call.analysis.completed",
44
};

1
const value: models.FusionCallAnalysisInProgressEvent = {
2
  itemId: "<id>",
3
  judgeModel: "<value>",
4
  outputIndex: 306599,
5
  sequenceNumber: 0,
6
  type: "response.fusion_call.analysis.in_progress",
7
};

1
const value: models.FusionCallCompletedEvent = {
2
  itemId: "<id>",
3
  outputIndex: 114921,
4
  sequenceNumber: 0,
5
  type: "response.fusion_call.completed",
6
};

1
const value: models.FusionCallInProgressEvent = {
2
  itemId: "<id>",
3
  outputIndex: 285302,
4
  sequenceNumber: 0,
5
  type: "response.fusion_call.in_progress",
6
};

1
const value: models.FusionCallPanelAddedEvent = {
2
  itemId: "<id>",
3
  model: "Cruze",
4
  outputIndex: 246848,
5
  sequenceNumber: 0,
6
  type: "response.fusion_call.panel.added",
7
};

1
const value: models.FusionCallPanelCompletedEvent = {
2
  content: "<value>",
3
  itemId: "<id>",
4
  model: "Mercielago",
5
  outputIndex: 546615,
6
  sequenceNumber: 0,
7
  type: "response.fusion_call.panel.completed",
8
};

1
const value: models.FusionCallPanelDeltaEvent = {
2
  delta: "<value>",
3
  itemId: "<id>",
4
  model: "Mustang",
5
  outputIndex: 213881,
6
  sequenceNumber: 0,
7
  type: "response.fusion_call.panel.delta",
8
};

1
const value: models.FusionCallPanelFailedEvent = {
2
  error: "<value>",
3
  itemId: "<id>",
4
  model: "Colorado",
5
  outputIndex: 389396,
6
  sequenceNumber: 0,
7
  type: "response.fusion_call.panel.failed",
8
};

1
const value: models.FusionCallPanelReasoningDeltaEvent = {
2
  delta: "<value>",
3
  itemId: "<id>",
4
  model: "Volt",
5
  outputIndex: 705984,
6
  sequenceNumber: 0,
7
  type: "response.fusion_call.panel.reasoning.delta",
8
};

1
const value: models.ImageGenCallCompletedEvent = {
2
  itemId: "<id>",
3
  outputIndex: 165850,
4
  sequenceNumber: 0,
5
  type: "response.image_generation_call.completed",
6
};

1
const value: models.ImageGenCallGeneratingEvent = {
2
  itemId: "<id>",
3
  outputIndex: 708731,
4
  sequenceNumber: 0,
5
  type: "response.image_generation_call.generating",
6
};

1
const value: models.ImageGenCallInProgressEvent = {
2
  itemId: "<id>",
3
  outputIndex: 788131,
4
  sequenceNumber: 0,
5
  type: "response.image_generation_call.in_progress",
6
};

1
const value: models.ImageGenCallPartialImageEvent = {
2
  itemId: "<id>",
3
  outputIndex: 173614,
4
  partialImageB64: "<value>",
5
  partialImageIndex: 192829,
6
  sequenceNumber: 0,
7
  type: "response.image_generation_call.partial_image",
8
};

1
const value: models.OpenResponsesInProgressEvent = {
2
  response: {
3
    completedAt: 434412,
4
    createdAt: 1704067200,
5
    error: null,
6
    frequencyPenalty: 945.33,
7
    id: "resp-abc123",
8
    incompleteDetails: null,
9
    instructions: null,
10
    metadata: null,
11
    model: "gpt-4",
12
    object: "response",
13
    output: [],
14
    parallelToolCalls: true,
15
    presencePenalty: 8737.38,
16
    status: "in_progress",
17
    temperature: null,
18
    toolChoice: "auto",
19
    tools: [],
20
    topP: null,
21
  },
22
  sequenceNumber: 0,
23
  type: "response.in_progress",
24
};

1
const value: models.StreamEventsResponseIncomplete = {
2
  response: {
3
    completedAt: 797200,
4
    createdAt: 1704067200,
5
    error: null,
6
    frequencyPenalty: 8861.33,
7
    id: "resp-abc123",
8
    incompleteDetails: null,
9
    instructions: null,
10
    metadata: null,
11
    model: "gpt-4",
12
    object: "response",
13
    output: [],
14
    parallelToolCalls: true,
15
    presencePenalty: 3923.12,
16
    status: "in_progress",
17
    temperature: null,
18
    toolChoice: "auto",
19
    tools: [],
20
    topP: null,
21
  },
22
  sequenceNumber: 0,
23
  type: "response.incomplete",
24
};

1
const value: models.StreamEventsResponseOutputItemAdded = {
2
  item: {
3
    content: [
4
      {
5
        text: "Hello! How can I help you today?",
6
        type: "output_text",
7
      },
8
    ],
9
    id: "msg-abc123",
10
    role: "assistant",
11
    type: "message",
12
  },
13
  outputIndex: 415042,
14
  sequenceNumber: 0,
15
  type: "response.output_item.added",
16
};

1
const value: models.StreamEventsResponseOutputItemDone = {
2
  item: {
3
    content: [
4
      {
5
        text: "Hello! How can I help you today?",
6
        type: "output_text",
7
      },
8
    ],
9
    id: "msg-abc123",
10
    role: "assistant",
11
    type: "message",
12
  },
13
  outputIndex: 209831,
14
  sequenceNumber: 0,
15
  type: "response.output_item.done",
16
};

1
const value: models.AnnotationAddedEvent = {
2
  annotation: {
3
    fileId: "file-abc123",
4
    filename: "research_paper.pdf",
5
    index: 0,
6
    type: "file_citation",
7
  },
8
  annotationIndex: 104354,
9
  contentIndex: 252914,
10
  itemId: "<id>",
11
  outputIndex: 214233,
12
  sequenceNumber: 0,
13
  type: "response.output_text.annotation.added",
14
};

1
const value: models.TextDeltaEvent = {
2
  contentIndex: 699825,
3
  delta: "<value>",
4
  itemId: "<id>",
5
  logprobs: [
6
    {
7
      logprob: -0.5,
8
      token: "Hello",
9
    },
10
  ],
11
  outputIndex: 810486,
12
  sequenceNumber: 0,
13
  type: "response.output_text.delta",
14
};

1
const value: models.TextDoneEvent = {
2
  contentIndex: 482041,
3
  itemId: "<id>",
4
  logprobs: [
5
    {
6
      logprob: -0.5,
7
      token: "Hello",
8
    },
9
  ],
10
  outputIndex: 634062,
11
  sequenceNumber: 0,
12
  text: "<value>",
13
  type: "response.output_text.done",
14
};

1
const value: models.ReasoningSummaryPartAddedEvent = {
2
  itemId: "<id>",
3
  outputIndex: 543957,
4
  part: {
5
    text: "Analyzed the problem using first principles",
6
    type: "summary_text",
7
  },
8
  sequenceNumber: 0,
9
  summaryIndex: 279769,
10
  type: "response.reasoning_summary_part.added",
11
};

1
const value: models.ReasoningSummaryPartDoneEvent = {
2
  itemId: "<id>",
3
  outputIndex: 831078,
4
  part: {
5
    text: "Analyzed the problem using first principles",
6
    type: "summary_text",
7
  },
8
  sequenceNumber: 0,
9
  summaryIndex: 817850,
10
  type: "response.reasoning_summary_part.done",
11
};

1
const value: models.ReasoningSummaryTextDeltaEvent = {
2
  delta: "<value>",
3
  itemId: "<id>",
4
  outputIndex: 466359,
5
  sequenceNumber: 0,
6
  summaryIndex: 520709,
7
  type: "response.reasoning_summary_text.delta",
8
};

1
const value: models.ReasoningSummaryTextDoneEvent = {
2
  itemId: "<id>",
3
  outputIndex: 687012,
4
  sequenceNumber: 0,
5
  summaryIndex: 897970,
6
  text: "<value>",
7
  type: "response.reasoning_summary_text.done",
8
};

1
const value: models.ReasoningDeltaEvent = {
2
  contentIndex: 55721,
3
  delta: "<value>",
4
  itemId: "<id>",
5
  outputIndex: 143619,
6
  sequenceNumber: 0,
7
  type: "response.reasoning_text.delta",
8
};

1
const value: models.ReasoningDoneEvent = {
2
  contentIndex: 469495,
3
  itemId: "<id>",
4
  outputIndex: 408441,
5
  sequenceNumber: 0,
6
  text: "<value>",
7
  type: "response.reasoning_text.done",
8
};

1
const value: models.RefusalDeltaEvent = {
2
  contentIndex: 185954,
3
  delta: "<value>",
4
  itemId: "<id>",
5
  outputIndex: 725096,
6
  sequenceNumber: 0,
7
  type: "response.refusal.delta",
8
};

1
const value: models.RefusalDoneEvent = {
2
  contentIndex: 672921,
3
  itemId: "<id>",
4
  outputIndex: 193829,
5
  refusal: "<value>",
6
  sequenceNumber: 0,
7
  type: "response.refusal.done",
8
};

1
const value: models.WebSearchCallCompletedEvent = {
2
  itemId: "<id>",
3
  outputIndex: 226042,
4
  sequenceNumber: 0,
5
  type: "response.web_search_call.completed",
6
};

1
const value: models.WebSearchCallInProgressEvent = {
2
  itemId: "<id>",
3
  outputIndex: 153527,
4
  sequenceNumber: 0,
5
  type: "response.web_search_call.in_progress",
6
};

1
const value: models.WebSearchCallSearchingEvent = {
2
  itemId: "<id>",
3
  outputIndex: 702452,
4
  sequenceNumber: 0,
5
  type: "response.web_search_call.searching",
6
};