openai 0.89.0 → 0.91.0

data/lib/openai/internal/util.rb

@@ -891,7 +891,7 @@ module OpenAI
               encoding = row.encoding if !row.empty? && (encoding.nil? || encoding == Encoding::US_ASCII)
               offset = buffer.bytesize
               buffer << (row.encoding == Encoding::BINARY ? row : row.b)
-              while (match = re.match(buffer, cr_seen&.to_i || offset))
+              while (match = re.match(buffer, cr_seen || offset))
                 case [match.captures.first, cr_seen]
                 in ["\r", nil]
                   cr_seen = match.end(1)

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

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Agents#create
+      class Agent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the reusable agent.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp, in seconds, when the agent was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute instructions
+        #   Custom instructions appended to the agent's default base instructions.
+        #
+        #   @return [String, nil]
+        required :instructions, String, nil?: true
+
+        # @!attribute metadata
+        #   Custom string key-value pairs attached to the agent.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :metadata, OpenAI::Internal::Type::HashOf[String]
+
+        # @!attribute model
+        #   The requested model name used for inference.
+        #
+        #   @return [String]
+        required :model, String
+
+        # @!attribute multi_agent
+        #   The resolved configuration for creating and coordinating subagents.
+        #
+        #   @return [OpenAI::Models::Beta::MultiAgentConfig]
+        required :multi_agent, -> { OpenAI::Beta::MultiAgentConfig }
+
+        # @!attribute name
+        #   A human-readable name for the agent, or null if it is unnamed.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute object
+        #   The object type. Always `agent`.
+        #
+        #   @return [Symbol, :agent]
+        required :object, const: :agent
+
+        # @!attribute reasoning
+        #   The resolved reasoning configuration, including the model default for an omitted
+        #   effort.
+        #
+        #   @return [OpenAI::Models::Beta::AgentReasoning]
+        required :reasoning, -> { OpenAI::Beta::AgentReasoning }
+
+        # @!attribute service_tier
+        #   The resolved service-tier policy used for model requests.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::Agent::ServiceTier]
+        required :service_tier, enum: -> { OpenAI::Beta::Agent::ServiceTier }
+
+        # @!attribute text
+        #   The resolved configuration for text generated by the agent.
+        #
+        #   @return [OpenAI::Models::Beta::AgentText]
+        required :text, -> { OpenAI::Beta::AgentText }
+
+        # @!attribute tools
+        #   Tools available to the agent.
+        #
+        #   @return [Array<OpenAI::Models::Beta::PersistedAgentTool::Function, OpenAI::Models::Beta::PersistedAgentTool::ToolSearch, OpenAI::Models::Beta::PersistedAgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentTool::Mcp, OpenAI::Models::Beta::PersistedAgentTool::WebSearch>]
+        required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::PersistedAgentTool] }
+
+        # @!attribute updated_at
+        #   The Unix timestamp, in seconds, when the agent was last updated.
+        #
+        #   @return [Integer]
+        required :updated_at, Integer
+
+        # @!method initialize(id:, created_at:, instructions:, metadata:, model:, multi_agent:, name:, reasoning:, service_tier:, text:, tools:, updated_at:, object: :agent)
+        #   A reusable agent scoped to the caller's project.
+        #
+        #   @param id [String]
+        #     The ID of the reusable agent.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp, in seconds, when the agent was created.
+        #
+        #   @param instructions [String, nil]
+        #     Custom instructions appended to the agent's default base instructions.
+        #
+        #   @param metadata [Hash{Symbol=>String}]
+        #     Custom string key-value pairs attached to the agent.
+        #
+        #   @param model [String]
+        #     The requested model name used for inference.
+        #
+        #   @param multi_agent [OpenAI::Models::Beta::MultiAgentConfig]
+        #     The resolved configuration for creating and coordinating subagents.
+        #
+        #   @param name [String, nil]
+        #     A human-readable name for the agent, or null if it is unnamed.
+        #
+        #   @param reasoning [OpenAI::Models::Beta::AgentReasoning]
+        #     The resolved reasoning configuration, including the model default for an omitted
+        #     effort.
+        #
+        #   @param service_tier [Symbol, OpenAI::Models::Beta::Agent::ServiceTier]
+        #     The resolved service-tier policy used for model requests.
+        #
+        #   @param text [OpenAI::Models::Beta::AgentText]
+        #     The resolved configuration for text generated by the agent.
+        #
+        #   @param tools [Array<OpenAI::Models::Beta::PersistedAgentTool::Function, OpenAI::Models::Beta::PersistedAgentTool::ToolSearch, OpenAI::Models::Beta::PersistedAgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentTool::Mcp, OpenAI::Models::Beta::PersistedAgentTool::WebSearch>]
+        #     Tools available to the agent.
+        #
+        #   @param updated_at [Integer]
+        #     The Unix timestamp, in seconds, when the agent was last updated.
+        #
+        #   @param object [Symbol, :agent]
+        #     The object type. Always `agent`.
+
+        # The resolved service-tier policy used for model requests.
+        #
+        # @see OpenAI::Models::Beta::Agent#service_tier
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO = :auto
+          DEFAULT = :default
+          FLEX = :flex
+          PRIORITY = :priority
+          FAST = :fast
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentCloseSubagentCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the tool call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute recipient_agent_id
+        #   The ID of the agent to close.
+        #
+        #   @return [String]
+        required :recipient_agent_id, String
+
+        # @!attribute sender_agent_id
+        #   The ID of the agent requesting the close.
+        #
+        #   @return [String]
+        required :sender_agent_id, String
+
+        # @!attribute status
+        #   The status of the tool call.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        required :status, enum: -> { OpenAI::Beta::AgentFunctionCallStatus }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `close_subagent_call`.
+        #
+        #   @return [Symbol, :close_subagent_call]
+        required :type, const: :close_subagent_call
+
+        # @!method initialize(id:, recipient_agent_id:, sender_agent_id:, status:, turn_id:, type: :close_subagent_call)
+        #   A request to close a subagent.
+        #
+        #   @param id [String]
+        #     The ID of the tool call item.
+        #
+        #   @param recipient_agent_id [String]
+        #     The ID of the agent to close.
+        #
+        #   @param sender_agent_id [String]
+        #     The ID of the agent requesting the close.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        #     The status of the tool call.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :close_subagent_call]
+        #     The item type. Always `close_subagent_call`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentCommandExecutionItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the command execution item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute command
+        #   The command that was executed.
+        #
+        #   @return [String]
+        required :command, String
+
+        # @!attribute cwd
+        #   The working directory used to execute the command.
+        #
+        #   @return [String, nil]
+        required :cwd, String, nil?: true
+
+        # @!attribute duration_ms
+        #   The command duration in milliseconds.
+        #
+        #   @return [Integer, nil]
+        required :duration_ms, Integer, nil?: true
+
+        # @!attribute exit_code
+        #   The process exit code, if the command completed.
+        #
+        #   @return [Integer, nil]
+        required :exit_code, Integer, nil?: true
+
+        # @!attribute output
+        #   The command output, if available.
+        #
+        #   @return [String, nil]
+        required :output, String, nil?: true
+
+        # @!attribute status
+        #   The status of the command execution.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        required :status, enum: -> { OpenAI::Beta::AgentFunctionCallStatus }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `command_execution`.
+        #
+        #   @return [Symbol, :command_execution]
+        required :type, const: :command_execution
+
+        # @!method initialize(id:, command:, cwd:, duration_ms:, exit_code:, output:, status:, turn_id:, type: :command_execution)
+        #   A command execution produced by the agent.
+        #
+        #   @param id [String]
+        #     The ID of the command execution item.
+        #
+        #   @param command [String]
+        #     The command that was executed.
+        #
+        #   @param cwd [String, nil]
+        #     The working directory used to execute the command.
+        #
+        #   @param duration_ms [Integer, nil]
+        #     The command duration in milliseconds.
+        #
+        #   @param exit_code [Integer, nil]
+        #     The process exit code, if the command completed.
+        #
+        #   @param output [String, nil]
+        #     The command output, if available.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        #     The status of the command execution.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :command_execution]
+        #     The item type. Always `command_execution`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A plaintext or encrypted content part exchanged between agents.
+      module AgentContent
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A text content part produced by the agent.
+        variant :output_text, -> { OpenAI::Beta::OutputText }
+
+        # Encrypted content exchanged between agents.
+        variant :encrypted_content, -> { OpenAI::Beta::AgentContent::EncryptedContent }
+
+        class EncryptedContent < OpenAI::Internal::Type::BaseModel
+          # @!attribute encrypted_content
+          #   The encrypted content payload.
+          #
+          #   @return [String]
+          required :encrypted_content, String
+
+          # @!attribute type
+          #   The content type. Always `encrypted_content`.
+          #
+          #   @return [Symbol, :encrypted_content]
+          required :type, const: :encrypted_content
+
+          # @!method initialize(encrypted_content:, type: :encrypted_content)
+          #   Encrypted content exchanged between agents.
+          #
+          #   @param encrypted_content [String]
+          #     The encrypted content payload.
+          #
+          #   @param type [Symbol, :encrypted_content]
+          #     The content type. Always `encrypted_content`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Agents#create
+      class AgentCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute model
+        #   The model to use for the agent. The requested model name is preserved.
+        #
+        #   @return [String]
+        required :model, String
+
+        # @!attribute instructions
+        #   Additional instructions appended to the agent's default base instructions. Omit
+        #   or set to null to add no custom instructions.
+        #
+        #   @return [String, nil]
+        optional :instructions, String, 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 multi_agent
+        #   Explicit configuration for creating and coordinating subagents.
+        #
+        #   @return [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+        optional :multi_agent, -> { OpenAI::Beta::MultiAgentConfigParam }, nil?: true
+
+        # @!attribute name
+        #   A human-readable name for the agent. Omission or null leaves the agent unnamed.
+        #
+        #   @return [String, nil]
+        optional :name, String, 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::AgentCreateParams::ServiceTier, nil]
+        optional :service_tier, enum: -> { OpenAI::Beta::AgentCreateParams::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. Defaults to an empty list.
+        #
+        #   @return [Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil]
+        optional(
+          :tools,
+          -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::PersistedAgentToolParam] },
+          nil?: true
+        )
+
+        # @!method initialize(model:, instructions: nil, metadata: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        #   @param model [String]
+        #     The model to use for the agent. The requested model name is preserved.
+        #
+        #   @param instructions [String, nil]
+        #     Additional instructions appended to the agent's default base instructions. Omit
+        #     or set to null to add no custom instructions.
+        #
+        #   @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 multi_agent [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+        #     Explicit configuration for creating and coordinating subagents.
+        #
+        #   @param name [String, nil]
+        #     A human-readable name for the agent. Omission or null leaves the agent unnamed.
+        #
+        #   @param reasoning [OpenAI::Models::Beta::AgentReasoningParam, nil]
+        #     Reasoning configuration for the agent.
+        #
+        #   @param service_tier [Symbol, OpenAI::Models::Beta::AgentCreateParams::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::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil]
+        #     Tools available to the agent. Defaults to an empty list.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The service tier used for model requests.
+        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

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentCreateSubagentCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the tool call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute agent_id
+        #   The ID of the agent that requested the subagent.
+        #
+        #   @return [String]
+        required :agent_id, String
+
+        # @!attribute content
+        #   The task given to the spawned agent.
+        #
+        #   @return [Array<OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent>]
+        required :content, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentContent] }
+
+        # @!attribute model
+        #   The model requested for the spawned agent.
+        #
+        #   @return [String, nil]
+        required :model, String, nil?: true
+
+        # @!attribute reasoning_effort
+        #   The reasoning effort requested for the spawned agent.
+        #
+        #   @return [String, nil]
+        required :reasoning_effort, String, nil?: true
+
+        # @!attribute status
+        #   The status of the tool call.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        required :status, enum: -> { OpenAI::Beta::AgentFunctionCallStatus }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `create_subagent_call`.
+        #
+        #   @return [Symbol, :create_subagent_call]
+        required :type, const: :create_subagent_call
+
+        # @!method initialize(id:, agent_id:, content:, model:, reasoning_effort:, status:, turn_id:, type: :create_subagent_call)
+        #   A request to spawn a subagent.
+        #
+        #   @param id [String]
+        #     The ID of the tool call item.
+        #
+        #   @param agent_id [String]
+        #     The ID of the agent that requested the subagent.
+        #
+        #   @param content [Array<OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent>]
+        #     The task given to the spawned agent.
+        #
+        #   @param model [String, nil]
+        #     The model requested for the spawned agent.
+        #
+        #   @param reasoning_effort [String, nil]
+        #     The reasoning effort requested for the spawned agent.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        #     The status of the tool call.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :create_subagent_call]
+        #     The item type. Always `create_subagent_call`.
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Agents#delete
+      class AgentDeleted < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the deleted agent.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute deleted
+        #   Whether the agent was deleted. Always `true`.
+        #
+        #   @return [Boolean]
+        required :deleted, OpenAI::Internal::Type::Boolean
+
+        # @!attribute object
+        #   The object type. Always `agent.deleted`.
+        #
+        #   @return [Symbol, :"agent.deleted"]
+        required :object, const: :"agent.deleted"
+
+        # @!method initialize(id:, deleted:, object: :"agent.deleted")
+        #   A deleted reusable agent.
+        #
+        #   @param id [String]
+        #     The ID of the deleted agent.
+        #
+        #   @param deleted [Boolean]
+        #     Whether the agent was deleted. Always `true`.
+        #
+        #   @param object [Symbol, :"agent.deleted"]
+        #     The object type. Always `agent.deleted`.
+      end
+    end
+  end
+end