openai 0.81.0 → 0.82.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +53 -1
  4. data/lib/openai/helpers/sorbet.rb +324 -0
  5. data/lib/openai/helpers/streaming/response_event_decoder.rb +44 -0
  6. data/lib/openai/helpers/streaming/response_stream.rb +10 -3
  7. data/lib/openai/helpers/streaming/unknown_stream_event.rb +51 -0
  8. data/lib/openai/internal/stream.rb +4 -1
  9. data/lib/openai/models/beta/beta_response_function_tool_call_output_item.rb +9 -9
  10. data/lib/openai/models/beta/beta_response_input_item.rb +9 -9
  11. data/lib/openai/models/responses/response_function_tool_call_output_item.rb +9 -9
  12. data/lib/openai/models/responses/response_input_item.rb +9 -9
  13. data/lib/openai/resources/beta/responses.rb +2 -2
  14. data/lib/openai/resources/responses.rb +3 -3
  15. data/lib/openai/version.rb +1 -1
  16. data/rbi/openai/helpers/sorbet.rbi +55 -0
  17. data/rbi/openai/helpers/streaming/response_event_decoder.rbi +28 -0
  18. data/rbi/openai/helpers/streaming/response_stream.rbi +5 -0
  19. data/rbi/openai/helpers/streaming/unknown_stream_event.rbi +29 -0
  20. data/rbi/openai/models/beta/beta_response_function_tool_call_output_item.rbi +13 -10
  21. data/rbi/openai/models/beta/beta_response_input_item.rbi +10 -10
  22. data/rbi/openai/models/responses/response_function_tool_call_output_item.rbi +13 -10
  23. data/rbi/openai/models/responses/response_input_item.rbi +10 -10
  24. data/rbi/openai/resources/beta/responses.rbi +10 -2
  25. data/rbi/openai/resources/responses.rbi +2 -2
  26. data/rbi/openai/streaming.rbi +1 -0
  27. data/sig/openai/helpers/sorbet.rbs +54 -0
  28. data/sig/openai/helpers/streaming/response_event_decoder.rbs +16 -0
  29. data/sig/openai/helpers/streaming/unknown_stream_event.rbs +15 -0
  30. data/sig/openai/models/beta/beta_response_function_tool_call_output_item.rbs +7 -5
  31. data/sig/openai/models/beta/beta_response_input_item.rbs +5 -5
  32. data/sig/openai/models/responses/response_function_tool_call_output_item.rbs +7 -5
  33. data/sig/openai/models/responses/response_input_item.rbs +5 -5
  34. data/sig/openai/resources/beta/responses.rbs +4 -2
  35. data/sig/openai/resources/responses.rbs +6 -3
  36. data/sig/openai/streaming.rbs +5 -0
  37. metadata +11 -1
@@ -10,12 +10,6 @@ module OpenAI
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
- # @!attribute call_id
14
- # The unique ID of the function tool call generated by the model.
15
- #
16
- # @return [String]
17
- required :call_id, String
18
-
19
13
  # @!attribute output
20
14
  # The output from the function call generated by your code. Can be a string or an
21
15
  # list of output content.
@@ -36,6 +30,12 @@ module OpenAI
36
30
  # @return [Symbol, :function_call_output]
37
31
  required :type, const: :function_call_output
38
32
 
33
+ # @!attribute call_id
34
+ # The unique ID of the function tool call generated by the model.
35
+ #
36
+ # @return [String, nil]
37
+ optional :call_id, String
38
+
39
39
  # @!attribute caller_
40
40
  # The execution context that produced this tool call.
41
41
  #
@@ -65,19 +65,19 @@ module OpenAI
65
65
  # @return [String, nil]
66
66
  optional :namespace, String
67
67
 
68
- # @!method initialize(id:, call_id:, output:, status:, caller_: nil, created_by: nil, name: nil, namespace: nil, type: :function_call_output)
68
+ # @!method initialize(id:, output:, status:, call_id: nil, caller_: nil, created_by: nil, name: nil, namespace: nil, type: :function_call_output)
69
69
  # Some parameter documentations has been truncated, see
70
70
  # {OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem} for more
71
71
  # details.
72
72
  #
73
73
  # @param id [String] The unique ID of the function call tool output.
74
74
  #
75
- # @param call_id [String] The unique ID of the function tool call generated by the model.
76
- #
77
75
  # @param output [String, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>] The output from the function call generated by your code.
78
76
  #
79
77
  # @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Status] The status of the item. One of `in_progress`, `completed`, or
80
78
  #
79
+ # @param call_id [String] The unique ID of the function tool call generated by the model.
80
+ #
81
81
  # @param caller_ [OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Program, nil] The execution context that produced this tool call.
82
82
  #
83
83
  # @param created_by [String] The identifier of the actor that created the item.
@@ -318,12 +318,6 @@ module OpenAI
318
318
  end
319
319
 
320
320
  class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
321
- # @!attribute call_id
322
- # The unique ID of the function tool call generated by the model.
323
- #
324
- # @return [String]
325
- required :call_id, String
326
-
327
321
  # @!attribute output
328
322
  # Text, image, or file output of the function tool call.
329
323
  #
@@ -343,6 +337,12 @@ module OpenAI
343
337
  # @return [String, nil]
344
338
  optional :id, String, nil?: true
345
339
 
340
+ # @!attribute call_id
341
+ # The unique ID of the function tool call generated by the model.
342
+ #
343
+ # @return [String, nil]
344
+ optional :call_id, String, nil?: true
345
+
346
346
  # @!attribute caller_
347
347
  # The execution context that produced this tool call.
348
348
  #
@@ -377,19 +377,19 @@ module OpenAI
377
377
  nil?: true
378
378
  )
379
379
 
380
- # @!method initialize(call_id:, output:, id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
380
+ # @!method initialize(output:, id: nil, call_id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
381
381
  # Some parameter documentations has been truncated, see
382
382
  # {OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput} for more
383
383
  # details.
384
384
  #
385
385
  # The output of a function tool call.
386
386
  #
387
- # @param call_id [String] The unique ID of the function tool call generated by the model.
388
- #
389
387
  # @param output [String, Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>] Text, image, or file output of the function tool call.
390
388
  #
391
389
  # @param id [String, nil] The unique ID of the function tool call output. Populated when this item is retu
392
390
  #
391
+ # @param call_id [String, nil] The unique ID of the function tool call generated by the model.
392
+ #
393
393
  # @param caller_ [OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Caller::Program, nil] The execution context that produced this tool call.
394
394
  #
395
395
  # @param name [String, nil] The name of the tool that produced the output.
@@ -202,7 +202,7 @@ module OpenAI
202
202
  #
203
203
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
204
204
  #
205
- # @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent>]
205
+ # @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
206
206
  #
207
207
  # @see OpenAI::Models::Beta::ResponseCreateParams
208
208
  def stream_raw(params = {})
@@ -298,7 +298,7 @@ module OpenAI
298
298
  #
299
299
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
300
300
  #
301
- # @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent>]
301
+ # @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
302
302
  #
303
303
  # @see OpenAI::Models::Beta::ResponseRetrieveParams
304
304
  def retrieve_streaming(response_id, params = {})
@@ -198,7 +198,7 @@ module OpenAI
198
198
  #
199
199
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
200
200
  #
201
- # @return [OpenAI::Internal::Stream<OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent>]
201
+ # @return [OpenAI::Internal::Stream<OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
202
202
  #
203
203
  # @see OpenAI::Models::Responses::ResponseCreateParams
204
204
  def stream(params)
@@ -325,7 +325,7 @@ module OpenAI
325
325
  #
326
326
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
327
327
  #
328
- # @return [OpenAI::Internal::Stream<OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseShellCallCommandAddedEvent, OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent, OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent>]
328
+ # @return [OpenAI::Internal::Stream<OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseShellCallCommandAddedEvent, OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent, OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
329
329
  #
330
330
  # @see OpenAI::Models::Responses::ResponseCreateParams
331
331
  def stream_raw(params = {})
@@ -407,7 +407,7 @@ module OpenAI
407
407
  #
408
408
  # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
409
409
  #
410
- # @return [OpenAI::Internal::Stream<OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseShellCallCommandAddedEvent, OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent, OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent>]
410
+ # @return [OpenAI::Internal::Stream<OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseShellCallCommandAddedEvent, OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent, OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseReasoningTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
411
411
  #
412
412
  # @see OpenAI::Models::Responses::ResponseRetrieveParams
413
413
  def retrieve_streaming(response_id, params = {})
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module OpenAI
4
- VERSION = "0.81.0"
4
+ VERSION = "0.82.0"
5
5
  end
@@ -0,0 +1,55 @@
1
+ # typed: strong
2
+
3
+ module OpenAI
4
+ module Helpers
5
+ module StructuredOutput
6
+ class SorbetAdapter
7
+ include OpenAI::Internal::Type::Converter
8
+ include OpenAI::Helpers::StructuredOutput::JsonSchemaConverter
9
+
10
+ class HydrationError < TypeError
11
+ end
12
+
13
+ sig { params(model: T.class_of(T::Struct)).void }
14
+ def initialize(model)
15
+ end
16
+
17
+ sig { returns(String) }
18
+ attr_reader :name
19
+
20
+ sig { returns(OpenAI::Helpers::StructuredOutput::JsonSchema) }
21
+ def to_json_schema
22
+ end
23
+
24
+ # @api private
25
+ sig do
26
+ params(
27
+ state: OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::State
28
+ )
29
+ .returns(OpenAI::Helpers::StructuredOutput::JsonSchema)
30
+ end
31
+ def to_json_schema_inner(state:)
32
+ end
33
+
34
+ # @api private
35
+ sig do
36
+ override
37
+ .params(
38
+ value: T.anything,
39
+ state: OpenAI::Internal::Type::Converter::CoerceState
40
+ )
41
+ .returns(T.anything)
42
+ end
43
+ def coerce(value, state:)
44
+ end
45
+ end
46
+
47
+ sig do
48
+ params(model: T.class_of(T::Struct))
49
+ .returns(OpenAI::Helpers::StructuredOutput::SorbetAdapter)
50
+ end
51
+ def self.from_sorbet(model)
52
+ end
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,28 @@
1
+ # typed: strong
2
+
3
+ module OpenAI
4
+ module Helpers
5
+ module Streaming
6
+ # @api private
7
+ class ResponseEventDecoder
8
+ sig { params(model: T.untyped).void }
9
+ def initialize(model:)
10
+ end
11
+
12
+ sig { params(data: T.untyped).returns(T.untyped) }
13
+ def decode(data)
14
+ end
15
+
16
+ private
17
+
18
+ sig { returns(T::Boolean) }
19
+ def response_stream_model?
20
+ end
21
+
22
+ sig { params(data: T.untyped).returns(T::Boolean) }
23
+ def unknown_response_event?(data)
24
+ end
25
+ end
26
+ end
27
+ end
28
+ end
@@ -13,6 +13,7 @@ module OpenAI
13
13
  OpenAI::Streaming::ResponseTextDoneEvent,
14
14
  OpenAI::Streaming::ResponseCompletedEvent,
15
15
  OpenAI::Streaming::ResponseFunctionCallArgumentsDeltaEvent,
16
+ OpenAI::Streaming::UnknownStreamEvent,
16
17
  # Pass through other raw events
17
18
  OpenAI::Models::Responses::ResponseStreamEvent::Variants
18
19
  )
@@ -67,6 +68,10 @@ module OpenAI
67
68
  sig { returns(T.untyped) }
68
69
  def iterator
69
70
  end
71
+
72
+ sig { params(event: ResponseStreamEvent).returns(T::Boolean) }
73
+ def after_starting_event?(event)
74
+ end
70
75
  end
71
76
 
72
77
  class ResponseStreamState
@@ -0,0 +1,29 @@
1
+ # typed: strong
2
+
3
+ module OpenAI
4
+ module Helpers
5
+ module Streaming
6
+ class UnknownStreamEvent
7
+ sig { returns(Symbol) }
8
+ attr_reader :type
9
+
10
+ sig { returns(T.nilable(Integer)) }
11
+ attr_reader :sequence_number
12
+
13
+ sig { returns(T::Hash[Symbol, T.untyped]) }
14
+ attr_reader :data
15
+
16
+ # @api private
17
+ sig do
18
+ params(data: T::Hash[Symbol, T.untyped]).returns(T.attached_class)
19
+ end
20
+ def self.new(data:)
21
+ end
22
+
23
+ sig { returns(T::Hash[Symbol, T.untyped]) }
24
+ def to_h
25
+ end
26
+ end
27
+ end
28
+ end
29
+ end
@@ -20,10 +20,6 @@ module OpenAI
20
20
  sig { returns(String) }
21
21
  attr_accessor :id
22
22
 
23
- # The unique ID of the function tool call generated by the model.
24
- sig { returns(String) }
25
- attr_accessor :call_id
26
-
27
23
  # The output from the function call generated by your code. Can be a string or an
28
24
  # list of output content.
29
25
  sig { returns(OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Output::Variants) }
@@ -45,6 +41,13 @@ module OpenAI
45
41
  sig { params(agent: T.nilable(OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Agent::OrHash)).void }
46
42
  attr_writer :agent
47
43
 
44
+ # The unique ID of the function tool call generated by the model.
45
+ sig { returns(T.nilable(String)) }
46
+ attr_reader :call_id
47
+
48
+ sig { params(call_id: String).void }
49
+ attr_writer :call_id
50
+
48
51
  # The execution context that produced this tool call.
49
52
  sig { returns(T.nilable(OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Caller::Variants)) }
50
53
  attr_accessor :caller_
@@ -75,14 +78,14 @@ module OpenAI
75
78
 
76
79
  id: String,
77
80
 
78
- call_id: String,
79
-
80
81
  output: OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Output::Variants,
81
82
 
82
83
  status: OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Status::OrSymbol,
83
84
 
84
85
  agent: T.nilable(OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Agent::OrHash),
85
86
 
87
+ call_id: String,
88
+
86
89
  caller_: T.nilable(
87
90
  T.any(
88
91
  OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Caller::Direct::OrHash,
@@ -105,9 +108,6 @@ module OpenAI
105
108
  # The unique ID of the function call tool output.
106
109
  id:,
107
110
 
108
- # The unique ID of the function tool call generated by the model.
109
- call_id:,
110
-
111
111
  # The output from the function call generated by your code. Can be a string or an
112
112
  # list of output content.
113
113
  output:,
@@ -119,6 +119,9 @@ module OpenAI
119
119
  # The agent that produced this item.
120
120
  agent: nil,
121
121
 
122
+ # The unique ID of the function tool call generated by the model.
123
+ call_id: nil,
124
+
122
125
  # The execution context that produced this tool call.
123
126
  caller_: nil,
124
127
 
@@ -141,11 +144,11 @@ module OpenAI
141
144
  override.returns(
142
145
  {
143
146
  id: String,
144
- call_id: String,
145
147
  output: OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Output::Variants,
146
148
  status: OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Status::TaggedSymbol,
147
149
  type: Symbol,
148
150
  agent: T.nilable(OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Agent),
151
+ call_id: String,
149
152
  caller_: T.nilable(OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Caller::Variants),
150
153
  created_by: String,
151
154
  name: String,
@@ -502,10 +502,6 @@ module OpenAI
502
502
  )
503
503
  end
504
504
 
505
- # The unique ID of the function tool call generated by the model.
506
- sig { returns(String) }
507
- attr_accessor :call_id
508
-
509
505
  # Text, image, or file output of the function tool call.
510
506
  sig { returns(OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Output::Variants) }
511
507
  attr_accessor :output
@@ -526,6 +522,10 @@ module OpenAI
526
522
  sig { params(agent: T.nilable(OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Agent::OrHash)).void }
527
523
  attr_writer :agent
528
524
 
525
+ # The unique ID of the function tool call generated by the model.
526
+ sig { returns(T.nilable(String)) }
527
+ attr_accessor :call_id
528
+
529
529
  # The execution context that produced this tool call.
530
530
  sig {
531
531
  returns(
@@ -556,14 +556,14 @@ module OpenAI
556
556
  sig do
557
557
  params(
558
558
 
559
- call_id: String,
560
-
561
559
  output: OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Output::Variants,
562
560
 
563
561
  id: T.nilable(String),
564
562
 
565
563
  agent: T.nilable(OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Agent::OrHash),
566
564
 
565
+ call_id: T.nilable(String),
566
+
567
567
  caller_: T.nilable(
568
568
  T.any(
569
569
  OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Direct::OrHash,
@@ -583,9 +583,6 @@ module OpenAI
583
583
  end
584
584
  def self.new(
585
585
 
586
- # The unique ID of the function tool call generated by the model.
587
- call_id:,
588
-
589
586
  # Text, image, or file output of the function tool call.
590
587
  output:,
591
588
 
@@ -596,6 +593,9 @@ module OpenAI
596
593
  # The agent that produced this item.
597
594
  agent: nil,
598
595
 
596
+ # The unique ID of the function tool call generated by the model.
597
+ call_id: nil,
598
+
599
599
  # The execution context that produced this tool call.
600
600
  caller_: nil,
601
601
 
@@ -618,11 +618,11 @@ module OpenAI
618
618
  sig do
619
619
  override.returns(
620
620
  {
621
- call_id: String,
622
621
  output: OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Output::Variants,
623
622
  type: Symbol,
624
623
  id: T.nilable(String),
625
624
  agent: T.nilable(OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Agent),
625
+ call_id: T.nilable(String),
626
626
  caller_: T.nilable(
627
627
  T.any(
628
628
  OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Direct,
@@ -18,10 +18,6 @@ module OpenAI
18
18
  sig { returns(String) }
19
19
  attr_accessor :id
20
20
 
21
- # The unique ID of the function tool call generated by the model.
22
- sig { returns(String) }
23
- attr_accessor :call_id
24
-
25
21
  # The output from the function call generated by your code. Can be a string or an
26
22
  # list of output content.
27
23
  sig { returns(OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::Variants) }
@@ -36,6 +32,13 @@ module OpenAI
36
32
  sig { returns(Symbol) }
37
33
  attr_accessor :type
38
34
 
35
+ # The unique ID of the function tool call generated by the model.
36
+ sig { returns(T.nilable(String)) }
37
+ attr_reader :call_id
38
+
39
+ sig { params(call_id: String).void }
40
+ attr_writer :call_id
41
+
39
42
  # The execution context that produced this tool call.
40
43
  sig { returns(T.nilable(OpenAI::Responses::ResponseFunctionToolCallOutputItem::Caller::Variants)) }
41
44
  attr_accessor :caller_
@@ -66,12 +69,12 @@ module OpenAI
66
69
 
67
70
  id: String,
68
71
 
69
- call_id: String,
70
-
71
72
  output: OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::Variants,
72
73
 
73
74
  status: OpenAI::Responses::ResponseFunctionToolCallOutputItem::Status::OrSymbol,
74
75
 
76
+ call_id: String,
77
+
75
78
  caller_: T.nilable(
76
79
  T.any(
77
80
  OpenAI::Responses::ResponseFunctionToolCallOutputItem::Caller::Direct::OrHash,
@@ -94,9 +97,6 @@ module OpenAI
94
97
  # The unique ID of the function call tool output.
95
98
  id:,
96
99
 
97
- # The unique ID of the function tool call generated by the model.
98
- call_id:,
99
-
100
100
  # The output from the function call generated by your code. Can be a string or an
101
101
  # list of output content.
102
102
  output:,
@@ -105,6 +105,9 @@ module OpenAI
105
105
  # Populated when items are returned via API.
106
106
  status:,
107
107
 
108
+ # The unique ID of the function tool call generated by the model.
109
+ call_id: nil,
110
+
108
111
  # The execution context that produced this tool call.
109
112
  caller_: nil,
110
113
 
@@ -127,10 +130,10 @@ module OpenAI
127
130
  override.returns(
128
131
  {
129
132
  id: String,
130
- call_id: String,
131
133
  output: OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::Variants,
132
134
  status: OpenAI::Responses::ResponseFunctionToolCallOutputItem::Status::TaggedSymbol,
133
135
  type: Symbol,
136
+ call_id: String,
134
137
  caller_: T.nilable(OpenAI::Responses::ResponseFunctionToolCallOutputItem::Caller::Variants),
135
138
  created_by: String,
136
139
  name: String,
@@ -398,10 +398,6 @@ module OpenAI
398
398
  )
399
399
  end
400
400
 
401
- # The unique ID of the function tool call generated by the model.
402
- sig { returns(String) }
403
- attr_accessor :call_id
404
-
405
401
  # Text, image, or file output of the function tool call.
406
402
  sig { returns(OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Output::Variants) }
407
403
  attr_accessor :output
@@ -415,6 +411,10 @@ module OpenAI
415
411
  sig { returns(T.nilable(String)) }
416
412
  attr_accessor :id
417
413
 
414
+ # The unique ID of the function tool call generated by the model.
415
+ sig { returns(T.nilable(String)) }
416
+ attr_accessor :call_id
417
+
418
418
  # The execution context that produced this tool call.
419
419
  sig {
420
420
  returns(
@@ -445,12 +445,12 @@ module OpenAI
445
445
  sig do
446
446
  params(
447
447
 
448
- call_id: String,
449
-
450
448
  output: OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Output::Variants,
451
449
 
452
450
  id: T.nilable(String),
453
451
 
452
+ call_id: T.nilable(String),
453
+
454
454
  caller_: T.nilable(
455
455
  T.any(
456
456
  OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Caller::Direct::OrHash,
@@ -470,9 +470,6 @@ module OpenAI
470
470
  end
471
471
  def self.new(
472
472
 
473
- # The unique ID of the function tool call generated by the model.
474
- call_id:,
475
-
476
473
  # Text, image, or file output of the function tool call.
477
474
  output:,
478
475
 
@@ -480,6 +477,9 @@ module OpenAI
480
477
  # returned via API.
481
478
  id: nil,
482
479
 
480
+ # The unique ID of the function tool call generated by the model.
481
+ call_id: nil,
482
+
483
483
  # The execution context that produced this tool call.
484
484
  caller_: nil,
485
485
 
@@ -502,10 +502,10 @@ module OpenAI
502
502
  sig do
503
503
  override.returns(
504
504
  {
505
- call_id: String,
506
505
  output: OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Output::Variants,
507
506
  type: Symbol,
508
507
  id: T.nilable(String),
508
+ call_id: T.nilable(String),
509
509
  caller_: T.nilable(
510
510
  T.any(
511
511
  OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Caller::Direct,
@@ -404,7 +404,11 @@ module OpenAI
404
404
  stream: T.noreturn,
405
405
  request_options: OpenAI::RequestOptions::OrHash
406
406
  )
407
- .returns(OpenAI::Internal::Stream[OpenAI::Beta::BetaResponseStreamEvent::Variants])
407
+ .returns(
408
+ OpenAI::Internal::Stream[
409
+ T.any(OpenAI::Beta::BetaResponseStreamEvent::Variants, OpenAI::Streaming::UnknownStreamEvent)
410
+ ]
411
+ )
408
412
  }
409
413
  def stream_raw(
410
414
  # Body param: Whether to run the model response in the background.
@@ -691,7 +695,11 @@ module OpenAI
691
695
  stream: T.noreturn,
692
696
  request_options: OpenAI::RequestOptions::OrHash
693
697
  )
694
- .returns(OpenAI::Internal::Stream[OpenAI::Beta::BetaResponseStreamEvent::Variants])
698
+ .returns(
699
+ OpenAI::Internal::Stream[
700
+ T.any(OpenAI::Beta::BetaResponseStreamEvent::Variants, OpenAI::Streaming::UnknownStreamEvent)
701
+ ]
702
+ )
695
703
  }
696
704
  def retrieve_streaming(
697
705
  # Path param: The ID of the response to retrieve.