openai 0.67.0 → 0.69.0

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

@@ -0,0 +1,910 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A tool that can be used to generate a response.
+      module BetaTool
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).
+        variant :function, -> { OpenAI::Beta::BetaFunctionTool }
+
+        # A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search).
+        variant :file_search, -> { OpenAI::Beta::BetaFileSearchTool }
+
+        # A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+        variant :computer, -> { OpenAI::Beta::BetaComputerTool }
+
+        # A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
+        variant :computer_use_preview, -> { OpenAI::Beta::BetaComputerUsePreviewTool }
+
+        # Give the model access to additional tools via remote Model Context Protocol
+        # (MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+        variant :mcp, -> { OpenAI::Beta::BetaTool::Mcp }
+
+        # A tool that runs Python code to help generate a response to a prompt.
+        variant :code_interpreter, -> { OpenAI::Beta::BetaTool::CodeInterpreter }
+
+        variant :programmatic_tool_calling, -> { OpenAI::Beta::BetaTool::ProgrammaticToolCalling }
+
+        # A tool that generates images using the GPT image models.
+        variant :image_generation, -> { OpenAI::Beta::BetaTool::ImageGeneration }
+
+        # A tool that allows the model to execute shell commands in a local environment.
+        variant :local_shell, -> { OpenAI::Beta::BetaTool::LocalShell }
+
+        # A tool that allows the model to execute shell commands.
+        variant :shell, -> { OpenAI::Beta::BetaFunctionShellTool }
+
+        # A custom tool that processes input using a specified format. Learn more about   [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)
+        variant :custom, -> { OpenAI::Beta::BetaCustomTool }
+
+        # Groups function/custom tools under a shared namespace.
+        variant :namespace, -> { OpenAI::Beta::BetaNamespaceTool }
+
+        # Hosted or BYOT tool search configuration for deferred tools.
+        variant :tool_search, -> { OpenAI::Beta::BetaToolSearchTool }
+
+        # Allows the assistant to create, delete, or update files using unified diffs.
+        variant :apply_patch, -> { OpenAI::Beta::BetaApplyPatchTool }
+
+        # Search the Internet for sources related to the prompt. Learn more about the
+        # [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
+        variant -> { OpenAI::Beta::BetaWebSearchTool }
+
+        # This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
+        variant -> { OpenAI::Beta::BetaWebSearchPreviewTool }
+
+        class Mcp < OpenAI::Internal::Type::BaseModel
+          # @!attribute server_label
+          #   A label for this MCP server, used to identify it in tool calls.
+          #
+          #   @return [String]
+          required :server_label, String
+
+          # @!attribute type
+          #   The type of the MCP tool. Always `mcp`.
+          #
+          #   @return [Symbol, :mcp]
+          required :type, const: :mcp
+
+          # @!attribute allowed_callers
+          #   The tool invocation context(s).
+          #
+          #   @return [Array<Symbol, OpenAI::Models::Beta::BetaTool::Mcp::AllowedCaller>, nil]
+          optional :allowed_callers,
+                   -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::BetaTool::Mcp::AllowedCaller] },
+                   nil?: true
+
+          # @!attribute allowed_tools
+          #   List of allowed tool names or a filter object.
+          #
+          #   @return [Array<String>, OpenAI::Models::Beta::BetaTool::Mcp::AllowedTools::McpToolFilter, nil]
+          optional :allowed_tools, union: -> { OpenAI::Beta::BetaTool::Mcp::AllowedTools }, nil?: true
+
+          # @!attribute authorization
+          #   An OAuth access token that can be used with a remote MCP server, either with a
+          #   custom MCP server URL or a service connector. Your application must handle the
+          #   OAuth authorization flow and provide the token here.
+          #
+          #   @return [String, nil]
+          optional :authorization, String
+
+          # @!attribute connector_id
+          #   Identifier for service connectors, like those available in ChatGPT. One of
+          #   `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
+          #   service connectors
+          #   [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+          #
+          #   Currently supported `connector_id` values are:
+          #
+          #   - Dropbox: `connector_dropbox`
+          #   - Gmail: `connector_gmail`
+          #   - Google Calendar: `connector_googlecalendar`
+          #   - Google Drive: `connector_googledrive`
+          #   - Microsoft Teams: `connector_microsoftteams`
+          #   - Outlook Calendar: `connector_outlookcalendar`
+          #   - Outlook Email: `connector_outlookemail`
+          #   - SharePoint: `connector_sharepoint`
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaTool::Mcp::ConnectorID, nil]
+          optional :connector_id, enum: -> { OpenAI::Beta::BetaTool::Mcp::ConnectorID }
+
+          # @!attribute defer_loading
+          #   Whether this MCP tool is deferred and discovered via tool search.
+          #
+          #   @return [Boolean, nil]
+          optional :defer_loading, OpenAI::Internal::Type::Boolean
+
+          # @!attribute headers
+          #   Optional HTTP headers to send to the MCP server. Use for authentication or other
+          #   purposes.
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :headers, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+          # @!attribute require_approval
+          #   Specify which of the MCP server's tools require approval.
+          #
+          #   @return [OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter, Symbol, OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalSetting, nil]
+          optional :require_approval, union: -> { OpenAI::Beta::BetaTool::Mcp::RequireApproval }, nil?: true
+
+          # @!attribute server_description
+          #   Optional description of the MCP server, used to provide more context.
+          #
+          #   @return [String, nil]
+          optional :server_description, String
+
+          # @!attribute server_url
+          #   The URL for the MCP server. One of `server_url`, `connector_id`, or `tunnel_id`
+          #   must be provided.
+          #
+          #   @return [String, nil]
+          optional :server_url, String
+
+          # @!attribute tunnel_id
+          #   The Secure MCP Tunnel ID to use instead of a direct server URL. One of
+          #   `server_url`, `connector_id`, or `tunnel_id` must be provided.
+          #
+          #   @return [String, nil]
+          optional :tunnel_id, String
+
+          # @!method initialize(server_label:, allowed_callers: nil, allowed_tools: nil, authorization: nil, connector_id: nil, defer_loading: nil, headers: nil, require_approval: nil, server_description: nil, server_url: nil, tunnel_id: nil, type: :mcp)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Beta::BetaTool::Mcp} for more details.
+          #
+          #   Give the model access to additional tools via remote Model Context Protocol
+          #   (MCP) servers.
+          #   [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+          #
+          #   @param server_label [String] A label for this MCP server, used to identify it in tool calls.
+          #
+          #   @param allowed_callers [Array<Symbol, OpenAI::Models::Beta::BetaTool::Mcp::AllowedCaller>, nil] The tool invocation context(s).
+          #
+          #   @param allowed_tools [Array<String>, OpenAI::Models::Beta::BetaTool::Mcp::AllowedTools::McpToolFilter, nil] List of allowed tool names or a filter object.
+          #
+          #   @param authorization [String] An OAuth access token that can be used with a remote MCP server, either
+          #
+          #   @param connector_id [Symbol, OpenAI::Models::Beta::BetaTool::Mcp::ConnectorID] Identifier for service connectors, like those available in ChatGPT. One of
+          #
+          #   @param defer_loading [Boolean] Whether this MCP tool is deferred and discovered via tool search.
+          #
+          #   @param headers [Hash{Symbol=>String}, nil] Optional HTTP headers to send to the MCP server. Use for authentication
+          #
+          #   @param require_approval [OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter, Symbol, OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalSetting, nil] Specify which of the MCP server's tools require approval.
+          #
+          #   @param server_description [String] Optional description of the MCP server, used to provide more context.
+          #
+          #   @param server_url [String] The URL for the MCP server. One of `server_url`, `connector_id`, or
+          #
+          #   @param tunnel_id [String] The Secure MCP Tunnel ID to use instead of a direct server URL. One of
+          #
+          #   @param type [Symbol, :mcp] The type of the MCP tool. Always `mcp`.
+
+          module AllowedCaller
+            extend OpenAI::Internal::Type::Enum
+
+            DIRECT = :direct
+            PROGRAMMATIC = :programmatic
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # List of allowed tool names or a filter object.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::Mcp#allowed_tools
+          module AllowedTools
+            extend OpenAI::Internal::Type::Union
+
+            # A string array of allowed tool names
+            variant -> { OpenAI::Models::Beta::BetaTool::Mcp::AllowedTools::StringArray }
+
+            # A filter object to specify which tools are allowed.
+            variant -> { OpenAI::Beta::BetaTool::Mcp::AllowedTools::McpToolFilter }
+
+            class McpToolFilter < OpenAI::Internal::Type::BaseModel
+              # @!attribute read_only
+              #   Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              #   is
+              #   [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              #   it will match this filter.
+              #
+              #   @return [Boolean, nil]
+              optional :read_only, OpenAI::Internal::Type::Boolean
+
+              # @!attribute tool_names
+              #   List of allowed tool names.
+              #
+              #   @return [Array<String>, nil]
+              optional :tool_names, OpenAI::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(read_only: nil, tool_names: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Beta::BetaTool::Mcp::AllowedTools::McpToolFilter} for more
+              #   details.
+              #
+              #   A filter object to specify which tools are allowed.
+              #
+              #   @param read_only [Boolean] Indicates whether or not a tool modifies data or is read-only. If an
+              #
+              #   @param tool_names [Array<String>] List of allowed tool names.
+            end
+
+            # @!method self.variants
+            #   @return [Array(Array<String>, OpenAI::Models::Beta::BetaTool::Mcp::AllowedTools::McpToolFilter)]
+
+            # @type [OpenAI::Internal::Type::Converter]
+            StringArray = OpenAI::Internal::Type::ArrayOf[String]
+          end
+
+          # Identifier for service connectors, like those available in ChatGPT. One of
+          # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
+          # service connectors
+          # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+          #
+          # Currently supported `connector_id` values are:
+          #
+          # - Dropbox: `connector_dropbox`
+          # - Gmail: `connector_gmail`
+          # - Google Calendar: `connector_googlecalendar`
+          # - Google Drive: `connector_googledrive`
+          # - Microsoft Teams: `connector_microsoftteams`
+          # - Outlook Calendar: `connector_outlookcalendar`
+          # - Outlook Email: `connector_outlookemail`
+          # - SharePoint: `connector_sharepoint`
+          #
+          # @see OpenAI::Models::Beta::BetaTool::Mcp#connector_id
+          module ConnectorID
+            extend OpenAI::Internal::Type::Enum
+
+            CONNECTOR_DROPBOX = :connector_dropbox
+            CONNECTOR_GMAIL = :connector_gmail
+            CONNECTOR_GOOGLECALENDAR = :connector_googlecalendar
+            CONNECTOR_GOOGLEDRIVE = :connector_googledrive
+            CONNECTOR_MICROSOFTTEAMS = :connector_microsoftteams
+            CONNECTOR_OUTLOOKCALENDAR = :connector_outlookcalendar
+            CONNECTOR_OUTLOOKEMAIL = :connector_outlookemail
+            CONNECTOR_SHAREPOINT = :connector_sharepoint
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Specify which of the MCP server's tools require approval.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::Mcp#require_approval
+          module RequireApproval
+            extend OpenAI::Internal::Type::Union
+
+            # Specify which of the MCP server's tools require approval. Can be
+            # `always`, `never`, or a filter object associated with tools
+            # that require approval.
+            variant -> { OpenAI::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter }
+
+            # Specify a single approval policy for all tools. One of `always` or
+            # `never`. When set to `always`, all tools will require approval. When
+            # set to `never`, all tools will not require approval.
+            variant enum: -> { OpenAI::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalSetting }
+
+            class McpToolApprovalFilter < OpenAI::Internal::Type::BaseModel
+              # @!attribute always
+              #   A filter object to specify which tools are allowed.
+              #
+              #   @return [OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter::Always, nil]
+              optional :always, -> { OpenAI::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter::Always }
+
+              # @!attribute never
+              #   A filter object to specify which tools are allowed.
+              #
+              #   @return [OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter::Never, nil]
+              optional :never, -> { OpenAI::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter::Never }
+
+              # @!method initialize(always: nil, never: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter}
+              #   for more details.
+              #
+              #   Specify which of the MCP server's tools require approval. Can be `always`,
+              #   `never`, or a filter object associated with tools that require approval.
+              #
+              #   @param always [OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter::Always] A filter object to specify which tools are allowed.
+              #
+              #   @param never [OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter::Never] A filter object to specify which tools are allowed.
+
+              # @see OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter#always
+              class Always < OpenAI::Internal::Type::BaseModel
+                # @!attribute read_only
+                #   Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                #   is
+                #   [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                #   it will match this filter.
+                #
+                #   @return [Boolean, nil]
+                optional :read_only, OpenAI::Internal::Type::Boolean
+
+                # @!attribute tool_names
+                #   List of allowed tool names.
+                #
+                #   @return [Array<String>, nil]
+                optional :tool_names, OpenAI::Internal::Type::ArrayOf[String]
+
+                # @!method initialize(read_only: nil, tool_names: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter::Always}
+                #   for more details.
+                #
+                #   A filter object to specify which tools are allowed.
+                #
+                #   @param read_only [Boolean] Indicates whether or not a tool modifies data or is read-only. If an
+                #
+                #   @param tool_names [Array<String>] List of allowed tool names.
+              end
+
+              # @see OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter#never
+              class Never < OpenAI::Internal::Type::BaseModel
+                # @!attribute read_only
+                #   Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                #   is
+                #   [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                #   it will match this filter.
+                #
+                #   @return [Boolean, nil]
+                optional :read_only, OpenAI::Internal::Type::Boolean
+
+                # @!attribute tool_names
+                #   List of allowed tool names.
+                #
+                #   @return [Array<String>, nil]
+                optional :tool_names, OpenAI::Internal::Type::ArrayOf[String]
+
+                # @!method initialize(read_only: nil, tool_names: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter::Never}
+                #   for more details.
+                #
+                #   A filter object to specify which tools are allowed.
+                #
+                #   @param read_only [Boolean] Indicates whether or not a tool modifies data or is read-only. If an
+                #
+                #   @param tool_names [Array<String>] List of allowed tool names.
+              end
+            end
+
+            # Specify a single approval policy for all tools. One of `always` or `never`. When
+            # set to `always`, all tools will require approval. When set to `never`, all tools
+            # will not require approval.
+            module McpToolApprovalSetting
+              extend OpenAI::Internal::Type::Enum
+
+              ALWAYS = :always
+              NEVER = :never
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalFilter, Symbol, OpenAI::Models::Beta::BetaTool::Mcp::RequireApproval::McpToolApprovalSetting)]
+          end
+        end
+
+        class CodeInterpreter < OpenAI::Internal::Type::BaseModel
+          # @!attribute container
+          #   The code interpreter container. Can be a container ID or an object that
+          #   specifies uploaded file IDs to make available to your code, along with an
+          #   optional `memory_limit` setting.
+          #
+          #   @return [String, OpenAI::Models::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto]
+          required :container, union: -> { OpenAI::Beta::BetaTool::CodeInterpreter::Container }
+
+          # @!attribute type
+          #   The type of the code interpreter tool. Always `code_interpreter`.
+          #
+          #   @return [Symbol, :code_interpreter]
+          required :type, const: :code_interpreter
+
+          # @!attribute allowed_callers
+          #   The tool invocation context(s).
+          #
+          #   @return [Array<Symbol, OpenAI::Models::Beta::BetaTool::CodeInterpreter::AllowedCaller>, nil]
+          optional :allowed_callers,
+                   -> {
+                     OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::BetaTool::CodeInterpreter::AllowedCaller]
+                   },
+                   nil?: true
+
+          # @!method initialize(container:, allowed_callers: nil, type: :code_interpreter)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Beta::BetaTool::CodeInterpreter} for more details.
+          #
+          #   A tool that runs Python code to help generate a response to a prompt.
+          #
+          #   @param container [String, OpenAI::Models::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto] The code interpreter container. Can be a container ID or an object that
+          #
+          #   @param allowed_callers [Array<Symbol, OpenAI::Models::Beta::BetaTool::CodeInterpreter::AllowedCaller>, nil] The tool invocation context(s).
+          #
+          #   @param type [Symbol, :code_interpreter] The type of the code interpreter tool. Always `code_interpreter`.
+
+          # The code interpreter container. Can be a container ID or an object that
+          # specifies uploaded file IDs to make available to your code, along with an
+          # optional `memory_limit` setting.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::CodeInterpreter#container
+          module Container
+            extend OpenAI::Internal::Type::Union
+
+            # The container ID.
+            variant String
+
+            # Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
+            variant -> { OpenAI::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto }
+
+            class CodeInterpreterToolAuto < OpenAI::Internal::Type::BaseModel
+              # @!attribute type
+              #   Always `auto`.
+              #
+              #   @return [Symbol, :auto]
+              required :type, const: :auto
+
+              # @!attribute file_ids
+              #   An optional list of uploaded files to make available to your code.
+              #
+              #   @return [Array<String>, nil]
+              optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+              # @!attribute memory_limit
+              #   The memory limit for the code interpreter container.
+              #
+              #   @return [Symbol, OpenAI::Models::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto::MemoryLimit, nil]
+              optional :memory_limit,
+                       enum: -> {
+                         OpenAI::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto::MemoryLimit
+                       },
+                       nil?: true
+
+              # @!attribute network_policy
+              #   Network access policy for the container.
+              #
+              #   @return [OpenAI::Models::Beta::BetaContainerNetworkPolicyDisabled, OpenAI::Models::Beta::BetaContainerNetworkPolicyAllowlist, nil]
+              optional :network_policy,
+                       union: -> { OpenAI::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto::NetworkPolicy }
+
+              # @!method initialize(file_ids: nil, memory_limit: nil, network_policy: nil, type: :auto)
+              #   Configuration for a code interpreter container. Optionally specify the IDs of
+              #   the files to run the code on.
+              #
+              #   @param file_ids [Array<String>] An optional list of uploaded files to make available to your code.
+              #
+              #   @param memory_limit [Symbol, OpenAI::Models::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto::MemoryLimit, nil] The memory limit for the code interpreter container.
+              #
+              #   @param network_policy [OpenAI::Models::Beta::BetaContainerNetworkPolicyDisabled, OpenAI::Models::Beta::BetaContainerNetworkPolicyAllowlist] Network access policy for the container.
+              #
+              #   @param type [Symbol, :auto] Always `auto`.
+
+              # The memory limit for the code interpreter container.
+              #
+              # @see OpenAI::Models::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto#memory_limit
+              module MemoryLimit
+                extend OpenAI::Internal::Type::Enum
+
+                MEMORY_LIMIT_1G = :"1g"
+                MEMORY_LIMIT_4G = :"4g"
+                MEMORY_LIMIT_16G = :"16g"
+                MEMORY_LIMIT_64G = :"64g"
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # Network access policy for the container.
+              #
+              # @see OpenAI::Models::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto#network_policy
+              module NetworkPolicy
+                extend OpenAI::Internal::Type::Union
+
+                discriminator :type
+
+                variant :disabled, -> { OpenAI::Beta::BetaContainerNetworkPolicyDisabled }
+
+                variant :allowlist, -> { OpenAI::Beta::BetaContainerNetworkPolicyAllowlist }
+
+                # @!method self.variants
+                #   @return [Array(OpenAI::Models::Beta::BetaContainerNetworkPolicyDisabled, OpenAI::Models::Beta::BetaContainerNetworkPolicyAllowlist)]
+              end
+            end
+
+            # @!method self.variants
+            #   @return [Array(String, OpenAI::Models::Beta::BetaTool::CodeInterpreter::Container::CodeInterpreterToolAuto)]
+          end
+
+          module AllowedCaller
+            extend OpenAI::Internal::Type::Enum
+
+            DIRECT = :direct
+            PROGRAMMATIC = :programmatic
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class ProgrammaticToolCalling < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the tool. Always `programmatic_tool_calling`.
+          #
+          #   @return [Symbol, :programmatic_tool_calling]
+          required :type, const: :programmatic_tool_calling
+
+          # @!method initialize(type: :programmatic_tool_calling)
+          #   @param type [Symbol, :programmatic_tool_calling] The type of the tool. Always `programmatic_tool_calling`.
+        end
+
+        class ImageGeneration < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the image generation tool. Always `image_generation`.
+          #
+          #   @return [Symbol, :image_generation]
+          required :type, const: :image_generation
+
+          # @!attribute action
+          #   Whether to generate a new image or edit an existing image. Default: `auto`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Action, nil]
+          optional :action, enum: -> { OpenAI::Beta::BetaTool::ImageGeneration::Action }
+
+          # @!attribute background
+          #   Allows to set transparency for the background of the generated image(s). This
+          #   parameter is only supported for GPT image models that support transparent
+          #   backgrounds. Must be one of `transparent`, `opaque`, or `auto` (default value).
+          #   When `auto` is used, the model will automatically determine the best background
+          #   for the image.
+          #
+          #   `gpt-image-2` and `gpt-image-2-2026-04-21` do not support transparent
+          #   backgrounds. Requests with `background` set to `transparent` will return an
+          #   error for these models; use `opaque` or `auto` instead.
+          #
+          #   If `transparent`, the output format needs to support transparency, so it should
+          #   be set to either `png` (default value) or `webp`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Background, nil]
+          optional :background, enum: -> { OpenAI::Beta::BetaTool::ImageGeneration::Background }
+
+          # @!attribute input_fidelity
+          #   Control how much effort the model will exert to match the style and features,
+          #   especially facial features, of input images. This parameter is only supported
+          #   for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for
+          #   `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::InputFidelity, nil]
+          optional :input_fidelity,
+                   enum: -> {
+                     OpenAI::Beta::BetaTool::ImageGeneration::InputFidelity
+                   },
+                   nil?: true
+
+          # @!attribute input_image_mask
+          #   Optional mask for inpainting. Contains `image_url` (string, optional) and
+          #   `file_id` (string, optional).
+          #
+          #   @return [OpenAI::Models::Beta::BetaTool::ImageGeneration::InputImageMask, nil]
+          optional :input_image_mask, -> { OpenAI::Beta::BetaTool::ImageGeneration::InputImageMask }
+
+          # @!attribute model
+          #   The image generation model to use. Default: `gpt-image-1`.
+          #
+          #   @return [String, Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Model, nil]
+          optional :model, union: -> { OpenAI::Beta::BetaTool::ImageGeneration::Model }
+
+          # @!attribute moderation
+          #   Moderation level for the generated image. Default: `auto`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Moderation, nil]
+          optional :moderation, enum: -> { OpenAI::Beta::BetaTool::ImageGeneration::Moderation }
+
+          # @!attribute output_compression
+          #   Compression level for the output image. Default: 100.
+          #
+          #   @return [Integer, nil]
+          optional :output_compression, Integer
+
+          # @!attribute output_format
+          #   The output format of the generated image. One of `png`, `webp`, or `jpeg`.
+          #   Default: `png`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::OutputFormat, nil]
+          optional :output_format, enum: -> { OpenAI::Beta::BetaTool::ImageGeneration::OutputFormat }
+
+          # @!attribute partial_images
+          #   Number of partial images to generate in streaming mode, from 0 (default value)
+          #   to 3.
+          #
+          #   @return [Integer, nil]
+          optional :partial_images, Integer
+
+          # @!attribute quality
+          #   The quality of the generated image. One of `low`, `medium`, `high`, or `auto`.
+          #   Default: `auto`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Quality, nil]
+          optional :quality, enum: -> { OpenAI::Beta::BetaTool::ImageGeneration::Quality }
+
+          # @!attribute size
+          #   The size of the generated images. For `gpt-image-2` and
+          #   `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
+          #   strings, for example `1536x864`. Width and height must both be divisible by 16
+          #   and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
+          #   `2560x1440` are experimental, and the maximum supported resolution is
+          #   `3840x2160`. The requested size must also satisfy the model's current pixel and
+          #   edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
+          #   supported by the GPT image models; `auto` is supported for models that allow
+          #   automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
+          #   `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
+          #   `1024x1792`.
+          #
+          #   @return [String, Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Size, nil]
+          optional :size, union: -> { OpenAI::Beta::BetaTool::ImageGeneration::Size }
+
+          # @!method initialize(action: nil, background: nil, input_fidelity: nil, input_image_mask: nil, model: nil, moderation: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, size: nil, type: :image_generation)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Beta::BetaTool::ImageGeneration} for more details.
+          #
+          #   A tool that generates images using the GPT image models.
+          #
+          #   @param action [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Action] Whether to generate a new image or edit an existing image. Default: `auto`.
+          #
+          #   @param background [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Background] Allows to set transparency for the background of the generated image(s).
+          #
+          #   @param input_fidelity [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::InputFidelity, nil] Control how much effort the model will exert to match the style and features, es
+          #
+          #   @param input_image_mask [OpenAI::Models::Beta::BetaTool::ImageGeneration::InputImageMask] Optional mask for inpainting. Contains `image_url`
+          #
+          #   @param model [String, Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Model] The image generation model to use. Default: `gpt-image-1`.
+          #
+          #   @param moderation [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Moderation] Moderation level for the generated image. Default: `auto`.
+          #
+          #   @param output_compression [Integer] Compression level for the output image. Default: 100.
+          #
+          #   @param output_format [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::OutputFormat] The output format of the generated image. One of `png`, `webp`, or
+          #
+          #   @param partial_images [Integer] Number of partial images to generate in streaming mode, from 0 (default value) t
+          #
+          #   @param quality [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Quality] The quality of the generated image. One of `low`, `medium`, `high`,
+          #
+          #   @param size [String, Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::Size] The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`
+          #
+          #   @param type [Symbol, :image_generation] The type of the image generation tool. Always `image_generation`.
+
+          # Whether to generate a new image or edit an existing image. Default: `auto`.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#action
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            GENERATE = :generate
+            EDIT = :edit
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Allows to set transparency for the background of the generated image(s). This
+          # parameter is only supported for GPT image models that support transparent
+          # backgrounds. Must be one of `transparent`, `opaque`, or `auto` (default value).
+          # When `auto` is used, the model will automatically determine the best background
+          # for the image.
+          #
+          # `gpt-image-2` and `gpt-image-2-2026-04-21` do not support transparent
+          # backgrounds. Requests with `background` set to `transparent` will return an
+          # error for these models; use `opaque` or `auto` instead.
+          #
+          # If `transparent`, the output format needs to support transparency, so it should
+          # be set to either `png` (default value) or `webp`.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#background
+          module Background
+            extend OpenAI::Internal::Type::Enum
+
+            TRANSPARENT = :transparent
+            OPAQUE = :opaque
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Control how much effort the model will exert to match the style and features,
+          # especially facial features, of input images. This parameter is only supported
+          # for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for
+          # `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#input_fidelity
+          module InputFidelity
+            extend OpenAI::Internal::Type::Enum
+
+            HIGH = :high
+            LOW = :low
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#input_image_mask
+          class InputImageMask < OpenAI::Internal::Type::BaseModel
+            # @!attribute file_id
+            #   File ID for the mask image.
+            #
+            #   @return [String, nil]
+            optional :file_id, String
+
+            # @!attribute image_url
+            #   Base64-encoded mask image.
+            #
+            #   @return [String, nil]
+            optional :image_url, String
+
+            # @!method initialize(file_id: nil, image_url: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Beta::BetaTool::ImageGeneration::InputImageMask} for more
+            #   details.
+            #
+            #   Optional mask for inpainting. Contains `image_url` (string, optional) and
+            #   `file_id` (string, optional).
+            #
+            #   @param file_id [String] File ID for the mask image.
+            #
+            #   @param image_url [String] Base64-encoded mask image.
+          end
+
+          # The image generation model to use. Default: `gpt-image-1`.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#model
+          module Model
+            extend OpenAI::Internal::Type::Union
+
+            variant String
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Model::GPT_IMAGE_1 }
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Model::GPT_IMAGE_1_MINI }
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Model::GPT_IMAGE_2 }
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Model::GPT_IMAGE_2_2026_04_21 }
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Model::GPT_IMAGE_1_5 }
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Model::CHATGPT_IMAGE_LATEST }
+
+            # @!method self.variants
+            #   @return [Array(String, Symbol)]
+
+            define_sorbet_constant!(:Variants) do
+              T.type_alias { T.any(String, OpenAI::Beta::BetaTool::ImageGeneration::Model::TaggedSymbol) }
+            end
+
+            # @!group
+
+            GPT_IMAGE_1 = :"gpt-image-1"
+            GPT_IMAGE_1_MINI = :"gpt-image-1-mini"
+            GPT_IMAGE_2 = :"gpt-image-2"
+            GPT_IMAGE_2_2026_04_21 = :"gpt-image-2-2026-04-21"
+            GPT_IMAGE_1_5 = :"gpt-image-1.5"
+            CHATGPT_IMAGE_LATEST = :"chatgpt-image-latest"
+
+            # @!endgroup
+          end
+
+          # Moderation level for the generated image. Default: `auto`.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#moderation
+          module Moderation
+            extend OpenAI::Internal::Type::Enum
+
+            AUTO = :auto
+            LOW = :low
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The output format of the generated image. One of `png`, `webp`, or `jpeg`.
+          # Default: `png`.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#output_format
+          module OutputFormat
+            extend OpenAI::Internal::Type::Enum
+
+            PNG = :png
+            WEBP = :webp
+            JPEG = :jpeg
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The quality of the generated image. One of `low`, `medium`, `high`, or `auto`.
+          # Default: `auto`.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#quality
+          module Quality
+            extend OpenAI::Internal::Type::Enum
+
+            LOW = :low
+            MEDIUM = :medium
+            HIGH = :high
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The size of the generated images. For `gpt-image-2` and
+          # `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
+          # strings, for example `1536x864`. Width and height must both be divisible by 16
+          # and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
+          # `2560x1440` are experimental, and the maximum supported resolution is
+          # `3840x2160`. The requested size must also satisfy the model's current pixel and
+          # edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
+          # supported by the GPT image models; `auto` is supported for models that allow
+          # automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
+          # `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
+          # `1024x1792`.
+          #
+          # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#size
+          module Size
+            extend OpenAI::Internal::Type::Union
+
+            variant String
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Size::SIZE_1024X1024 }
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Size::SIZE_1024X1536 }
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Size::SIZE_1536X1024 }
+
+            variant const: -> { OpenAI::Models::Beta::BetaTool::ImageGeneration::Size::AUTO }
+
+            # @!method self.variants
+            #   @return [Array(String, Symbol)]
+
+            define_sorbet_constant!(:Variants) do
+              T.type_alias { T.any(String, OpenAI::Beta::BetaTool::ImageGeneration::Size::TaggedSymbol) }
+            end
+
+            # @!group
+
+            SIZE_1024X1024 = :"1024x1024"
+            SIZE_1024X1536 = :"1024x1536"
+            SIZE_1536X1024 = :"1536x1024"
+            AUTO = :auto
+
+            # @!endgroup
+          end
+        end
+
+        class LocalShell < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the local shell tool. Always `local_shell`.
+          #
+          #   @return [Symbol, :local_shell]
+          required :type, const: :local_shell
+
+          # @!method initialize(type: :local_shell)
+          #   A tool that allows the model to execute shell commands in a local environment.
+          #
+          #   @param type [Symbol, :local_shell] The type of the local shell tool. Always `local_shell`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool)]
+      end
+    end
+
+    BetaTool = Beta::BetaTool
+  end
+end