openai 0.83.0 → 0.85.0

data/lib/openai/models/beta/beta_response_steer_input.rb

@@ -0,0 +1,360 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # Input to queue for a continuation of the response. Uses the same string or
+      # input-item shape as `response.create.input`, with a non-empty array when
+      # supplying input items.
+      #
+      # Steering accepts only messages with the `user` role. Each message may contain
+      # only `type`, `role`, and `content`, with `content` as a string or an array of
+      # `input_text`, `input_image`, and `input_file` parts. The optional `type` must be
+      # `message`. Other roles, tool outputs, and item types are not supported for
+      # steering.
+      module BetaResponseSteerInput
+        extend OpenAI::Internal::Type::Union
+
+        # A text input, equivalent to a message with the `user` role.
+        variant String
+
+        # A non-empty list of message inputs to queue for the response.
+        variant -> { OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemListArray }
+
+        # The output of a function tool call.
+        module ResponseSteerInputItemList
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          variant :message, -> { OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message }
+
+          # The output of a function tool call.
+          variant(
+            :function_call_output,
+            -> { OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput }
+          )
+
+          class Message < OpenAI::Internal::Type::BaseModel
+            # @!attribute content
+            #   The message content, as an array of content parts.
+            #
+            #   @return [Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>, String]
+            required(
+              :content,
+              union: -> { OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::Content }
+            )
+
+            # @!attribute role
+            #   The message role. Always `user`.
+            #
+            #   @return [Symbol, :user]
+            required :role, const: :user
+
+            # @!attribute type
+            #   The item type. Always `message`.
+            #
+            #   @return [Symbol, :message]
+            required :type, const: :message
+
+            # @!attribute id
+            #   The unique ID of this message item.
+            #
+            #   @return [String, nil]
+            optional :id, String, nil?: true
+
+            # @!attribute agent
+            #   The agent that produced this item.
+            #
+            #   @return [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::Agent, nil]
+            optional(
+              :agent,
+              -> { OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::Agent },
+              nil?: true
+            )
+
+            # @!attribute status
+            #   The status of the message item.
+            #
+            #   @return [String, nil]
+            optional :status, String, nil?: true
+
+            # @!method initialize(content:, id: nil, agent: nil, status: nil, role: :user, type: :message)
+            #   @param content [Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>, String] The message content, as an array of content parts.
+            #
+            #   @param id [String, nil] The unique ID of this message item.
+            #
+            #   @param agent [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::Agent, nil] The agent that produced this item.
+            #
+            #   @param status [String, nil] The status of the message item.
+            #
+            #   @param role [Symbol, :user] The message role. Always `user`.
+            #
+            #   @param type [Symbol, :message] The item type. Always `message`.
+
+            # The message content, as an array of content parts.
+            #
+            # @see OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message#content
+            module Content
+              extend OpenAI::Internal::Type::Union
+
+              variant(
+                -> {
+                  OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::Content::BetaResponseSteerInputContentArray
+                }
+              )
+
+              # The message content, as a single string.
+              variant String
+
+              # @!method self.variants
+              #   @return [Array(Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>, String)]
+
+              # @type [OpenAI::Internal::Type::Converter]
+              BetaResponseSteerInputContentArray = OpenAI::Internal::Type::ArrayOf[
+                union: -> { OpenAI::Beta::BetaResponseSteerInputContent }
+              ]
+            end
+
+            # @see OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message#agent
+            class Agent < OpenAI::Internal::Type::BaseModel
+              # @!attribute agent_name
+              #   The canonical name of the agent that produced this item.
+              #
+              #   @return [String]
+              required :agent_name, String
+
+              # @!method initialize(agent_name:)
+              #   The agent that produced this item.
+              #
+              #   @param agent_name [String] The canonical name of the agent that produced this item.
+            end
+          end
+
+          class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
+            # @!attribute output
+            #   Text, image, or file output of the function tool call.
+            #
+            #   @return [String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>]
+            required(
+              :output,
+              union: -> {
+                OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Output
+              }
+            )
+
+            # @!attribute type
+            #   The type of the function tool call output. Always `function_call_output`.
+            #
+            #   @return [Symbol, :function_call_output]
+            required :type, const: :function_call_output
+
+            # @!attribute id
+            #   The unique ID of the function tool call output. Populated when this item is
+            #   returned via API.
+            #
+            #   @return [String, nil]
+            optional :id, String, nil?: true
+
+            # @!attribute agent
+            #   The agent that produced this item.
+            #
+            #   @return [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Agent, nil]
+            optional(
+              :agent,
+              -> {
+                OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Agent
+              },
+              nil?: true
+            )
+
+            # @!attribute call_id
+            #   The unique ID of the function tool call generated by the model.
+            #
+            #   @return [String, nil]
+            optional :call_id, String, nil?: true
+
+            # @!attribute caller_
+            #   The execution context that produced this tool call.
+            #
+            #   @return [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Program, nil]
+            optional(
+              :caller_,
+              union: -> {
+                OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller
+              },
+              api_name: :caller,
+              nil?: true
+            )
+
+            # @!attribute name
+            #   The name of the tool that produced the output.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute namespace
+            #   The namespace of the tool that produced the output.
+            #
+            #   @return [String, nil]
+            optional :namespace, String, nil?: true
+
+            # @!attribute status
+            #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+            #   Populated when items are returned via API.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Status, nil]
+            optional(
+              :status,
+              enum: -> {
+                OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Status
+              },
+              nil?: true
+            )
+
+            # @!method initialize(output:, id: nil, agent: nil, call_id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput}
+            #   for more details.
+            #
+            #   The output of a function tool call.
+            #
+            #   @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>] Text, image, or file output of the function tool call.
+            #
+            #   @param id [String, nil] The unique ID of the function tool call output. Populated when this item is retu
+            #
+            #   @param agent [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Agent, nil] The agent that produced this item.
+            #
+            #   @param call_id [String, nil] The unique ID of the function tool call generated by the model.
+            #
+            #   @param caller_ [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Program, nil] The execution context that produced this tool call.
+            #
+            #   @param name [String, nil] The name of the tool that produced the output.
+            #
+            #   @param namespace [String, nil] The namespace of the tool that produced the output.
+            #
+            #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Status, nil] The status of the item. One of `in_progress`, `completed`, or `incomplete`. Popu
+            #
+            #   @param type [Symbol, :function_call_output] The type of the function tool call output. Always `function_call_output`.
+
+            # Text, image, or file output of the function tool call.
+            #
+            # @see OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput#output
+            module Output
+              extend OpenAI::Internal::Type::Union
+
+              # A JSON string of the output of the function tool call.
+              variant String
+
+              # An array of content outputs (text, image, file) for the function tool call.
+              variant -> { OpenAI::Beta::BetaResponseFunctionCallOutputItemList }
+
+              # @!method self.variants
+              #   @return [Array(String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>)]
+            end
+
+            # @see OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput#agent
+            class Agent < OpenAI::Internal::Type::BaseModel
+              # @!attribute agent_name
+              #   The canonical name of the agent that produced this item.
+              #
+              #   @return [String]
+              required :agent_name, String
+
+              # @!method initialize(agent_name:)
+              #   The agent that produced this item.
+              #
+              #   @param agent_name [String] The canonical name of the agent that produced this item.
+            end
+
+            # The execution context that produced this tool call.
+            #
+            # @see OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput#caller_
+            module Caller
+              extend OpenAI::Internal::Type::Union
+
+              discriminator :type
+
+              variant(
+                :direct,
+                -> {
+                  OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Direct
+                }
+              )
+
+              variant(
+                :program,
+                -> {
+                  OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Program
+                }
+              )
+
+              class Direct < OpenAI::Internal::Type::BaseModel
+                # @!attribute type
+                #   The caller type. Always `direct`.
+                #
+                #   @return [Symbol, :direct]
+                required :type, const: :direct
+
+                # @!method initialize(type: :direct)
+                #   @param type [Symbol, :direct] The caller type. Always `direct`.
+              end
+
+              class Program < OpenAI::Internal::Type::BaseModel
+                # @!attribute caller_id
+                #   The call ID of the program item that produced this tool call.
+                #
+                #   @return [String]
+                required :caller_id, String
+
+                # @!attribute type
+                #   The caller type. Always `program`.
+                #
+                #   @return [Symbol, :program]
+                required :type, const: :program
+
+                # @!method initialize(caller_id:, type: :program)
+                #   @param caller_id [String] The call ID of the program item that produced this tool call.
+                #
+                #   @param type [Symbol, :program] The caller type. Always `program`.
+              end
+
+              # @!method self.variants
+              #   @return [Array(OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Program)]
+            end
+
+            # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+            # Populated when items are returned via API.
+            #
+            # @see OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput#status
+            module Status
+              extend OpenAI::Internal::Type::Enum
+
+              IN_PROGRESS = :in_progress
+              COMPLETED = :completed
+              INCOMPLETE = :incomplete
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput)]
+        end
+
+        # @!method self.variants
+        #   @return [Array(String, Array<Hash{Symbol=>Object}>)]
+
+        # @type [OpenAI::Internal::Type::Converter]
+        ResponseSteerInputItemListArray = OpenAI::Internal::Type::ArrayOf[
+          union: -> {
+            OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList
+          }
+        ]
+      end
+    end
+
+    BetaResponseSteerInput = Beta::BetaResponseSteerInput
+  end
+end

data/lib/openai/models/beta/beta_response_steer_input_content.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A piece of message content, such as text, an image, or a file.
+      module BetaResponseSteerInputContent
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A text input to the model.
+        variant :input_text, -> { OpenAI::Beta::BetaResponseInputTextContent }
+
+        # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision)
+        variant :input_image, -> { OpenAI::Beta::BetaResponseInputImageContent }
+
+        # A file input to the model.
+        variant :input_file, -> { OpenAI::Beta::BetaResponseInputFileContent }
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent)]
+      end
+    end
+
+    BetaResponseSteerInputContent = Beta::BetaResponseSteerInputContent
+  end
+end

data/lib/openai/models/beta/beta_response_steer_pending_event.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseSteerPendingEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute reason
+        #   An extensible enum describing why accepted steering input is still queued.
+        #   Clients should handle unknown values because additional reasons may be
+        #   introduced. Known values include:
+        #
+        #   - `waiting_for_required_input`: The response is waiting for the tool results or
+        #     approval decisions identified by `required_input`.
+        #
+        #   @return [Symbol, :waiting_for_required_input, String]
+        required :reason, union: -> { OpenAI::Beta::BetaResponseSteerPendingReason }
+
+        # @!attribute required_input
+        #   Input stubs identifying outstanding client-owned tool results or approval
+        #   decisions. Each stub contains identifying fields only; the client supplies the
+        #   result before including it in `response.create`.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaResponseSteerRequiredInput::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::CustomToolCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ShellCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ToolSearchOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::McpApprovalResponse>]
+        required(
+          :required_input,
+          -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseSteerRequiredInput] }
+        )
+
+        # @!attribute sequence_number
+        #   The sequence number for this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute steer
+        #   The steering submission that remains queued.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseSteerPendingEvent::Steer]
+        required :steer, -> { OpenAI::Beta::BetaResponseSteerPendingEvent::Steer }
+
+        # @!attribute type
+        #   The event discriminator. Always `response.steer.pending`.
+        #
+        #   @return [Symbol, :"response.steer.pending"]
+        required :type, const: :"response.steer.pending"
+
+        # @!attribute stream_id
+        #   The WebSocket lane that emitted this event. This field is present when the
+        #   target response's `response.create` event supplied a `stream_id`.
+        #
+        #   @return [String, nil]
+        optional :stream_id, String
+
+        # @!method initialize(reason:, required_input:, sequence_number:, steer:, stream_id: nil, type: :"response.steer.pending")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseSteerPendingEvent} for more details.
+        #
+        #   Emitted when accepted steering input remains queued after the target response
+        #   completes. The server still owns the input. Do not resend it. The successor's
+        #   `response.created` event is the commit point.
+        #
+        #   When `reason` is `waiting_for_required_input`, this event follows
+        #   `response.completed` while the response waits for the tool results or approval
+        #   decisions identified by `required_input`. Copy those stubs, fill their result
+        #   fields using the ordinary `response.create` input schemas, and submit one
+        #   continuation per parent with the same `previous_response_id` and WebSocket lane.
+        #   Use saved results without rerunning tools. The queued steering input is
+        #   prepended in submission order to the continuation's input. That explicit request
+        #   retains its own settings.
+        #
+        #   This notification is emitted at most once per steering submission. Multiple
+        #   submissions for the same parent can report the same required inputs; they do not
+        #   each require a separate continuation.
+        #
+        #   @param reason [Symbol, :waiting_for_required_input, String] An extensible enum describing why accepted steering input is still queued.
+        #
+        #   @param required_input [Array<OpenAI::Models::Beta::BetaResponseSteerRequiredInput::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::CustomToolCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ShellCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ToolSearchOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::McpApprovalResponse>] Input stubs identifying outstanding client-owned tool results or
+        #
+        #   @param sequence_number [Integer] The sequence number for this event.
+        #
+        #   @param steer [OpenAI::Models::Beta::BetaResponseSteerPendingEvent::Steer] The steering submission that remains queued.
+        #
+        #   @param stream_id [String] The WebSocket lane that emitted this event. This field is present when
+        #
+        #   @param type [Symbol, :"response.steer.pending"] The event discriminator. Always `response.steer.pending`.
+
+        # @see OpenAI::Models::Beta::BetaResponseSteerPendingEvent#steer
+        class Steer < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID assigned to the steering submission.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute previous_response_id
+          #   The ID of the response being steered.
+          #
+          #   @return [String]
+          required :previous_response_id, String
+
+          # @!method initialize(id:, previous_response_id:)
+          #   The steering submission that remains queued.
+          #
+          #   @param id [String] The ID assigned to the steering submission.
+          #
+          #   @param previous_response_id [String] The ID of the response being steered.
+        end
+      end
+    end
+
+    BetaResponseSteerPendingEvent = Beta::BetaResponseSteerPendingEvent
+  end
+end

data/lib/openai/models/beta/beta_response_steer_pending_reason.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # An extensible enum describing why accepted steering input is still queued.
+      # Clients should handle unknown values because additional reasons may be
+      # introduced. Known values include:
+      #
+      # - `waiting_for_required_input`: The response is waiting for the tool results or
+      #   approval decisions identified by `required_input`.
+      module BetaResponseSteerPendingReason
+        extend OpenAI::Internal::Type::Union
+
+        variant const: :waiting_for_required_input
+
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Symbol, :waiting_for_required_input, String)]
+      end
+    end
+
+    BetaResponseSteerPendingReason = Beta::BetaResponseSteerPendingReason
+  end
+end