openai 0.89.0 → 0.90.0

data/rbi/openai/resources/beta/agents.rbi

@@ -0,0 +1,180 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        sig { returns(OpenAI::Resources::Beta::Agents::Environments) }
+        attr_reader :environments
+
+        sig { returns(OpenAI::Resources::Beta::Agents::Vaults) }
+        attr_reader :vaults
+
+        sig { returns(OpenAI::Resources::Beta::Agents::Sessions) }
+        attr_reader :sessions
+
+        # Creates a reusable agent without storing credentials. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        sig {
+          params(
+            model: String,
+            instructions: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            multi_agent: T.nilable(OpenAI::Beta::MultiAgentConfigParam::OrHash),
+            name: T.nilable(String),
+            reasoning: T.nilable(OpenAI::Beta::AgentReasoningParam::OrHash),
+            service_tier: T.nilable(OpenAI::Beta::AgentCreateParams::ServiceTier::OrSymbol),
+            text: T.nilable(OpenAI::Beta::AgentTextParam::OrHash),
+            tools: T.nilable(
+              T::Array[
+                T.any(
+                  OpenAI::Beta::PersistedAgentToolParam::Function::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::ToolSearch::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::Mcp::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::WebSearch::OrHash
+                )
+              ]
+            ),
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(OpenAI::Beta::Agent)
+        }
+        def create(
+          # The model to use for the agent. The requested model name is preserved.
+          model:,
+          # Additional instructions appended to the agent's default base instructions. Omit
+          # or set to null to add no custom instructions.
+          instructions: 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.
+          metadata: nil,
+          # Explicit configuration for creating and coordinating subagents.
+          multi_agent: nil,
+          # A human-readable name for the agent. Omission or null leaves the agent unnamed.
+          name: nil,
+          # Reasoning configuration for the agent.
+          reasoning: nil,
+          # The service tier used for model requests.
+          service_tier: nil,
+          # Configuration for text generated by the agent.
+          text: nil,
+          # Tools available to the agent. Defaults to an empty list.
+          tools: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a reusable agent by ID. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        sig { params(agent_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(OpenAI::Beta::Agent) }
+        def retrieve(
+          # The ID of the reusable agent.
+          agent_id,
+          request_options: {}
+        )
+        end
+
+        # Updates a reusable agent. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        sig {
+          params(
+            agent_id: String,
+            instructions: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            model: String,
+            multi_agent: T.nilable(OpenAI::Beta::MultiAgentConfigParam::OrHash),
+            name: T.nilable(String),
+            reasoning: T.nilable(OpenAI::Beta::AgentReasoningParam::OrHash),
+            service_tier: T.nilable(OpenAI::Beta::AgentUpdateParams::ServiceTier::OrSymbol),
+            text: T.nilable(OpenAI::Beta::AgentTextParam::OrHash),
+            tools: T.nilable(
+              T::Array[
+                T.any(
+                  OpenAI::Beta::PersistedAgentToolParam::Function::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::ToolSearch::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::Mcp::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::WebSearch::OrHash
+                )
+              ]
+            ),
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(OpenAI::Beta::Agent)
+        }
+        def update(
+          # The ID of the reusable agent.
+          agent_id,
+          # Additional instructions appended to the agent's default base instructions. Omit
+          # to leave unchanged.
+          instructions: 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.
+          metadata: nil,
+          # The model to use for the agent. The requested model name is preserved.
+          model: nil,
+          # Explicit configuration for creating and coordinating subagents.
+          multi_agent: nil,
+          # A replacement name. Omit to leave unchanged, or pass null to clear it.
+          name: nil,
+          # Reasoning configuration for the agent.
+          reasoning: nil,
+          # The service tier used for model requests.
+          service_tier: nil,
+          # Configuration for text generated by the agent.
+          text: nil,
+          # Tools available to the agent.
+          tools: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists reusable agents in the current project. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        sig {
+          params(
+            after: String,
+            limit: T.nilable(Integer),
+            order: OpenAI::Beta::AgentListParams::Order::OrSymbol,
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agent])
+        }
+        def list(
+          # Return resources after this resource ID in the selected order.
+          after: nil,
+          # The maximum number of resources to return.
+          limit: nil,
+          # The order in which resources are returned. Defaults to `desc`.
+          order: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes a reusable agent. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        sig {
+          params(agent_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(OpenAI::Beta::AgentDeleted)
+        }
+        def delete(
+          # The ID of the reusable agent.
+          agent_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta.rbi

@@ -5,6 +5,9 @@ module OpenAI
 
     class Beta
 
+      sig { returns(OpenAI::Resources::Beta::Agents) }
+      attr_reader :agents
+
       sig { returns(OpenAI::Resources::Beta::Responses) }
       attr_reader :responses
 

data/rbi/openai/resources/live/sessions.rbi

@@ -7,7 +7,11 @@ module OpenAI
 
       class Sessions
 
-        # Accept an incoming SIP call with Live startup configuration.
+        # Accept an incoming SIP call. Supply session with type live, the model, and
+        # startup configuration. Before accepting calls, follow the
+        # [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting)
+        # to write frontend conversation instructions and a separate backend prompt. SIP
+        # media format is negotiated; omit audio.format.
         sig {
           params(
             session_id: String,
@@ -63,7 +67,7 @@ module OpenAI
         )
         end
 
-        # Hang up a Live session.
+        # End a SIP call identified by session_id.
         sig { params(session_id: String, request_options: OpenAI::RequestOptions::OrHash).void }
         def hangup(
           # Opaque Live session identifier from the creation response or incoming-call
@@ -73,7 +77,8 @@ module OpenAI
         )
         end
 
-        # Transfer a Live SIP call to another destination.
+        # Transfer a SIP call to another destination. Supply a nonblank target_uri for the
+        # SIP Refer-To header.
         sig { params(session_id: String, target_uri: String, request_options: OpenAI::RequestOptions::OrHash).void }
         def refer(
           # Opaque Live session identifier from the creation response or incoming-call
@@ -86,7 +91,8 @@ module OpenAI
         )
         end
 
-        # Reject an incoming SIP call.
+        # Reject an incoming SIP call. Send a required SIP rejection status_code between
+        # 300 and 699.
         sig { params(session_id: String, status_code: Integer, request_options: OpenAI::RequestOptions::OrHash).void }
         def reject(
           # Opaque Live session identifier from the creation response or incoming-call

data/rbi/openai/resources/responses.rbi

@@ -630,15 +630,15 @@ module OpenAI
       # See {OpenAI::Resources::Responses#create} for non-streaming counterpart.
       #
       # Creates a model response. Provide
-      # [text](https://platform.openai.com/docs/guides/text) or
-      # [image](https://platform.openai.com/docs/guides/images) inputs to generate
-      # [text](https://platform.openai.com/docs/guides/text) or
-      # [JSON](https://platform.openai.com/docs/guides/structured-outputs) outputs. Have
+      # [text](https://developers.openai.com/api/docs/guides/text) or
+      # [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to generate
+      # [text](https://developers.openai.com/api/docs/guides/text) or
+      # [JSON](https://developers.openai.com/api/docs/guides/structured-outputs) outputs. Have
       # the model call your own
-      # [custom code](https://platform.openai.com/docs/guides/function-calling) or use
-      # built-in [tools](https://platform.openai.com/docs/guides/tools) like
-      # [web search](https://platform.openai.com/docs/guides/tools-web-search) or
-      # [file search](https://platform.openai.com/docs/guides/tools-file-search) to use
+      # [custom code](https://developers.openai.com/api/docs/guides/function-calling) or use
+      # built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
+      # [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
+      # [file search](https://developers.openai.com/api/docs/guides/tools-file-search) to use
       # your own data as input for the model's response.
       sig do
         params(

data/sig/openai/helpers/agents.rbs

@@ -0,0 +1,50 @@
+module OpenAI
+  module Helpers
+    module Agents
+      type tool_output =
+        String
+        | Hash[String | Symbol, untyped]
+        | Array[OpenAI::Models::Beta::input_content_param
+        | Hash[Symbol, untyped]]
+        | nil
+      type tool_handler = ^(Hash[String, untyped]) -> tool_output
+      class SessionStream
+        include Enumerable[OpenAI::Models::Beta::agent_session_event]
+
+        def each:
+          { (OpenAI::Models::Beta::agent_session_event) -> void } -> self
+          | -> Enumerator[OpenAI::Models::Beta::agent_session_event, self]
+        def close: -> void
+        def until_done: -> self
+      end
+    end
+  end
+  module Resources
+    class Beta
+      class Agents
+        class Sessions
+          def stream: (
+            String session_id,
+            input: String
+            | Array[OpenAI::Beta::AgentSessionInputMessageParam
+            | Hash[Symbol, untyped]],
+            ?tool_handlers: Hash[String, OpenAI::Helpers::Agents::tool_handler],
+            ?idempotency_key: String?,
+            ?request_options: OpenAI::RequestOptions
+            | Hash[Symbol, untyped]
+            | nil
+          ) ?{
+            (OpenAI::Helpers::Agents::SessionStream) -> void
+          } -> OpenAI::Helpers::Agents::SessionStream
+        end
+      end
+    end
+  end
+  module Models
+    module Beta
+      class AgentSessionMessage
+        def output_text: -> String
+      end
+    end
+  end
+end

data/sig/openai/internal/token_page.rbs

@@ -0,0 +1,15 @@
+module OpenAI
+  module Internal
+    class TokenPage[Elem]
+      include OpenAI::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor has_more: bool
+
+      attr_accessor next_: String?
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/openai/models/beta/agent.rbs

@@ -0,0 +1,96 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent =
+        {
+          id: String,
+          created_at: Integer,
+          instructions: String?,
+          metadata: ::Hash[Symbol, String],
+          model: String,
+          multi_agent: OpenAI::Beta::MultiAgentConfig,
+          name: String?,
+          ?object: :agent,
+          reasoning: OpenAI::Beta::AgentReasoning,
+          service_tier: OpenAI::Models::Beta::Agent::service_tier,
+          text: OpenAI::Beta::AgentText,
+          tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool],
+          updated_at: Integer
+        }
+
+      class Agent < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Integer
+
+        attr_accessor instructions: String?
+
+        attr_accessor metadata: ::Hash[Symbol, String]
+
+        attr_accessor model: String
+
+        attr_accessor multi_agent: OpenAI::Beta::MultiAgentConfig
+
+        attr_accessor name: String?
+
+        attr_accessor object: :agent
+
+        attr_accessor reasoning: OpenAI::Beta::AgentReasoning
+
+        attr_accessor service_tier: OpenAI::Models::Beta::Agent::service_tier
+
+        attr_accessor text: OpenAI::Beta::AgentText
+
+        attr_accessor tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool]
+
+        attr_accessor updated_at: Integer
+
+        def initialize: (
+          id: String,
+          created_at: Integer,
+          instructions: String?,
+          metadata: ::Hash[Symbol, String],
+          model: String,
+          multi_agent: OpenAI::Beta::MultiAgentConfig,
+          name: String?,
+          reasoning: OpenAI::Beta::AgentReasoning,
+          service_tier: OpenAI::Models::Beta::Agent::service_tier,
+          text: OpenAI::Beta::AgentText,
+          tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool],
+          updated_at: Integer,
+          ?object: :agent
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Integer,
+          instructions: String?,
+          metadata: ::Hash[Symbol, String],
+          model: String,
+          multi_agent: OpenAI::Beta::MultiAgentConfig,
+          name: String?,
+          ?object: :agent,
+          reasoning: OpenAI::Beta::AgentReasoning,
+          service_tier: OpenAI::Models::Beta::Agent::service_tier,
+          text: OpenAI::Beta::AgentText,
+          tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool],
+          updated_at: Integer
+        }
+
+        type service_tier = :auto | :default | :flex | :priority | :fast
+
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO: :auto
+          DEFAULT: :default
+          FLEX: :flex
+          PRIORITY: :priority
+          FAST: :fast
+
+          def self?.values: -> ::Array[OpenAI::Models::Beta::Agent::service_tier]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agent_close_subagent_call_item.rbs

@@ -0,0 +1,47 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_close_subagent_call_item =
+        {
+          id: String,
+          recipient_agent_id: String,
+          sender_agent_id: String,
+          status: OpenAI::Models::Beta::agent_function_call_status,
+          turn_id: String,
+          ?type: :close_subagent_call
+        }
+
+      class AgentCloseSubagentCallItem < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor recipient_agent_id: String
+
+        attr_accessor sender_agent_id: String
+
+        attr_accessor status: OpenAI::Models::Beta::agent_function_call_status
+
+        attr_accessor turn_id: String
+
+        attr_accessor type: :close_subagent_call
+
+        def initialize: (
+          id: String,
+          recipient_agent_id: String,
+          sender_agent_id: String,
+          status: OpenAI::Models::Beta::agent_function_call_status,
+          turn_id: String,
+          ?type: :close_subagent_call
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          recipient_agent_id: String,
+          sender_agent_id: String,
+          status: OpenAI::Models::Beta::agent_function_call_status,
+          turn_id: String,
+          ?type: :close_subagent_call
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agent_command_execution_item.rbs

@@ -0,0 +1,62 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_command_execution_item =
+        {
+          id: String,
+          command: String,
+          cwd: String?,
+          duration_ms: Integer?,
+          exit_code: Integer?,
+          output: String?,
+          status: OpenAI::Models::Beta::agent_function_call_status,
+          turn_id: String,
+          ?type: :command_execution
+        }
+
+      class AgentCommandExecutionItem < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor command: String
+
+        attr_accessor cwd: String?
+
+        attr_accessor duration_ms: Integer?
+
+        attr_accessor exit_code: Integer?
+
+        attr_accessor output: String?
+
+        attr_accessor status: OpenAI::Models::Beta::agent_function_call_status
+
+        attr_accessor turn_id: String
+
+        attr_accessor type: :command_execution
+
+        def initialize: (
+          id: String,
+          command: String,
+          cwd: String?,
+          duration_ms: Integer?,
+          exit_code: Integer?,
+          output: String?,
+          status: OpenAI::Models::Beta::agent_function_call_status,
+          turn_id: String,
+          ?type: :command_execution
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          command: String,
+          cwd: String?,
+          duration_ms: Integer?,
+          exit_code: Integer?,
+          output: String?,
+          status: OpenAI::Models::Beta::agent_function_call_status,
+          turn_id: String,
+          ?type: :command_execution
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agent_content.rbs

@@ -0,0 +1,33 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_content =
+        OpenAI::Beta::OutputText | OpenAI::Beta::AgentContent::EncryptedContent
+
+      module AgentContent
+        extend OpenAI::Internal::Type::Union
+
+        type encrypted_content =
+          { encrypted_content: String, ?type: :encrypted_content }
+
+        class EncryptedContent < OpenAI::Internal::Type::BaseModel
+          attr_accessor encrypted_content: String
+
+          attr_accessor type: :encrypted_content
+
+          def initialize: (
+            encrypted_content: String,
+            ?type: :encrypted_content
+          ) -> void
+
+          def to_hash: -> {
+            encrypted_content: String,
+            ?type: :encrypted_content
+          }
+        end
+
+        def self?.variants: -> ::Array[OpenAI::Models::Beta::agent_content]
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agent_create_params.rbs

@@ -0,0 +1,91 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_create_params =
+        {
+          model: String,
+          ?instructions: String?,
+          ?metadata: ::Hash[Symbol, String]?,
+          ?multi_agent: OpenAI::Beta::MultiAgentConfigParam?,
+          ?name: String?,
+          ?reasoning: OpenAI::Beta::AgentReasoningParam?,
+          ?service_tier: OpenAI::Models::Beta::AgentCreateParams::service_tier?,
+          ?text: OpenAI::Beta::AgentTextParam?,
+          ?tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]?,
+          ?request_options: OpenAI::request_opts
+        }
+
+      class AgentCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor model: String
+
+        attr_accessor instructions: String?
+
+        attr_accessor metadata: ::Hash[Symbol, String]?
+
+        attr_accessor multi_agent: OpenAI::Beta::MultiAgentConfigParam?
+
+        attr_accessor name: String?
+
+        attr_accessor reasoning: OpenAI::Beta::AgentReasoningParam?
+
+        attr_accessor service_tier: OpenAI::Models::Beta::AgentCreateParams::service_tier?
+
+        attr_accessor text: OpenAI::Beta::AgentTextParam?
+
+        attr_accessor tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]?
+
+        def initialize: (
+          model: String,
+          ?instructions: String?,
+          ?metadata: ::Hash[Symbol, String]?,
+          ?multi_agent: OpenAI::Beta::MultiAgentConfigParam?,
+          ?name: String?,
+          ?reasoning: OpenAI::Beta::AgentReasoningParam?,
+          ?service_tier: OpenAI::Models::Beta::AgentCreateParams::service_tier?,
+          ?text: OpenAI::Beta::AgentTextParam?,
+          ?tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]?,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          model: String,
+          ?instructions: String?,
+          ?metadata: ::Hash[Symbol, String]?,
+          ?multi_agent: OpenAI::Beta::MultiAgentConfigParam?,
+          ?name: String?,
+          ?reasoning: OpenAI::Beta::AgentReasoningParam?,
+          ?service_tier: OpenAI::Models::Beta::AgentCreateParams::service_tier?,
+          ?text: OpenAI::Beta::AgentTextParam?,
+          ?tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]?,
+          ?request_options: OpenAI::RequestOptions
+        }
+
+        type service_tier = :auto | :default | :flex | :priority | :fast
+
+        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
+
+          def self?.values: -> ::Array[OpenAI::Models::Beta::AgentCreateParams::service_tier]
+        end
+      end
+    end
+  end
+end