openai 0.89.0 → 0.91.0

data/lib/openai/models/beta/agents/session_create_params.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Sessions#create
+        #
+        # @see OpenAI::Resources::Beta::Agents::Sessions#create_streaming
+        class SessionCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute environment
+          #   An inline execution environment or a reference to an environment template.
+          #
+          #   @return [OpenAI::Models::Beta::EnvironmentParam::None, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted, OpenAI::Models::Beta::EnvironmentParam::SelfHosted]
+          required :environment, union: -> { OpenAI::Beta::EnvironmentParam }
+
+          # @!attribute agent
+          #   Agent configuration. With `agent_id`, supplied fields override the saved agent
+          #   for this session. Without `agent_id`, `model` is required.
+          #
+          #   @return [OpenAI::Models::Beta::Agents::SessionCreateParams::Agent, nil]
+          optional :agent, -> { OpenAI::Beta::Agents::SessionCreateParams::Agent }
+
+          # @!attribute agent_id
+          #   The ID of a saved reusable agent. Omit `agent` to use its configuration
+          #   unchanged.
+          #
+          #   @return [String, nil]
+          optional :agent_id, String
+
+          # @!attribute input
+          #   Initial input submitted when creating a session.
+          #
+          #   @return [String, Array<OpenAI::Models::Beta::AgentSessionInputMessageParam>, nil]
+          optional :input, union: -> { OpenAI::Beta::Agents::SessionCreateParams::Input }, nil?: true
+
+          # @!attribute metadata
+          #   Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+          #   characters. Omission or null defaults to an empty map.
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+          # @!attribute vault_ids
+          #   The IDs of vaults made available to the session.
+          #
+          #   @return [Array<String>, nil]
+          optional :vault_ids, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!method initialize(environment:, agent: nil, agent_id: nil, input: nil, metadata: nil, vault_ids: nil, request_options: {})
+          #   @param environment [OpenAI::Models::Beta::EnvironmentParam::None, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted, OpenAI::Models::Beta::EnvironmentParam::SelfHosted]
+          #     An inline execution environment or a reference to an environment template.
+          #
+          #   @param agent [OpenAI::Models::Beta::Agents::SessionCreateParams::Agent]
+          #     Agent configuration. With `agent_id`, supplied fields override the saved agent
+          #     for this session. Without `agent_id`, `model` is required.
+          #
+          #   @param agent_id [String]
+          #     The ID of a saved reusable agent. Omit `agent` to use its configuration
+          #     unchanged.
+          #
+          #   @param input [String, Array<OpenAI::Models::Beta::AgentSessionInputMessageParam>, nil]
+          #     Initial input submitted when creating a session.
+          #
+          #   @param metadata [Hash{Symbol=>String}, nil]
+          #     Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+          #     characters. Omission or null defaults to an empty map.
+          #
+          #   @param vault_ids [Array<String>, nil]
+          #     The IDs of vaults made available to the session.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          class Agent < OpenAI::Internal::Type::BaseModel
+            # @!attribute instructions
+            #   Additional instructions appended to the agent's default base instructions. Omit
+            #   to leave unchanged.
+            #
+            #   @return [String, nil]
+            optional :instructions, String, nil?: true
+
+            # @!attribute model
+            #   The model to use for the agent. The requested model name is preserved.
+            #
+            #   @return [String, nil]
+            optional :model, String
+
+            # @!attribute multi_agent
+            #   Explicit configuration for creating and coordinating subagents.
+            #
+            #   @return [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+            optional :multi_agent, -> { OpenAI::Beta::MultiAgentConfigParam }, nil?: true
+
+            # @!attribute reasoning
+            #   Reasoning configuration for the agent.
+            #
+            #   @return [OpenAI::Models::Beta::AgentReasoningParam, nil]
+            optional :reasoning, -> { OpenAI::Beta::AgentReasoningParam }, nil?: true
+
+            # @!attribute service_tier
+            #   The service tier used for model requests.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::Agents::SessionCreateParams::Agent::ServiceTier, nil]
+            optional(
+              :service_tier,
+              enum: -> { OpenAI::Beta::Agents::SessionCreateParams::Agent::ServiceTier },
+              nil?: true
+            )
+
+            # @!attribute text
+            #   Configuration for text generated by the agent.
+            #
+            #   @return [OpenAI::Models::Beta::AgentTextParam, nil]
+            optional :text, -> { OpenAI::Beta::AgentTextParam }, nil?: true
+
+            # @!attribute tools
+            #   Tools available to the agent. Omit to inherit, or pass null to clear them.
+            #
+            #   @return [Array<OpenAI::Models::Beta::AgentToolParam::Function, OpenAI::Models::Beta::AgentToolParam::ToolSearch, OpenAI::Models::Beta::AgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentToolParam::Mcp, OpenAI::Models::Beta::AgentToolParam::WebSearch>, nil]
+            optional(
+              :tools,
+              -> {
+                OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentToolParam]
+              },
+              nil?: true
+            )
+
+            # @!method initialize(instructions: nil, model: nil, multi_agent: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil)
+            #   Agent configuration. With `agent_id`, supplied fields override the saved agent
+            #   for this session. Without `agent_id`, `model` is required.
+            #
+            #   @param instructions [String, nil]
+            #     Additional instructions appended to the agent's default base instructions. Omit
+            #     to leave unchanged.
+            #
+            #   @param model [String]
+            #     The model to use for the agent. The requested model name is preserved.
+            #
+            #   @param multi_agent [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+            #     Explicit configuration for creating and coordinating subagents.
+            #
+            #   @param reasoning [OpenAI::Models::Beta::AgentReasoningParam, nil]
+            #     Reasoning configuration for the agent.
+            #
+            #   @param service_tier [Symbol, OpenAI::Models::Beta::Agents::SessionCreateParams::Agent::ServiceTier, nil]
+            #     The service tier used for model requests.
+            #
+            #   @param text [OpenAI::Models::Beta::AgentTextParam, nil]
+            #     Configuration for text generated by the agent.
+            #
+            #   @param tools [Array<OpenAI::Models::Beta::AgentToolParam::Function, OpenAI::Models::Beta::AgentToolParam::ToolSearch, OpenAI::Models::Beta::AgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentToolParam::Mcp, OpenAI::Models::Beta::AgentToolParam::WebSearch>, nil]
+            #     Tools available to the agent. Omit to inherit, or pass null to clear them.
+
+            # The service tier used for model requests.
+            #
+            # @see OpenAI::Models::Beta::Agents::SessionCreateParams::Agent#service_tier
+            module ServiceTier
+              extend OpenAI::Internal::Type::Enum
+
+              # Selects the service tier automatically.
+              AUTO = :auto
+
+              # Uses the default service tier.
+              DEFAULT = :default
+
+              # Uses the flex service tier.
+              FLEX = :flex
+
+              # Uses the priority service tier.
+              PRIORITY = :priority
+
+              # Uses the fast service tier.
+              FAST = :fast
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # Initial input submitted when creating a session.
+          module Input
+            extend OpenAI::Internal::Type::Union
+
+            variant String
+
+            variant -> { OpenAI::Models::Beta::Agents::SessionCreateParams::Input::AgentSessionInputMessageParamArray }
+
+            # @!method self.variants
+            #   @return [Array(String, Array<OpenAI::Models::Beta::AgentSessionInputMessageParam>)]
+
+            # @type [OpenAI::Internal::Type::Converter]
+            AgentSessionInputMessageParamArray = OpenAI::Internal::Type::ArrayOf[
+              -> { OpenAI::Beta::AgentSessionInputMessageParam }
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/session_delete_params.rb

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

data/lib/openai/models/beta/agents/session_list_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Sessions#list
+        class SessionListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute after
+          #   Return resources after this resource ID in the selected order.
+          #
+          #   @return [String, nil]
+          optional :after, String
+
+          # @!attribute agent_id
+          #   Only return sessions whose root agent has this ID. Omit to return sessions for
+          #   all agents.
+          #
+          #   @return [String, nil]
+          optional :agent_id, String
+
+          # @!attribute limit
+          #   The maximum number of resources to return.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer, nil?: true
+
+          # @!attribute order
+          #   Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          #   `desc` for descending order. Defaults to `desc`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::Agents::SessionListParams::Order, nil]
+          optional :order, enum: -> { OpenAI::Beta::Agents::SessionListParams::Order }
+
+          # @!method initialize(after: nil, agent_id: nil, limit: nil, order: nil, request_options: {})
+          #   @param after [String]
+          #     Return resources after this resource ID in the selected order.
+          #
+          #   @param agent_id [String]
+          #     Only return sessions whose root agent has this ID. Omit to return sessions for
+          #     all agents.
+          #
+          #   @param limit [Integer, nil]
+          #     The maximum number of resources to return.
+          #
+          #   @param order [Symbol, OpenAI::Models::Beta::Agents::SessionListParams::Order]
+          #     Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          #     `desc` for descending order. Defaults to `desc`.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          # `desc` for descending order. 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

data/lib/openai/models/beta/agents/session_retrieve_params.rb

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

data/lib/openai/models/beta/agents/session_update_params.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Sessions#update
+        class SessionUpdateParams < 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 agent
+          #   Model settings for subsequent turns. Omitted fields stay unchanged.
+          #
+          #   @return [OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent, nil]
+          optional :agent, -> { OpenAI::Beta::Agents::SessionUpdateParams::Agent }
+
+          # @!attribute metadata
+          #   Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
+          #   Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+          #   characters.
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+          # @!method initialize(session_id:, agent: nil, metadata: nil, request_options: {})
+          #   @param session_id [String]
+          #
+          #   @param agent [OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent]
+          #     Model settings for subsequent turns. Omitted fields stay unchanged.
+          #
+          #   @param metadata [Hash{Symbol=>String}, nil]
+          #     Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
+          #     Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+          #     characters.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          class Agent < OpenAI::Internal::Type::BaseModel
+            # @!attribute model
+            #   The model for subsequent turns. Omit to keep the current model.
+            #
+            #   @return [String, nil]
+            optional :model, String
+
+            # @!attribute reasoning
+            #   Reasoning settings to update. Omit to keep the current effort.
+            #
+            #   @return [OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::Reasoning, nil]
+            optional :reasoning, -> { OpenAI::Beta::Agents::SessionUpdateParams::Agent::Reasoning }
+
+            # @!attribute service_tier
+            #   The service tier used for model requests.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::ServiceTier, nil]
+            optional(
+              :service_tier,
+              enum: -> { OpenAI::Beta::Agents::SessionUpdateParams::Agent::ServiceTier },
+              nil?: true
+            )
+
+            # @!method initialize(model: nil, reasoning: nil, service_tier: nil)
+            #   Model settings for subsequent turns. Omitted fields stay unchanged.
+            #
+            #   @param model [String]
+            #     The model for subsequent turns. Omit to keep the current model.
+            #
+            #   @param reasoning [OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::Reasoning]
+            #     Reasoning settings to update. Omit to keep the current effort.
+            #
+            #   @param service_tier [Symbol, OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::ServiceTier, nil]
+            #     The service tier used for model requests.
+
+            # @see OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent#reasoning
+            class Reasoning < OpenAI::Internal::Type::BaseModel
+              # @!attribute effort
+              #   The amount of reasoning effort the model should use.
+              #
+              #   @return [Symbol, OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::Reasoning::Effort, nil]
+              optional(
+                :effort,
+                enum: -> { OpenAI::Beta::Agents::SessionUpdateParams::Agent::Reasoning::Effort },
+                nil?: true
+              )
+
+              # @!method initialize(effort: nil)
+              #   Reasoning settings to update. Omit to keep the current effort.
+              #
+              #   @param effort [Symbol, OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::Reasoning::Effort, nil]
+              #     The amount of reasoning effort the model should use.
+
+              # The amount of reasoning effort the model should use.
+              #
+              # @see OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::Reasoning#effort
+              module Effort
+                extend OpenAI::Internal::Type::Enum
+
+                NONE = :none
+                MINIMAL = :minimal
+                LOW = :low
+                MEDIUM = :medium
+                HIGH = :high
+                XHIGH = :xhigh
+                MAX = :max
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # The service tier used for model requests.
+            #
+            # @see OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent#service_tier
+            module ServiceTier
+              extend OpenAI::Internal::Type::Enum
+
+              # Selects the service tier automatically.
+              AUTO = :auto
+
+              # Uses the default service tier.
+              DEFAULT = :default
+
+              # Uses the flex service tier.
+              FLEX = :flex
+
+              # Uses the priority service tier.
+              PRIORITY = :priority
+
+              # Uses the fast service tier.
+              FAST = :fast
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/artifact_content_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::Artifacts#content
+          class ArtifactContentParams < 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 artifact_id
+            #
+            #   @return [String]
+            required :artifact_id, String
+
+            # @!method initialize(session_id:, artifact_id:, request_options: {})
+            #   @param session_id [String]
+            #   @param artifact_id [String]
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/artifact_delete_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::Artifacts#delete
+          class ArtifactDeleteParams < 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 artifact_id
+            #
+            #   @return [String]
+            required :artifact_id, String
+
+            # @!method initialize(session_id:, artifact_id:, request_options: {})
+            #   @param session_id [String]
+            #   @param artifact_id [String]
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Artifacts#list
+          class ArtifactListParams < 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 artifacts after this immutable artifact ID.
+            #
+            #   @return [String, nil]
+            optional :after, String, nil?: true
+
+            # @!attribute environment_id
+            #   Restrict the listing to artifacts produced by this environment.
+            #
+            #   @return [String, nil]
+            optional :environment_id, String, nil?: true
+
+            # @!attribute limit
+            #   The maximum number of artifacts to return, between 1 and 100.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer, nil?: true
+
+            # @!attribute order
+            #   Sort by creation time and ID. Defaults to descending.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::Order, nil]
+            optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::ArtifactListParams::Order }
+
+            # @!method initialize(session_id:, after: nil, environment_id: nil, limit: nil, order: nil, request_options: {})
+            #   @param session_id [String]
+            #
+            #   @param after [String, nil]
+            #     Return artifacts after this immutable artifact ID.
+            #
+            #   @param environment_id [String, nil]
+            #     Restrict the listing to artifacts produced by this environment.
+            #
+            #   @param limit [Integer, nil]
+            #     The maximum number of artifacts to return, between 1 and 100.
+            #
+            #   @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::Order]
+            #     Sort by creation time and ID. Defaults to descending.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # Sort by creation time and ID. Defaults to descending.
+            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/artifact_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::Artifacts#retrieve
+          class ArtifactRetrieveParams < 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 artifact_id
+            #
+            #   @return [String]
+            required :artifact_id, String
+
+            # @!method initialize(session_id:, artifact_id:, request_options: {})
+            #   @param session_id [String]
+            #   @param artifact_id [String]
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end