openai 0.16.0 → 0.17.1

data/lib/openai/models/responses/response_create_params.rb

@@ -51,7 +51,7 @@ module OpenAI
         #   - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
         #   - [Function calling](https://platform.openai.com/docs/guides/function-calling)
         #
-        #   @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
+        #   @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
         optional :input, union: -> { OpenAI::Responses::ResponseCreateParams::Input }
 
         # @!attribute instructions
@@ -178,6 +178,12 @@ module OpenAI
         #   @return [Boolean, nil]
         optional :store, OpenAI::Internal::Type::Boolean, nil?: true
 
+        # @!attribute stream_options
+        #   Options for streaming responses. Only set this when you set `stream: true`.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseCreateParams::StreamOptions, nil]
+        optional :stream_options, -> { OpenAI::Responses::ResponseCreateParams::StreamOptions }, nil?: true
+
         # @!attribute temperature
         #   What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
         #   make the output more random, while lower values like 0.2 will make it more
@@ -208,7 +214,7 @@ module OpenAI
         #   response. See the `tools` parameter to see how to specify which tools the model
         #   can call.
         #
-        #   @return [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, nil]
+        #   @return [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, nil]
         optional :tool_choice, union: -> { OpenAI::Responses::ResponseCreateParams::ToolChoice }
 
         # @!attribute tools
@@ -224,10 +230,12 @@ module OpenAI
         #     Learn more about
         #     [built-in tools](https://platform.openai.com/docs/guides/tools).
         #   - **Function calls (custom tools)**: Functions that are defined by you, enabling
-        #     the model to call your own code. Learn more about
+        #     the model to call your own code with strongly typed arguments and outputs.
+        #     Learn more about
         #     [function calling](https://platform.openai.com/docs/guides/function-calling).
+        #     You can also use custom tools to call your own code.
         #
-        #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>, nil]
+        #   @return [Array<OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool>, nil]
         optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
         # @!attribute top_logprobs
@@ -271,7 +279,7 @@ module OpenAI
         #   @return [String, nil]
         optional :user, String
 
-        # @!method initialize(background: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
+        # @!method initialize(background: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseCreateParams} for more details.
         #
@@ -279,7 +287,7 @@ module OpenAI
         #
         #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
         #
-        #   @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
+        #   @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
         #
         #   @param instructions [String, nil] A system (or developer) message inserted into the model's context.
         #
@@ -307,13 +315,15 @@ module OpenAI
         #
         #   @param store [Boolean, nil] Whether to store the generated model response for later retrieval via
         #
+        #   @param stream_options [OpenAI::Models::Responses::ResponseCreateParams::StreamOptions, nil] Options for streaming responses. Only set this when you set `stream: true`.
+        #
         #   @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
         #
         #   @param text [OpenAI::Models::Responses::ResponseTextConfig] Configuration options for a text response from the model. Can be plain
         #
-        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp] How the model should select which tool (or tools) to use when generating
+        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom] How the model should select which tool (or tools) to use when generating
         #
-        #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+        #   @param tools [Array<OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
         #
         #   @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
         #
@@ -346,7 +356,7 @@ module OpenAI
           variant -> { OpenAI::Responses::ResponseInput }
 
           # @!method self.variants
-          #   @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
+          #   @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
         end
 
         # Specifies the processing type used for serving the request.
@@ -379,6 +389,28 @@ module OpenAI
           #   @return [Array<Symbol>]
         end
 
+        class StreamOptions < OpenAI::Internal::Type::BaseModel
+          # @!attribute include_obfuscation
+          #   When true, stream obfuscation will be enabled. Stream obfuscation adds random
+          #   characters to an `obfuscation` field on streaming delta events to normalize
+          #   payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+          #   fields are included by default, but add a small amount of overhead to the data
+          #   stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+          #   you trust the network links between your application and the OpenAI API.
+          #
+          #   @return [Boolean, nil]
+          optional :include_obfuscation, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(include_obfuscation: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Responses::ResponseCreateParams::StreamOptions} for more
+          #   details.
+          #
+          #   Options for streaming responses. Only set this when you set `stream: true`.
+          #
+          #   @param include_obfuscation [Boolean] When true, stream obfuscation will be enabled. Stream obfuscation adds
+        end
+
         # How the model should select which tool (or tools) to use when generating a
         # response. See the `tools` parameter to see how to specify which tools the model
         # can call.
@@ -395,6 +427,9 @@ module OpenAI
           # `required` means the model must call one or more tools.
           variant enum: -> { OpenAI::Responses::ToolChoiceOptions }
 
+          # Constrains the tools available to the model to a pre-defined set.
+          variant -> { OpenAI::Responses::ToolChoiceAllowed }
+
           # Indicates that the model should use a built-in tool to generate a response.
           # [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
           variant -> { OpenAI::Responses::ToolChoiceTypes }
@@ -405,8 +440,11 @@ module OpenAI
           # Use this option to force the model to call a specific tool on a remote MCP server.
           variant -> { OpenAI::Responses::ToolChoiceMcp }
 
+          # Use this option to force the model to call a specific custom tool.
+          variant -> { OpenAI::Responses::ToolChoiceCustom }
+
           # @!method self.variants
-          #   @return [Array(Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp)]
+          #   @return [Array(Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom)]
         end
 
         # The truncation strategy to use for the model response.

data/lib/openai/models/responses/response_custom_tool_call.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseCustomToolCall < OpenAI::Internal::Type::BaseModel
+        # @!attribute call_id
+        #   An identifier used to map this custom tool call to a tool call output.
+        #
+        #   @return [String]
+        required :call_id, String
+
+        # @!attribute input
+        #   The input for the custom tool call generated by the model.
+        #
+        #   @return [String]
+        required :input, String
+
+        # @!attribute name
+        #   The name of the custom tool being called.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   The type of the custom tool call. Always `custom_tool_call`.
+        #
+        #   @return [Symbol, :custom_tool_call]
+        required :type, const: :custom_tool_call
+
+        # @!attribute id
+        #   The unique ID of the custom tool call in the OpenAI platform.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!method initialize(call_id:, input:, name:, id: nil, type: :custom_tool_call)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::ResponseCustomToolCall} for more details.
+        #
+        #   A call to a custom tool created by the model.
+        #
+        #   @param call_id [String] An identifier used to map this custom tool call to a tool call output.
+        #
+        #   @param input [String] The input for the custom tool call generated by the model.
+        #
+        #   @param name [String] The name of the custom tool being called.
+        #
+        #   @param id [String] The unique ID of the custom tool call in the OpenAI platform.
+        #
+        #   @param type [Symbol, :custom_tool_call] The type of the custom tool call. Always `custom_tool_call`.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_custom_tool_call_input_delta_event.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseCustomToolCallInputDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute delta
+        #   The incremental input data (delta) for the custom tool call.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute item_id
+        #   Unique identifier for the API item associated with this event.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output this delta applies to.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The event type identifier.
+        #
+        #   @return [Symbol, :"response.custom_tool_call_input.delta"]
+        required :type, const: :"response.custom_tool_call_input.delta"
+
+        # @!method initialize(delta:, item_id:, output_index:, sequence_number:, type: :"response.custom_tool_call_input.delta")
+        #   Event representing a delta (partial update) to the input of a custom tool call.
+        #
+        #   @param delta [String] The incremental input data (delta) for the custom tool call.
+        #
+        #   @param item_id [String] Unique identifier for the API item associated with this event.
+        #
+        #   @param output_index [Integer] The index of the output this delta applies to.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.custom_tool_call_input.delta"] The event type identifier.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_custom_tool_call_input_done_event.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseCustomToolCallInputDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute input
+        #   The complete input data for the custom tool call.
+        #
+        #   @return [String]
+        required :input, String
+
+        # @!attribute item_id
+        #   Unique identifier for the API item associated with this event.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output this event applies to.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The event type identifier.
+        #
+        #   @return [Symbol, :"response.custom_tool_call_input.done"]
+        required :type, const: :"response.custom_tool_call_input.done"
+
+        # @!method initialize(input:, item_id:, output_index:, sequence_number:, type: :"response.custom_tool_call_input.done")
+        #   Event indicating that input for a custom tool call is complete.
+        #
+        #   @param input [String] The complete input data for the custom tool call.
+        #
+        #   @param item_id [String] Unique identifier for the API item associated with this event.
+        #
+        #   @param output_index [Integer] The index of the output this event applies to.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.custom_tool_call_input.done"] The event type identifier.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_custom_tool_call_output.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseCustomToolCallOutput < OpenAI::Internal::Type::BaseModel
+        # @!attribute call_id
+        #   The call ID, used to map this custom tool call output to a custom tool call.
+        #
+        #   @return [String]
+        required :call_id, String
+
+        # @!attribute output
+        #   The output from the custom tool call generated by your code.
+        #
+        #   @return [String]
+        required :output, String
+
+        # @!attribute type
+        #   The type of the custom tool call output. Always `custom_tool_call_output`.
+        #
+        #   @return [Symbol, :custom_tool_call_output]
+        required :type, const: :custom_tool_call_output
+
+        # @!attribute id
+        #   The unique ID of the custom tool call output in the OpenAI platform.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!method initialize(call_id:, output:, id: nil, type: :custom_tool_call_output)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::ResponseCustomToolCallOutput} for more details.
+        #
+        #   The output of a custom tool call from your code, being sent back to the model.
+        #
+        #   @param call_id [String] The call ID, used to map this custom tool call output to a custom tool call.
+        #
+        #   @param output [String] The output from the custom tool call generated by your code.
+        #
+        #   @param id [String] The unique ID of the custom tool call output in the OpenAI platform.
+        #
+        #   @param type [Symbol, :custom_tool_call_output] The type of the custom tool call output. Always `custom_tool_call_output`.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_input_item.rb

@@ -80,6 +80,12 @@ module OpenAI
         # An invocation of a tool on an MCP server.
         variant :mcp_call, -> { OpenAI::Responses::ResponseInputItem::McpCall }
 
+        # The output of a custom tool call from your code, being sent back to the model.
+        variant :custom_tool_call_output, -> { OpenAI::Responses::ResponseCustomToolCallOutput }
+
+        # A call to a custom tool created by the model.
+        variant :custom_tool_call, -> { OpenAI::Responses::ResponseCustomToolCall }
+
         # An internal identifier for an item to reference.
         variant :item_reference, -> { OpenAI::Responses::ResponseInputItem::ItemReference }
 
@@ -869,7 +875,7 @@ module OpenAI
         end
 
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference)]
+        #   @return [Array(OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference)]
       end
     end
   end

data/lib/openai/models/responses/response_output_item.rb

@@ -52,6 +52,9 @@ module OpenAI
         # A request for human approval of a tool invocation.
         variant :mcp_approval_request, -> { OpenAI::Responses::ResponseOutputItem::McpApprovalRequest }
 
+        # A call to a custom tool created by the model.
+        variant :custom_tool_call, -> { OpenAI::Responses::ResponseCustomToolCall }
+
         class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
           # @!attribute id
           #   The unique ID of the image generation call.
@@ -435,7 +438,7 @@ module OpenAI
         end
 
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest)]
+        #   @return [Array(OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall)]
       end
     end
   end

data/lib/openai/models/responses/response_output_item_added_event.rb

@@ -7,7 +7,7 @@ module OpenAI
         # @!attribute item
         #   The output item that was added.
         #
-        #   @return [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest]
+        #   @return [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall]
         required :item, union: -> { OpenAI::Responses::ResponseOutputItem }
 
         # @!attribute output_index
@@ -34,7 +34,7 @@ module OpenAI
         #
         #   Emitted when a new output item is added.
         #
-        #   @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest] The output item that was added.
+        #   @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall] The output item that was added.
         #
         #   @param output_index [Integer] The index of the output item that was added.
         #

data/lib/openai/models/responses/response_output_item_done_event.rb

@@ -7,7 +7,7 @@ module OpenAI
         # @!attribute item
         #   The output item that was marked done.
         #
-        #   @return [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest]
+        #   @return [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall]
         required :item, union: -> { OpenAI::Responses::ResponseOutputItem }
 
         # @!attribute output_index
@@ -34,7 +34,7 @@ module OpenAI
         #
         #   Emitted when an output item is marked done.
         #
-        #   @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest] The output item that was marked done.
+        #   @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall] The output item that was marked done.
         #
         #   @param output_index [Integer] The index of the output item that was marked done.
         #

data/lib/openai/models/responses/response_reasoning_item.rb

@@ -11,7 +11,7 @@ module OpenAI
         required :id, String
 
         # @!attribute summary
-        #   Reasoning text contents.
+        #   Reasoning summary content.
         #
         #   @return [Array<OpenAI::Models::Responses::ResponseReasoningItem::Summary>]
         required :summary,
@@ -23,6 +23,13 @@ module OpenAI
         #   @return [Symbol, :reasoning]
         required :type, const: :reasoning
 
+        # @!attribute content
+        #   Reasoning text content.
+        #
+        #   @return [Array<OpenAI::Models::Responses::ResponseReasoningItem::Content>, nil]
+        optional :content,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseReasoningItem::Content] }
+
         # @!attribute encrypted_content
         #   The encrypted content of the reasoning item - populated when a response is
         #   generated with `reasoning.encrypted_content` in the `include` parameter.
@@ -37,7 +44,7 @@ module OpenAI
         #   @return [Symbol, OpenAI::Models::Responses::ResponseReasoningItem::Status, nil]
         optional :status, enum: -> { OpenAI::Responses::ResponseReasoningItem::Status }
 
-        # @!method initialize(id:, summary:, encrypted_content: nil, status: nil, type: :reasoning)
+        # @!method initialize(id:, summary:, content: nil, encrypted_content: nil, status: nil, type: :reasoning)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseReasoningItem} for more details.
         #
@@ -48,7 +55,9 @@ module OpenAI
         #
         #   @param id [String] The unique identifier of the reasoning content.
         #
-        #   @param summary [Array<OpenAI::Models::Responses::ResponseReasoningItem::Summary>] Reasoning text contents.
+        #   @param summary [Array<OpenAI::Models::Responses::ResponseReasoningItem::Summary>] Reasoning summary content.
+        #
+        #   @param content [Array<OpenAI::Models::Responses::ResponseReasoningItem::Content>] Reasoning text content.
         #
         #   @param encrypted_content [String, nil] The encrypted content of the reasoning item - populated when a response is
         #
@@ -58,7 +67,7 @@ module OpenAI
 
         class Summary < OpenAI::Internal::Type::BaseModel
           # @!attribute text
-          #   A short summary of the reasoning used by the model when generating the response.
+          #   A summary of the reasoning output from the model so far.
           #
           #   @return [String]
           required :text, String
@@ -73,11 +82,33 @@ module OpenAI
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Responses::ResponseReasoningItem::Summary} for more details.
           #
-          #   @param text [String] A short summary of the reasoning used by the model when generating
+          #   @param text [String] A summary of the reasoning output from the model so far.
           #
           #   @param type [Symbol, :summary_text] The type of the object. Always `summary_text`.
         end
 
+        class Content < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   Reasoning text output from the model.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The type of the object. Always `reasoning_text`.
+          #
+          #   @return [Symbol, :reasoning_text]
+          required :type, const: :reasoning_text
+
+          # @!method initialize(text:, type: :reasoning_text)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Responses::ResponseReasoningItem::Content} for more details.
+          #
+          #   @param text [String] Reasoning text output from the model.
+          #
+          #   @param type [Symbol, :reasoning_text] The type of the object. Always `reasoning_text`.
+        end
+
         # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
         # Populated when items are returned via API.
         #

data/lib/openai/models/responses/response_reasoning_text_delta_event.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseReasoningTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the reasoning content part this delta is associated with.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute delta
+        #   The text delta that was added to the reasoning content.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute item_id
+        #   The ID of the item this reasoning text delta is associated with.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item this reasoning text delta is associated with.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.reasoning_text.delta`.
+        #
+        #   @return [Symbol, :"response.reasoning_text.delta"]
+        required :type, const: :"response.reasoning_text.delta"
+
+        # @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, type: :"response.reasoning_text.delta")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::ResponseReasoningTextDeltaEvent} for more details.
+        #
+        #   Emitted when a delta is added to a reasoning text.
+        #
+        #   @param content_index [Integer] The index of the reasoning content part this delta is associated with.
+        #
+        #   @param delta [String] The text delta that was added to the reasoning content.
+        #
+        #   @param item_id [String] The ID of the item this reasoning text delta is associated with.
+        #
+        #   @param output_index [Integer] The index of the output item this reasoning text delta is associated with.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.reasoning_text.delta"] The type of the event. Always `response.reasoning_text.delta`.
+      end
+    end
+  end
+end