openai 0.88.0 → 0.90.0

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionEnvironmentPendingEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute environment
+        #   The current environment state.
+        #
+        #   @return [OpenAI::Models::Beta::AgentSessionEnvironmentState]
+        required :environment, -> { OpenAI::Beta::AgentSessionEnvironmentState }
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.environment.pending`.
+        #
+        #   @return [Symbol, :"agent.session.environment.pending"]
+        required :type, const: :"agent.session.environment.pending"
+
+        # @!method initialize(environment:, event_id:, session_id:, turn_id:, type: :"agent.session.environment.pending")
+        #   Emitted while a session environment is being prepared.
+        #
+        #   @param environment [OpenAI::Models::Beta::AgentSessionEnvironmentState]
+        #     The current environment state.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.environment.pending"]
+        #     The type of the object. Always `agent.session.environment.pending`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionEnvironmentReadyEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute environment
+        #   The current environment state.
+        #
+        #   @return [OpenAI::Models::Beta::AgentSessionEnvironmentState]
+        required :environment, -> { OpenAI::Beta::AgentSessionEnvironmentState }
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.environment.ready`.
+        #
+        #   @return [Symbol, :"agent.session.environment.ready"]
+        required :type, const: :"agent.session.environment.ready"
+
+        # @!method initialize(environment:, event_id:, session_id:, turn_id:, type: :"agent.session.environment.ready")
+        #   Emitted when a hosted session environment is ready to connect.
+        #
+        #   @param environment [OpenAI::Models::Beta::AgentSessionEnvironmentState]
+        #     The current environment state.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.environment.ready"]
+        #     The type of the object. Always `agent.session.environment.ready`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionEnvironmentState < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The public ID of the environment.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute error
+        #   An error reported while preparing a session environment.
+        #
+        #   @return [OpenAI::Models::Beta::AgentSessionEnvironmentState::Error, nil]
+        required :error, -> { OpenAI::Beta::AgentSessionEnvironmentState::Error }, nil?: true
+
+        # @!attribute status
+        #   The environment's connection status.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentSessionEnvironmentState::Status]
+        required :status, enum: -> { OpenAI::Beta::AgentSessionEnvironmentState::Status }
+
+        # @!attribute type
+        #   The environment type.
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!method initialize(id:, error:, status:, type:)
+        #   The current state of a session environment.
+        #
+        #   @param id [String]
+        #     The public ID of the environment.
+        #
+        #   @param error [OpenAI::Models::Beta::AgentSessionEnvironmentState::Error, nil]
+        #     An error reported while preparing a session environment.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentSessionEnvironmentState::Status]
+        #     The environment's connection status.
+        #
+        #   @param type [String]
+        #     The environment type.
+
+        # @see OpenAI::Models::Beta::AgentSessionEnvironmentState#error
+        class Error < OpenAI::Internal::Type::BaseModel
+          # @!attribute code
+          #   A machine-readable error code.
+          #
+          #   @return [String]
+          required :code, String
+
+          # @!attribute message
+          #   A human-readable error message.
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute type
+          #   The error type.
+          #
+          #   @return [String]
+          required :type, String
+
+          # @!method initialize(code:, message:, type:)
+          #   An error reported while preparing a session environment.
+          #
+          #   @param code [String]
+          #     A machine-readable error code.
+          #
+          #   @param message [String]
+          #     A human-readable error message.
+          #
+          #   @param type [String]
+          #     The error type.
+        end
+
+        # The environment's connection status.
+        #
+        # @see OpenAI::Models::Beta::AgentSessionEnvironmentState#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          # The environment is being prepared.
+          PENDING = :pending
+
+          # The environment is ready to connect.
+          READY = :ready
+
+          # The environment is connected.
+          CONNECTED = :connected
+
+          # The environment is disconnected.
+          DISCONNECTED = :disconnected
+
+          # The environment failed to connect.
+          FAILED = :failed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionErrorEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute error
+        #   The error that occurred.
+        #
+        #   @return [OpenAI::Models::Beta::SessionError]
+        required :error, -> { OpenAI::Beta::SessionError }
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute type
+        #   The type of the object. Always `error`.
+        #
+        #   @return [Symbol, :error]
+        required :type, const: :error
+
+        # @!method initialize(error:, event_id:, session_id:, type: :error)
+        #   Emitted when a turn or session fails.
+        #
+        #   @param error [OpenAI::Models::Beta::SessionError]
+        #     The error that occurred.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param type [Symbol, :error]
+        #     The type of the object. Always `error`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # An event emitted by a Managed Agents session.
+      module AgentSessionEvent
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Emitted when a turn or session fails.
+        variant :error, -> { OpenAI::Beta::AgentSessionErrorEvent }
+
+        # Emitted when a hosted session environment is ready to connect.
+        variant :"agent.session.environment.ready", -> { OpenAI::Beta::AgentSessionEnvironmentReadyEvent }
+
+        # Emitted when command execution produces an output delta.
+        variant(
+          :"agent.output.command_execution_output.delta",
+          -> { OpenAI::Beta::AgentOutputCommandExecutionOutputDeltaEvent }
+        )
+
+        # Emitted when a session is created.
+        variant :"agent.session.created", -> { OpenAI::Beta::AgentSessionCreatedEvent }
+
+        # Emitted when a turn is created.
+        variant :"agent.session.turn.created", -> { OpenAI::Beta::AgentSessionTurnCreatedEvent }
+
+        # Emitted when a turn starts running.
+        variant :"agent.session.turn.in_progress", -> { OpenAI::Beta::AgentSessionTurnInProgressEvent }
+
+        # Emitted when a turn completes.
+        variant :"agent.session.turn.completed", -> { OpenAI::Beta::AgentSessionTurnCompletedEvent }
+
+        # Emitted when a turn fails.
+        variant :"agent.session.turn.failed", -> { OpenAI::Beta::AgentSessionTurnFailedEvent }
+
+        # Emitted when a turn is cancelled.
+        variant :"agent.session.turn.cancelled", -> { OpenAI::Beta::AgentSessionTurnCancelledEvent }
+
+        # Emitted when an item is added to a turn.
+        variant :"agent.session.turn.item.added", -> { OpenAI::Beta::AgentSessionTurnItemAddedEvent }
+
+        # Emitted when a session becomes idle.
+        variant :"agent.session.idle", -> { OpenAI::Beta::AgentSessionIdleEvent }
+
+        # Emitted when a session starts processing a turn.
+        variant :"agent.session.in_progress", -> { OpenAI::Beta::AgentSessionInProgressEvent }
+
+        # Emitted when a session is waiting for one or more required actions.
+        variant :"agent.session.requires_action", -> { OpenAI::Beta::AgentSessionRequiresActionEvent }
+
+        # Emitted when a session fails.
+        variant :"agent.session.failed", -> { OpenAI::Beta::AgentSessionFailedEvent }
+
+        # Emitted while a session environment is being prepared.
+        variant :"agent.session.environment.pending", -> { OpenAI::Beta::AgentSessionEnvironmentPendingEvent }
+
+        # Emitted when a session environment connects.
+        variant :"agent.session.environment.connected", -> { OpenAI::Beta::AgentSessionEnvironmentConnectedEvent }
+
+        # Emitted when a session environment disconnects.
+        variant(
+          :"agent.session.environment.disconnected",
+          -> { OpenAI::Beta::AgentSessionEnvironmentDisconnectedEvent }
+        )
+
+        # Emitted when a session environment fails.
+        variant :"agent.session.environment.failed", -> { OpenAI::Beta::AgentSessionEnvironmentFailedEvent }
+
+        # Emitted when a subagent is created.
+        variant :"agent.session.subagent.created", -> { OpenAI::Beta::AgentSessionSubagentCreatedEvent }
+
+        # Emitted when a closed subagent successfully resumes.
+        variant :"agent.session.subagent.active", -> { OpenAI::Beta::AgentSessionSubagentActiveEvent }
+
+        # Emitted when a subagent is closed.
+        variant :"agent.session.subagent.closed", -> { OpenAI::Beta::AgentSessionSubagentClosedEvent }
+
+        # Emitted when an output item is complete.
+        variant :"agent.session.turn.item.done", -> { OpenAI::Beta::AgentSessionTurnItemDoneEvent }
+
+        # Emitted when an output text content part is added.
+        variant(
+          :"agent.session.turn.content_part.added",
+          -> { OpenAI::Beta::AgentSessionTurnContentPartAddedEvent }
+        )
+
+        # Emitted when an output content part is complete.
+        variant :"agent.session.turn.content_part.done", -> { OpenAI::Beta::AgentSessionTurnContentPartDoneEvent }
+
+        # Emitted when text is appended to an output text content part.
+        variant :"agent.session.turn.output_text.delta", -> { OpenAI::Beta::AgentSessionTurnOutputTextDeltaEvent }
+
+        # Emitted when an output text content part is complete.
+        variant :"agent.session.turn.output_text.done", -> { OpenAI::Beta::AgentSessionTurnOutputTextDoneEvent }
+
+        # Emitted when a reasoning summary content part is added.
+        variant(
+          :"agent.session.turn.reasoning_summary_part.added",
+          -> { OpenAI::Beta::AgentSessionTurnReasoningSummaryPartAddedEvent }
+        )
+
+        # Emitted when a reasoning summary part is complete.
+        variant(
+          :"agent.session.turn.reasoning_summary_part.done",
+          -> { OpenAI::Beta::AgentSessionTurnReasoningSummaryPartDoneEvent }
+        )
+
+        # Emitted when text is appended to a reasoning summary.
+        variant(
+          :"agent.session.turn.reasoning_summary_text.delta",
+          -> { OpenAI::Beta::AgentSessionTurnReasoningSummaryTextDeltaEvent }
+        )
+
+        # Emitted when a reasoning summary content part is complete.
+        variant(
+          :"agent.session.turn.reasoning_summary_text.done",
+          -> { OpenAI::Beta::AgentSessionTurnReasoningSummaryTextDoneEvent }
+        )
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::AgentSessionErrorEvent, OpenAI::Models::Beta::AgentSessionEnvironmentReadyEvent, OpenAI::Models::Beta::AgentOutputCommandExecutionOutputDeltaEvent, OpenAI::Models::Beta::AgentSessionCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnInProgressEvent, OpenAI::Models::Beta::AgentSessionTurnCompletedEvent, OpenAI::Models::Beta::AgentSessionTurnFailedEvent, OpenAI::Models::Beta::AgentSessionTurnCancelledEvent, OpenAI::Models::Beta::AgentSessionTurnItemAddedEvent, OpenAI::Models::Beta::AgentSessionIdleEvent, OpenAI::Models::Beta::AgentSessionInProgressEvent, OpenAI::Models::Beta::AgentSessionRequiresActionEvent, OpenAI::Models::Beta::AgentSessionFailedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentPendingEvent, OpenAI::Models::Beta::AgentSessionEnvironmentConnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentDisconnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentFailedEvent, OpenAI::Models::Beta::AgentSessionSubagentCreatedEvent, OpenAI::Models::Beta::AgentSessionSubagentActiveEvent, OpenAI::Models::Beta::AgentSessionSubagentClosedEvent, OpenAI::Models::Beta::AgentSessionTurnItemDoneEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDoneEvent)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session
+        #   The failed session.
+        #
+        #   @return [OpenAI::Models::Beta::AgentSession]
+        required :session, -> { OpenAI::Beta::AgentSession }
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.failed`.
+        #
+        #   @return [Symbol, :"agent.session.failed"]
+        required :type, const: :"agent.session.failed"
+
+        # @!method initialize(event_id:, session:, type: :"agent.session.failed")
+        #   Emitted when a session fails.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session [OpenAI::Models::Beta::AgentSession]
+        #     The failed session.
+        #
+        #   @param type [Symbol, :"agent.session.failed"]
+        #     The type of the object. Always `agent.session.failed`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionIdleEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session
+        #   The session that became idle.
+        #
+        #   @return [OpenAI::Models::Beta::AgentSession]
+        required :session, -> { OpenAI::Beta::AgentSession }
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.idle`.
+        #
+        #   @return [Symbol, :"agent.session.idle"]
+        required :type, const: :"agent.session.idle"
+
+        # @!method initialize(event_id:, session:, type: :"agent.session.idle")
+        #   Emitted when a session becomes idle.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session [OpenAI::Models::Beta::AgentSession]
+        #     The session that became idle.
+        #
+        #   @param type [Symbol, :"agent.session.idle"]
+        #     The type of the object. Always `agent.session.idle`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session
+        #   The session that started processing.
+        #
+        #   @return [OpenAI::Models::Beta::AgentSession]
+        required :session, -> { OpenAI::Beta::AgentSession }
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.in_progress`.
+        #
+        #   @return [Symbol, :"agent.session.in_progress"]
+        required :type, const: :"agent.session.in_progress"
+
+        # @!method initialize(event_id:, session:, type: :"agent.session.in_progress")
+        #   Emitted when a session starts processing a turn.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param session [OpenAI::Models::Beta::AgentSession]
+        #     The session that started processing.
+        #
+        #   @param type [Symbol, :"agent.session.in_progress"]
+        #     The type of the object. Always `agent.session.in_progress`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionInputMessageParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The content of the message.
+        #
+        #   @return [Array<OpenAI::Models::Beta::InputContentParam::InputText, OpenAI::Models::Beta::InputContentParam::InputImage>]
+        required :content, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::InputContentParam] }
+
+        # @!attribute role
+        #   The role of the message author. Always `user`.
+        #
+        #   @return [Symbol, :user]
+        required :role, const: :user
+
+        # @!attribute type
+        #   The type of the input item. Always `message`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentSessionInputMessageParam::Type, nil]
+        optional :type, enum: -> { OpenAI::Beta::AgentSessionInputMessageParam::Type }
+
+        # @!method initialize(content:, type: nil, role: :user)
+        #   A user message submitted to a session.
+        #
+        #   @param content [Array<OpenAI::Models::Beta::InputContentParam::InputText, OpenAI::Models::Beta::InputContentParam::InputImage>]
+        #     The content of the message.
+        #
+        #   @param type [Symbol, OpenAI::Models::Beta::AgentSessionInputMessageParam::Type]
+        #     The type of the input item. Always `message`.
+        #
+        #   @param role [Symbol, :user]
+        #     The role of the message author. Always `user`.
+
+        # The type of the input item. Always `message`.
+        #
+        # @see OpenAI::Models::Beta::AgentSessionInputMessageParam#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          MESSAGE = :message
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end