openai 0.83.0 → 0.85.0

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

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      # An input stub identifying an outstanding client-owned tool result or approval
+      # decision. Copy the stub and fill the result fields using the corresponding
+      # `response.create` input schema. Use saved results without rerunning the tool.
+      # The server does not supply results, approval decisions, or safety
+      # acknowledgements in these stubs.
+      module ResponseSteerRequiredInput
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Supply `output` using the function tool call output input schema.
+        variant :function_call_output, -> { OpenAI::Responses::ResponseSteerRequiredInput::FunctionCallOutput }
+
+        # Supply `output` using the custom tool call output input schema. The
+        # original custom tool call supplies the tool's name.
+        variant(
+          :custom_tool_call_output,
+          -> { OpenAI::Responses::ResponseSteerRequiredInput::CustomToolCallOutput }
+        )
+
+        # Supply `output` using the computer tool call output input schema,
+        # including any required `acknowledged_safety_checks`.
+        variant :computer_call_output, -> { OpenAI::Responses::ResponseSteerRequiredInput::ComputerCallOutput }
+
+        # Supply `output` using the shell tool call output input schema. Each
+        # output entry includes `stdout`, `stderr`, and `outcome`.
+        variant :shell_call_output, -> { OpenAI::Responses::ResponseSteerRequiredInput::ShellCallOutput }
+
+        # Supply `status` and optional `output` using the apply patch tool call
+        # output input schema.
+        variant(
+          :apply_patch_call_output,
+          -> { OpenAI::Responses::ResponseSteerRequiredInput::ApplyPatchCallOutput }
+        )
+
+        # Supply `tools` using the tool search output input schema, retaining
+        # `execution: "client"`.
+        variant :tool_search_output, -> { OpenAI::Responses::ResponseSteerRequiredInput::ToolSearchOutput }
+
+        # Supply `approve` using the MCP approval response input schema. An
+        # optional `reason` can be supplied when denying the request. The original
+        # approval request identifies the tool and server.
+        variant :mcp_approval_response, -> { OpenAI::Responses::ResponseSteerRequiredInput::McpApprovalResponse }
+
+        class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
+          # @!attribute call_id
+          #
+          #   @return [String]
+          required :call_id, String
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :function_call_output]
+          required :type, const: :function_call_output
+
+          # @!method initialize(call_id:, name:, type: :function_call_output)
+          #   Supply `output` using the function tool call output input schema.
+          #
+          #   @param call_id [String]
+          #   @param name [String]
+          #   @param type [Symbol, :function_call_output]
+        end
+
+        class CustomToolCallOutput < OpenAI::Internal::Type::BaseModel
+          # @!attribute call_id
+          #
+          #   @return [String]
+          required :call_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :custom_tool_call_output]
+          required :type, const: :custom_tool_call_output
+
+          # @!method initialize(call_id:, type: :custom_tool_call_output)
+          #   Supply `output` using the custom tool call output input schema. The original
+          #   custom tool call supplies the tool's name.
+          #
+          #   @param call_id [String]
+          #   @param type [Symbol, :custom_tool_call_output]
+        end
+
+        class ComputerCallOutput < OpenAI::Internal::Type::BaseModel
+          # @!attribute call_id
+          #
+          #   @return [String]
+          required :call_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :computer_call_output]
+          required :type, const: :computer_call_output
+
+          # @!method initialize(call_id:, type: :computer_call_output)
+          #   Supply `output` using the computer tool call output input schema, including any
+          #   required `acknowledged_safety_checks`.
+          #
+          #   @param call_id [String]
+          #   @param type [Symbol, :computer_call_output]
+        end
+
+        class ShellCallOutput < OpenAI::Internal::Type::BaseModel
+          # @!attribute call_id
+          #
+          #   @return [String]
+          required :call_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :shell_call_output]
+          required :type, const: :shell_call_output
+
+          # @!method initialize(call_id:, type: :shell_call_output)
+          #   Supply `output` using the shell tool call output input schema. Each output entry
+          #   includes `stdout`, `stderr`, and `outcome`.
+          #
+          #   @param call_id [String]
+          #   @param type [Symbol, :shell_call_output]
+        end
+
+        class ApplyPatchCallOutput < OpenAI::Internal::Type::BaseModel
+          # @!attribute call_id
+          #
+          #   @return [String]
+          required :call_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :apply_patch_call_output]
+          required :type, const: :apply_patch_call_output
+
+          # @!method initialize(call_id:, type: :apply_patch_call_output)
+          #   Supply `status` and optional `output` using the apply patch tool call output
+          #   input schema.
+          #
+          #   @param call_id [String]
+          #   @param type [Symbol, :apply_patch_call_output]
+        end
+
+        class ToolSearchOutput < OpenAI::Internal::Type::BaseModel
+          # @!attribute call_id
+          #
+          #   @return [String]
+          required :call_id, String
+
+          # @!attribute execution
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseSteerRequiredInput::ToolSearchOutput::Execution]
+          required(
+            :execution,
+            enum: -> { OpenAI::Responses::ResponseSteerRequiredInput::ToolSearchOutput::Execution }
+          )
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :tool_search_output]
+          required :type, const: :tool_search_output
+
+          # @!method initialize(call_id:, execution:, type: :tool_search_output)
+          #   Supply `tools` using the tool search output input schema, retaining
+          #   `execution: "client"`.
+          #
+          #   @param call_id [String]
+          #   @param execution [Symbol, OpenAI::Models::Responses::ResponseSteerRequiredInput::ToolSearchOutput::Execution]
+          #   @param type [Symbol, :tool_search_output]
+
+          # @see OpenAI::Models::Responses::ResponseSteerRequiredInput::ToolSearchOutput#execution
+          module Execution
+            extend OpenAI::Internal::Type::Enum
+
+            CLIENT = :client
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class McpApprovalResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute approval_request_id
+          #
+          #   @return [String]
+          required :approval_request_id, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :mcp_approval_response]
+          required :type, const: :mcp_approval_response
+
+          # @!method initialize(approval_request_id:, type: :mcp_approval_response)
+          #   Supply `approve` using the MCP approval response input schema. An optional
+          #   `reason` can be supplied when denying the request. The original approval request
+          #   identifies the tool and server.
+          #
+          #   @param approval_request_id [String]
+          #   @param type [Symbol, :mcp_approval_response]
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Responses::ResponseSteerRequiredInput::FunctionCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::CustomToolCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ComputerCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ShellCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ToolSearchOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::McpApprovalResponse)]
+      end
+    end
+  end
+end

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

@@ -124,6 +124,10 @@ module OpenAI
         variant :"response.failed", -> { OpenAI::Responses::ResponseFailedEvent }
 
         # An event that is emitted when a response finishes as incomplete.
+        #
+        # Over WebSocket, steering can finish a response with
+        # `response.incomplete_details.reason` set to `steered`, followed automatically
+        # by a successor `response.created` that commits the queued steering input.
         variant :"response.incomplete", -> { OpenAI::Responses::ResponseIncompleteEvent }
 
         # Emitted when a new output item is added.

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

@@ -34,16 +34,7 @@ module OpenAI
         #   @return [Integer]
         required :total_tokens, Integer
 
-        # @!attribute compute_units
-        #   Compute units for the request. Currently null when available.
-        #
-        #   @return [Integer, nil]
-        optional :compute_units, Integer, nil?: true
-
-        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:, compute_units: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseUsage} for more details.
-        #
+        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:)
         #   Represents token usage details including input tokens, output tokens, a
         #   breakdown of output tokens, and the total tokens used.
         #
@@ -56,8 +47,6 @@ module OpenAI
         #   @param output_tokens_details [OpenAI::Models::Responses::ResponseUsage::OutputTokensDetails] A detailed breakdown of the output tokens.
         #
         #   @param total_tokens [Integer] The total number of tokens used.
-        #
-        #   @param compute_units [Integer, nil] Compute units for the request. Currently null when available.
 
         # @see OpenAI::Models::Responses::ResponseUsage#input_tokens_details
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel