openai 0.89.0 → 0.90.0

data/lib/openai/models/beta/agents/sessions/session_artifact.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Artifacts#retrieve
+          class SessionArtifact < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The immutable artifact ID.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   The Unix timestamp, in seconds, when the artifact was published.
+            #
+            #   @return [Integer]
+            required :created_at, Integer
+
+            # @!attribute environment_id
+            #   The ID of the environment that produced the artifact.
+            #
+            #   @return [String]
+            required :environment_id, String
+
+            # @!attribute object
+            #   The object type. Always `agent.session.artifact`.
+            #
+            #   @return [Symbol, :"agent.session.artifact"]
+            required :object, const: :"agent.session.artifact"
+
+            # @!attribute path
+            #   The original absolute file path in the execution environment.
+            #
+            #   @return [String]
+            required :path, String
+
+            # @!attribute session_id
+            #   The ID of the session that owns the artifact.
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!attribute size_bytes
+            #   The immutable artifact size in bytes.
+            #
+            #   @return [Integer]
+            required :size_bytes, Integer
+
+            # @!attribute turn_id
+            #   The ID of the completed turn that published the artifact.
+            #
+            #   @return [String]
+            required :turn_id, String
+
+            # @!method initialize(id:, created_at:, environment_id:, path:, session_id:, size_bytes:, turn_id:, object: :"agent.session.artifact")
+            #   An immutable file published by a completed hosted session turn.
+            #
+            #   @param id [String]
+            #     The immutable artifact ID.
+            #
+            #   @param created_at [Integer]
+            #     The Unix timestamp, in seconds, when the artifact was published.
+            #
+            #   @param environment_id [String]
+            #     The ID of the environment that produced the artifact.
+            #
+            #   @param path [String]
+            #     The original absolute file path in the execution environment.
+            #
+            #   @param session_id [String]
+            #     The ID of the session that owns the artifact.
+            #
+            #   @param size_bytes [Integer]
+            #     The immutable artifact size in bytes.
+            #
+            #   @param turn_id [String]
+            #     The ID of the completed turn that published the artifact.
+            #
+            #   @param object [Symbol, :"agent.session.artifact"]
+            #     The object type. Always `agent.session.artifact`.
+          end
+        end
+
+        SessionArtifact = Sessions::SessionArtifact
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/session_artifact_deleted.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Artifacts#delete
+          class SessionArtifactDeleted < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The ID of the deleted session artifact.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute deleted
+            #   Whether the session artifact was deleted. Always `true`.
+            #
+            #   @return [Boolean]
+            required :deleted, OpenAI::Internal::Type::Boolean
+
+            # @!attribute object
+            #   The object type. Always `agent.session.artifact.deleted`.
+            #
+            #   @return [Symbol, :"agent.session.artifact.deleted"]
+            required :object, const: :"agent.session.artifact.deleted"
+
+            # @!method initialize(id:, deleted:, object: :"agent.session.artifact.deleted")
+            #   Confirmation that an immutable session artifact was deleted.
+            #
+            #   @param id [String]
+            #     The ID of the deleted session artifact.
+            #
+            #   @param deleted [Boolean]
+            #     Whether the session artifact was deleted. Always `true`.
+            #
+            #   @param object [Symbol, :"agent.session.artifact.deleted"]
+            #     The object type. Always `agent.session.artifact.deleted`.
+          end
+        end
+
+        SessionArtifactDeleted = Sessions::SessionArtifactDeleted
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/subagent_list_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Subagents#list
+          class SubagentListParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute session_id
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!attribute after
+            #   Return resources after this resource ID in the selected order.
+            #
+            #   @return [String, nil]
+            optional :after, String
+
+            # @!attribute limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute order
+            #   The order in which resources are returned. Defaults to `desc`.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::SubagentListParams::Order, nil]
+            optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::SubagentListParams::Order }
+
+            # @!method initialize(session_id:, after: nil, limit: nil, order: nil, request_options: {})
+            #   @param session_id [String]
+            #
+            #   @param after [String]
+            #     Return resources after this resource ID in the selected order.
+            #
+            #   @param limit [Integer]
+            #     The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            #
+            #   @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::SubagentListParams::Order]
+            #     The order in which resources are returned. Defaults to `desc`.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # The order in which resources are returned. Defaults to `desc`.
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              # Returns resources in ascending order.
+              ASC = :asc
+
+              # Returns resources in descending order.
+              DESC = :desc
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/subagent_retrieve_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Subagents#retrieve
+          class SubagentRetrieveParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute session_id
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!attribute subagent_id
+            #
+            #   @return [String]
+            required :subagent_id, String
+
+            # @!method initialize(session_id:, subagent_id:, request_options: {})
+            #   @param session_id [String]
+            #   @param subagent_id [String]
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/subagents/item_list_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          module Subagents
+            # @see OpenAI::Resources::Beta::Agents::Sessions::Subagents::Items#list
+            class ItemListParams < OpenAI::Internal::Type::BaseModel
+              extend OpenAI::Internal::Type::RequestParameters::Converter
+              include OpenAI::Internal::Type::RequestParameters
+
+              # @!attribute session_id
+              #
+              #   @return [String]
+              required :session_id, String
+
+              # @!attribute subagent_id
+              #
+              #   @return [String]
+              required :subagent_id, String
+
+              # @!attribute after
+              #   Return resources after this resource ID in the selected order.
+              #
+              #   @return [String, nil]
+              optional :after, String
+
+              # @!attribute limit
+              #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              #
+              #   @return [Integer, nil]
+              optional :limit, Integer
+
+              # @!attribute order
+              #   The order in which resources are returned. Defaults to `desc`.
+              #
+              #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::ItemListParams::Order, nil]
+              optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::Subagents::ItemListParams::Order }
+
+              # @!method initialize(session_id:, subagent_id:, after: nil, limit: nil, order: nil, request_options: {})
+              #   @param session_id [String]
+              #
+              #   @param subagent_id [String]
+              #
+              #   @param after [String]
+              #     Return resources after this resource ID in the selected order.
+              #
+              #   @param limit [Integer]
+              #     The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              #
+              #   @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::ItemListParams::Order]
+              #     The order in which resources are returned. Defaults to `desc`.
+              #
+              #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+              # The order in which resources are returned. Defaults to `desc`.
+              module Order
+                extend OpenAI::Internal::Type::Enum
+
+                # Returns resources in ascending order.
+                ASC = :asc
+
+                # Returns resources in descending order.
+                DESC = :desc
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/subagents/turn_list_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          module Subagents
+            # @see OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns#list
+            class TurnListParams < OpenAI::Internal::Type::BaseModel
+              extend OpenAI::Internal::Type::RequestParameters::Converter
+              include OpenAI::Internal::Type::RequestParameters
+
+              # @!attribute session_id
+              #
+              #   @return [String]
+              required :session_id, String
+
+              # @!attribute subagent_id
+              #
+              #   @return [String]
+              required :subagent_id, String
+
+              # @!attribute after
+              #   Return resources after this resource ID in the selected order.
+              #
+              #   @return [String, nil]
+              optional :after, String
+
+              # @!attribute limit
+              #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              #
+              #   @return [Integer, nil]
+              optional :limit, Integer
+
+              # @!attribute order
+              #   The order in which resources are returned. Defaults to `desc`.
+              #
+              #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::TurnListParams::Order, nil]
+              optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::Subagents::TurnListParams::Order }
+
+              # @!method initialize(session_id:, subagent_id:, after: nil, limit: nil, order: nil, request_options: {})
+              #   @param session_id [String]
+              #
+              #   @param subagent_id [String]
+              #
+              #   @param after [String]
+              #     Return resources after this resource ID in the selected order.
+              #
+              #   @param limit [Integer]
+              #     The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              #
+              #   @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::TurnListParams::Order]
+              #     The order in which resources are returned. Defaults to `desc`.
+              #
+              #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+              # The order in which resources are returned. Defaults to `desc`.
+              module Order
+                extend OpenAI::Internal::Type::Enum
+
+                # Returns resources in ascending order.
+                ASC = :asc
+
+                # Returns resources in descending order.
+                DESC = :desc
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/subagents/turn_retrieve_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          module Subagents
+            # @see OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns#retrieve
+            class TurnRetrieveParams < OpenAI::Internal::Type::BaseModel
+              extend OpenAI::Internal::Type::RequestParameters::Converter
+              include OpenAI::Internal::Type::RequestParameters
+
+              # @!attribute session_id
+              #
+              #   @return [String]
+              required :session_id, String
+
+              # @!attribute subagent_id
+              #
+              #   @return [String]
+              required :subagent_id, String
+
+              # @!attribute turn_id
+              #
+              #   @return [String]
+              required :turn_id, String
+
+              # @!method initialize(session_id:, subagent_id:, turn_id:, request_options: {})
+              #   @param session_id [String]
+              #   @param subagent_id [String]
+              #   @param turn_id [String]
+              #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/subagents/turns/item_list_params.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          module Subagents
+            module Turns
+              # @see OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns::Items#list
+              class ItemListParams < OpenAI::Internal::Type::BaseModel
+                extend OpenAI::Internal::Type::RequestParameters::Converter
+                include OpenAI::Internal::Type::RequestParameters
+
+                # @!attribute session_id
+                #
+                #   @return [String]
+                required :session_id, String
+
+                # @!attribute subagent_id
+                #
+                #   @return [String]
+                required :subagent_id, String
+
+                # @!attribute turn_id
+                #
+                #   @return [String]
+                required :turn_id, String
+
+                # @!attribute after
+                #   Return resources after this resource ID in the selected order.
+                #
+                #   @return [String, nil]
+                optional :after, String
+
+                # @!attribute limit
+                #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+                #
+                #   @return [Integer, nil]
+                optional :limit, Integer
+
+                # @!attribute order
+                #   The order in which resources are returned. Defaults to `desc`.
+                #
+                #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::Turns::ItemListParams::Order, nil]
+                optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::Subagents::Turns::ItemListParams::Order }
+
+                # @!method initialize(session_id:, subagent_id:, turn_id:, after: nil, limit: nil, order: nil, request_options: {})
+                #   @param session_id [String]
+                #
+                #   @param subagent_id [String]
+                #
+                #   @param turn_id [String]
+                #
+                #   @param after [String]
+                #     Return resources after this resource ID in the selected order.
+                #
+                #   @param limit [Integer]
+                #     The maximum number of resources to return, between 1 and 100. Defaults to 20.
+                #
+                #   @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::Turns::ItemListParams::Order]
+                #     The order in which resources are returned. Defaults to `desc`.
+                #
+                #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+                # The order in which resources are returned. Defaults to `desc`.
+                module Order
+                  extend OpenAI::Internal::Type::Enum
+
+                  # Returns resources in ascending order.
+                  ASC = :asc
+
+                  # Returns resources in descending order.
+                  DESC = :desc
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/turn.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Turns#retrieve
+          class Turn < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The ID of the turn.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute agent_id
+            #   The ID of the agent that ran the turn.
+            #
+            #   @return [String]
+            required :agent_id, String
+
+            # @!attribute completed_at
+            #   The Unix timestamp, in seconds, when the turn reached a terminal state.
+            #
+            #   @return [Integer, nil]
+            required :completed_at, Integer, nil?: true
+
+            # @!attribute created_at
+            #   The Unix timestamp, in seconds, used to order the turn by creation time.
+            #   Subagent turns use their start time, falling back to completion time or the
+            #   subagent opening time when the preceding timestamps are unavailable.
+            #
+            #   @return [Integer]
+            required :created_at, Integer
+
+            # @!attribute error
+            #   A customer-safe error describing why a session request failed.
+            #
+            #   @return [OpenAI::Models::Beta::SessionTurnError, nil]
+            required :error, -> { OpenAI::Beta::SessionTurnError }, nil?: true
+
+            # @!attribute object
+            #   The object type. Always `agent.session.turn`.
+            #
+            #   @return [Symbol, :"agent.session.turn"]
+            required :object, const: :"agent.session.turn"
+
+            # @!attribute session_id
+            #   The ID of the session that owns the turn.
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!attribute started_at
+            #   The Unix timestamp, in seconds, when the turn started.
+            #
+            #   @return [Integer, nil]
+            required :started_at, Integer, nil?: true
+
+            # @!attribute status
+            #   The current status of the turn.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::Turn::Status]
+            required :status, enum: -> { OpenAI::Beta::Agents::Sessions::Turn::Status }
+
+            # @!attribute subagent_id
+            #   The ID of the subagent that ran the turn, if applicable.
+            #
+            #   @return [String, nil]
+            required :subagent_id, String, nil?: true
+
+            # @!attribute usage
+            #   Recorded token usage for a session or turn. Usage is best effort and may change.
+            #
+            #   @return [OpenAI::Models::Beta::TokenUsage, nil]
+            required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
+
+            # @!method initialize(id:, agent_id:, completed_at:, created_at:, error:, session_id:, started_at:, status:, subagent_id:, usage:, object: :"agent.session.turn")
+            #   The canonical public representation of a session turn.
+            #
+            #   @param id [String]
+            #     The ID of the turn.
+            #
+            #   @param agent_id [String]
+            #     The ID of the agent that ran the turn.
+            #
+            #   @param completed_at [Integer, nil]
+            #     The Unix timestamp, in seconds, when the turn reached a terminal state.
+            #
+            #   @param created_at [Integer]
+            #     The Unix timestamp, in seconds, used to order the turn by creation time.
+            #     Subagent turns use their start time, falling back to completion time or the
+            #     subagent opening time when the preceding timestamps are unavailable.
+            #
+            #   @param error [OpenAI::Models::Beta::SessionTurnError, nil]
+            #     A customer-safe error describing why a session request failed.
+            #
+            #   @param session_id [String]
+            #     The ID of the session that owns the turn.
+            #
+            #   @param started_at [Integer, nil]
+            #     The Unix timestamp, in seconds, when the turn started.
+            #
+            #   @param status [Symbol, OpenAI::Models::Beta::Agents::Sessions::Turn::Status]
+            #     The current status of the turn.
+            #
+            #   @param subagent_id [String, nil]
+            #     The ID of the subagent that ran the turn, if applicable.
+            #
+            #   @param usage [OpenAI::Models::Beta::TokenUsage, nil]
+            #     Recorded token usage for a session or turn. Usage is best effort and may change.
+            #
+            #   @param object [Symbol, :"agent.session.turn"]
+            #     The object type. Always `agent.session.turn`.
+
+            # The current status of the turn.
+            #
+            # @see OpenAI::Models::Beta::Agents::Sessions::Turn#status
+            module Status
+              extend OpenAI::Internal::Type::Enum
+
+              # The turn is waiting to start.
+              QUEUED = :queued
+
+              # The turn is in progress.
+              IN_PROGRESS = :in_progress
+
+              # The turn is waiting for external input.
+              WAITING = :waiting
+
+              # The turn completed successfully.
+              COMPLETED = :completed
+
+              # The turn failed.
+              FAILED = :failed
+
+              # The turn was cancelled.
+              CANCELLED = :cancelled
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end