openai 0.89.0 → 0.91.0

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

@@ -0,0 +1,359 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A tool available to the agent.
+      module AgentToolParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A function defined by the application.
+        variant :function, -> { OpenAI::Beta::AgentToolParam::Function }
+
+        # Discovers deferred function tools and loads them into the model context.
+        variant :tool_search, -> { OpenAI::Beta::AgentToolParam::ToolSearch }
+
+        # Enables calling tools from model-generated code.
+        variant :programmatic_tool_calling, -> { OpenAI::Beta::AgentToolParam::ProgrammaticToolCalling }
+
+        # Tools provided by a remote MCP server.
+        variant :mcp, -> { OpenAI::Beta::AgentToolParam::Mcp }
+
+        # Web search.
+        variant :web_search, -> { OpenAI::Beta::AgentToolParam::WebSearch }
+
+        class Function < OpenAI::Internal::Type::BaseModel
+          # @!attribute description
+          #   A description of what the function does.
+          #
+          #   @return [String]
+          required :description, String
+
+          # @!attribute name
+          #   The name of the function.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute parameters
+          #   A JSON Schema object describing the function's arguments.
+          #
+          #   @return [Hash{Symbol=>Object}]
+          required :parameters, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+          # @!attribute type
+          #   The type of the object. Always `function`.
+          #
+          #   @return [Symbol, :function]
+          required :type, const: :function
+
+          # @!attribute defer_loading
+          #   Whether this function is deferred and discovered through tool search. Defaults
+          #   to `false`.
+          #
+          #   @return [Boolean, nil]
+          optional :defer_loading, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(description:, name:, parameters:, defer_loading: nil, type: :function)
+          #   A function defined by the application.
+          #
+          #   @param description [String]
+          #     A description of what the function does.
+          #
+          #   @param name [String]
+          #     The name of the function.
+          #
+          #   @param parameters [Hash{Symbol=>Object}]
+          #     A JSON Schema object describing the function's arguments.
+          #
+          #   @param defer_loading [Boolean]
+          #     Whether this function is deferred and discovered through tool search. Defaults
+          #     to `false`.
+          #
+          #   @param type [Symbol, :function]
+          #     The type of the object. Always `function`.
+        end
+
+        class ToolSearch < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `tool_search`.
+          #
+          #   @return [Symbol, :tool_search]
+          required :type, const: :tool_search
+
+          # @!method initialize(type: :tool_search)
+          #   Discovers deferred function tools and loads them into the model context.
+          #
+          #   @param type [Symbol, :tool_search]
+          #     The type of the object. Always `tool_search`.
+        end
+
+        class ProgrammaticToolCalling < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `programmatic_tool_calling`.
+          #
+          #   @return [Symbol, :programmatic_tool_calling]
+          required :type, const: :programmatic_tool_calling
+
+          # @!attribute enabled
+          #   Whether tools can be called from model-generated code. Defaults to `true`.
+          #
+          #   @return [Boolean, nil]
+          optional :enabled, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(enabled: nil, type: :programmatic_tool_calling)
+          #   Enables calling tools from model-generated code.
+          #
+          #   @param enabled [Boolean]
+          #     Whether tools can be called from model-generated code. Defaults to `true`.
+          #
+          #   @param type [Symbol, :programmatic_tool_calling]
+          #     The type of the object. Always `programmatic_tool_calling`.
+        end
+
+        class Mcp < OpenAI::Internal::Type::BaseModel
+          # @!attribute server_label
+          #   A label used to identify the MCP server in tool calls.
+          #
+          #   @return [String]
+          required :server_label, String
+
+          # @!attribute transport
+          #   The transport used to connect to the MCP server.
+          #
+          #   @return [OpenAI::Models::Beta::McpTransportParam::HTTP, OpenAI::Models::Beta::McpTransportParam::Stdio]
+          required :transport, union: -> { OpenAI::Beta::McpTransportParam }
+
+          # @!attribute type
+          #   The type of the object. Always `mcp`.
+          #
+          #   @return [Symbol, :mcp]
+          required :type, const: :mcp
+
+          # @!attribute allowed_tools
+          #   The MCP tools the agent may call. All server tools are allowed when omitted.
+          #
+          #   @return [Array<String>, nil]
+          optional :allowed_tools, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute connection_origin
+          #   Where outbound MCP HTTP connections originate.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::AgentToolParam::Mcp::ConnectionOrigin, nil]
+          optional(
+            :connection_origin,
+            enum: -> {
+              OpenAI::Beta::AgentToolParam::Mcp::ConnectionOrigin
+            },
+            nil?: true
+          )
+
+          # @!attribute credential_id
+          #   The attached vault credential used to authenticate this MCP server. Optional
+          #   when exactly one attached credential matches the server URL.
+          #
+          #   @return [String, nil]
+          optional :credential_id, String, nil?: true
+
+          # @!attribute request_metadata
+          #   Metadata included with requests to this MCP server.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional(
+            :request_metadata,
+            OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown],
+            nil?: true
+          )
+
+          # @!attribute required
+          #   Whether this MCP server must initialize before the first turn. Defaults to
+          #   `false`.
+          #
+          #   @return [Boolean, nil]
+          optional :required, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(server_label:, transport:, allowed_tools: nil, connection_origin: nil, credential_id: nil, request_metadata: nil, required: nil, type: :mcp)
+          #   Tools provided by a remote MCP server.
+          #
+          #   @param server_label [String]
+          #     A label used to identify the MCP server in tool calls.
+          #
+          #   @param transport [OpenAI::Models::Beta::McpTransportParam::HTTP, OpenAI::Models::Beta::McpTransportParam::Stdio]
+          #     The transport used to connect to the MCP server.
+          #
+          #   @param allowed_tools [Array<String>, nil]
+          #     The MCP tools the agent may call. All server tools are allowed when omitted.
+          #
+          #   @param connection_origin [Symbol, OpenAI::Models::Beta::AgentToolParam::Mcp::ConnectionOrigin, nil]
+          #     Where outbound MCP HTTP connections originate.
+          #
+          #   @param credential_id [String, nil]
+          #     The attached vault credential used to authenticate this MCP server. Optional
+          #     when exactly one attached credential matches the server URL.
+          #
+          #   @param request_metadata [Hash{Symbol=>Object}, nil]
+          #     Metadata included with requests to this MCP server.
+          #
+          #   @param required [Boolean]
+          #     Whether this MCP server must initialize before the first turn. Defaults to
+          #     `false`.
+          #
+          #   @param type [Symbol, :mcp]
+          #     The type of the object. Always `mcp`.
+
+          # Where outbound MCP HTTP connections originate.
+          #
+          # @see OpenAI::Models::Beta::AgentToolParam::Mcp#connection_origin
+          module ConnectionOrigin
+            extend OpenAI::Internal::Type::Enum
+
+            # Uses the Managed Agents service network.
+            SERVICE = :service
+
+            # Uses the session's execution environment.
+            ENVIRONMENT = :environment
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class WebSearch < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `web_search`.
+          #
+          #   @return [Symbol, :web_search]
+          required :type, const: :web_search
+
+          # @!attribute allowed_domains
+          #   Domains the search may include.
+          #
+          #   @return [Array<String>, nil]
+          optional :allowed_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute context_size
+          #   The amount of web search context made available to the model.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::AgentToolParam::WebSearch::ContextSize, nil]
+          optional(
+            :context_size,
+            enum: -> {
+              OpenAI::Beta::AgentToolParam::WebSearch::ContextSize
+            },
+            nil?: true
+          )
+
+          # @!attribute location
+          #   Approximate user location used to localize web search results.
+          #
+          #   @return [OpenAI::Models::Beta::AgentToolParam::WebSearch::Location, nil]
+          optional :location, -> { OpenAI::Beta::AgentToolParam::WebSearch::Location }, nil?: true
+
+          # @!attribute mode
+          #   The source used for web search results.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::AgentToolParam::WebSearch::Mode, nil]
+          optional :mode, enum: -> { OpenAI::Beta::AgentToolParam::WebSearch::Mode }, nil?: true
+
+          # @!method initialize(allowed_domains: nil, context_size: nil, location: nil, mode: nil, type: :web_search)
+          #   Web search.
+          #
+          #   @param allowed_domains [Array<String>, nil]
+          #     Domains the search may include.
+          #
+          #   @param context_size [Symbol, OpenAI::Models::Beta::AgentToolParam::WebSearch::ContextSize, nil]
+          #     The amount of web search context made available to the model.
+          #
+          #   @param location [OpenAI::Models::Beta::AgentToolParam::WebSearch::Location, nil]
+          #     Approximate user location used to localize web search results.
+          #
+          #   @param mode [Symbol, OpenAI::Models::Beta::AgentToolParam::WebSearch::Mode, nil]
+          #     The source used for web search results.
+          #
+          #   @param type [Symbol, :web_search]
+          #     The type of the object. Always `web_search`.
+
+          # The amount of web search context made available to the model.
+          #
+          # @see OpenAI::Models::Beta::AgentToolParam::WebSearch#context_size
+          module ContextSize
+            extend OpenAI::Internal::Type::Enum
+
+            LOW = :low
+            MEDIUM = :medium
+            HIGH = :high
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see OpenAI::Models::Beta::AgentToolParam::WebSearch#location
+          class Location < OpenAI::Internal::Type::BaseModel
+            # @!attribute city
+            #   The city name.
+            #
+            #   @return [String, nil]
+            optional :city, String, nil?: true
+
+            # @!attribute country
+            #   The two-letter ISO country code, such as `US`.
+            #
+            #   @return [String, nil]
+            optional :country, String, nil?: true
+
+            # @!attribute region
+            #   The region or state name.
+            #
+            #   @return [String, nil]
+            optional :region, String, nil?: true
+
+            # @!attribute timezone
+            #   The IANA timezone, such as `America/Los_Angeles`.
+            #
+            #   @return [String, nil]
+            optional :timezone, String, nil?: true
+
+            # @!method initialize(city: nil, country: nil, region: nil, timezone: nil)
+            #   Approximate user location used to localize web search results.
+            #
+            #   @param city [String, nil]
+            #     The city name.
+            #
+            #   @param country [String, nil]
+            #     The two-letter ISO country code, such as `US`.
+            #
+            #   @param region [String, nil]
+            #     The region or state name.
+            #
+            #   @param timezone [String, nil]
+            #     The IANA timezone, such as `America/Los_Angeles`.
+          end
+
+          # The source used for web search results.
+          #
+          # @see OpenAI::Models::Beta::AgentToolParam::WebSearch#mode
+          module Mode
+            extend OpenAI::Internal::Type::Enum
+
+            # Disables web search.
+            DISABLED = :disabled
+
+            # Uses cached search results.
+            CACHED = :cached
+
+            # Searches the live web.
+            LIVE = :live
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @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)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Agents#update
+      class AgentUpdateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute agent_id
+        #
+        #   @return [String]
+        required :agent_id, String
+
+        # @!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 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
+
+        # @!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 name
+        #   A replacement name. Omit to leave unchanged, or pass null to clear it.
+        #
+        #   @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::AgentUpdateParams::ServiceTier, nil]
+        optional :service_tier, enum: -> { OpenAI::Beta::AgentUpdateParams::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.
+        #
+        #   @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(agent_id:, instructions: nil, metadata: nil, model: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        #   @param agent_id [String]
+        #
+        #   @param instructions [String, nil]
+        #     Additional instructions appended to the agent's default base instructions. Omit
+        #     to leave 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 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 name [String, nil]
+        #     A replacement name. Omit to leave unchanged, or pass null to clear it.
+        #
+        #   @param reasoning [OpenAI::Models::Beta::AgentReasoningParam, nil]
+        #     Reasoning configuration for the agent.
+        #
+        #   @param service_tier [Symbol, OpenAI::Models::Beta::AgentUpdateParams::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.
+        #
+        #   @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_wait_for_subagents_call_item.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentWaitForSubagentsCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the tool call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute recipient_agent_ids
+        #   The IDs of the agents to wait for.
+        #
+        #   @return [Array<String>]
+        required :recipient_agent_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+        # @!attribute sender_agent_id
+        #   The ID of the agent waiting for results.
+        #
+        #   @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 `wait_for_subagents_call`.
+        #
+        #   @return [Symbol, :wait_for_subagents_call]
+        required :type, const: :wait_for_subagents_call
+
+        # @!method initialize(id:, recipient_agent_ids:, sender_agent_id:, status:, turn_id:, type: :wait_for_subagents_call)
+        #   A request to wait for one or more subagents.
+        #
+        #   @param id [String]
+        #     The ID of the tool call item.
+        #
+        #   @param recipient_agent_ids [Array<String>]
+        #     The IDs of the agents to wait for.
+        #
+        #   @param sender_agent_id [String]
+        #     The ID of the agent waiting for results.
+        #
+        #   @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, :wait_for_subagents_call]
+        #     The item type. Always `wait_for_subagents_call`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentWebSearchCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the web search call.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute action
+        #   An action performed by the web search tool.
+        #
+        #   @return [OpenAI::Models::Beta::WebSearchAction::Search, OpenAI::Models::Beta::WebSearchAction::OpenPage, OpenAI::Models::Beta::WebSearchAction::FindInPage, OpenAI::Models::Beta::WebSearchAction::Other, nil]
+        required :action, union: -> { OpenAI::Beta::WebSearchAction }, nil?: true
+
+        # @!attribute status
+        #   The status of the web search call.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentOutputItemStatus]
+        required :status, enum: -> { OpenAI::Beta::AgentOutputItemStatus }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `web_search_call`.
+        #
+        #   @return [Symbol, :web_search_call]
+        required :type, const: :web_search_call
+
+        # @!method initialize(id:, action:, status:, turn_id:, type: :web_search_call)
+        #   A web search call produced by the agent.
+        #
+        #   @param id [String]
+        #     The ID of the web search call.
+        #
+        #   @param action [OpenAI::Models::Beta::WebSearchAction::Search, OpenAI::Models::Beta::WebSearchAction::OpenPage, OpenAI::Models::Beta::WebSearchAction::FindInPage, OpenAI::Models::Beta::WebSearchAction::Other, nil]
+        #     An action performed by the web search tool.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentOutputItemStatus]
+        #     The status of the web search call.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :web_search_call]
+        #     The item type. Always `web_search_call`.
+      end
+    end
+  end
+end