openai 0.68.0 → 0.69.0

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaToolChoiceAllowed < OpenAI::Internal::Type::BaseModel
+        # @!attribute mode
+        #   Constrains the tools available to the model to a pre-defined set.
+        #
+        #   `auto` allows the model to pick from among the allowed tools and generate a
+        #   message.
+        #
+        #   `required` requires the model to call one or more of the allowed tools.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaToolChoiceAllowed::Mode]
+        required :mode, enum: -> { OpenAI::Beta::BetaToolChoiceAllowed::Mode }
+
+        # @!attribute tools
+        #   A list of tool definitions that the model should be allowed to call.
+        #
+        #   For the Responses API, the list of tool definitions might look like:
+        #
+        #   ```json
+        #   [
+        #     { "type": "function", "name": "get_weather" },
+        #     { "type": "mcp", "server_label": "deepwiki" },
+        #     { "type": "image_generation" }
+        #   ]
+        #   ```
+        #
+        #   @return [Array<Hash{Symbol=>Object}>]
+        required :tools,
+                 OpenAI::Internal::Type::ArrayOf[OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]]
+
+        # @!attribute type
+        #   Allowed tool configuration type. Always `allowed_tools`.
+        #
+        #   @return [Symbol, :allowed_tools]
+        required :type, const: :allowed_tools
+
+        # @!method initialize(mode:, tools:, type: :allowed_tools)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaToolChoiceAllowed} for more details.
+        #
+        #   Constrains the tools available to the model to a pre-defined set.
+        #
+        #   @param mode [Symbol, OpenAI::Models::Beta::BetaToolChoiceAllowed::Mode] Constrains the tools available to the model to a pre-defined set.
+        #
+        #   @param tools [Array<Hash{Symbol=>Object}>] A list of tool definitions that the model should be allowed to call.
+        #
+        #   @param type [Symbol, :allowed_tools] Allowed tool configuration type. Always `allowed_tools`.
+
+        # Constrains the tools available to the model to a pre-defined set.
+        #
+        # `auto` allows the model to pick from among the allowed tools and generate a
+        # message.
+        #
+        # `required` requires the model to call one or more of the allowed tools.
+        #
+        # @see OpenAI::Models::Beta::BetaToolChoiceAllowed#mode
+        module Mode
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO = :auto
+          REQUIRED = :required
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaToolChoiceAllowed = Beta::BetaToolChoiceAllowed
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaToolChoiceApplyPatch < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The tool to call. Always `apply_patch`.
+        #
+        #   @return [Symbol, :apply_patch]
+        required :type, const: :apply_patch
+
+        # @!method initialize(type: :apply_patch)
+        #   Forces the model to call the apply_patch tool when executing a tool call.
+        #
+        #   @param type [Symbol, :apply_patch] The tool to call. Always `apply_patch`.
+      end
+    end
+
+    BetaToolChoiceApplyPatch = Beta::BetaToolChoiceApplyPatch
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaToolChoiceCustom < OpenAI::Internal::Type::BaseModel
+        # @!attribute name
+        #   The name of the custom tool to call.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   For custom tool calling, the type is always `custom`.
+        #
+        #   @return [Symbol, :custom]
+        required :type, const: :custom
+
+        # @!method initialize(name:, type: :custom)
+        #   Use this option to force the model to call a specific custom tool.
+        #
+        #   @param name [String] The name of the custom tool to call.
+        #
+        #   @param type [Symbol, :custom] For custom tool calling, the type is always `custom`.
+      end
+    end
+
+    BetaToolChoiceCustom = Beta::BetaToolChoiceCustom
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaToolChoiceFunction < OpenAI::Internal::Type::BaseModel
+        # @!attribute name
+        #   The name of the function to call.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   For function calling, the type is always `function`.
+        #
+        #   @return [Symbol, :function]
+        required :type, const: :function
+
+        # @!method initialize(name:, type: :function)
+        #   Use this option to force the model to call a specific function.
+        #
+        #   @param name [String] The name of the function to call.
+        #
+        #   @param type [Symbol, :function] For function calling, the type is always `function`.
+      end
+    end
+
+    BetaToolChoiceFunction = Beta::BetaToolChoiceFunction
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaToolChoiceMcp < OpenAI::Internal::Type::BaseModel
+        # @!attribute server_label
+        #   The label of the MCP server to use.
+        #
+        #   @return [String]
+        required :server_label, String
+
+        # @!attribute type
+        #   For MCP tools, the type is always `mcp`.
+        #
+        #   @return [Symbol, :mcp]
+        required :type, const: :mcp
+
+        # @!attribute name
+        #   The name of the tool to call on the server.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(server_label:, name: nil, type: :mcp)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaToolChoiceMcp} for more details.
+        #
+        #   Use this option to force the model to call a specific tool on a remote MCP
+        #   server.
+        #
+        #   @param server_label [String] The label of the MCP server to use.
+        #
+        #   @param name [String, nil] The name of the tool to call on the server.
+        #
+        #   @param type [Symbol, :mcp] For MCP tools, the type is always `mcp`.
+      end
+    end
+
+    BetaToolChoiceMcp = Beta::BetaToolChoiceMcp
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # Controls which (if any) tool is called by the model.
+      #
+      # `none` means the model will not call any tool and instead generates a message.
+      #
+      # `auto` means the model can pick between generating a message or calling one or
+      # more tools.
+      #
+      # `required` means the model must call one or more tools.
+      module BetaToolChoiceOptions
+        extend OpenAI::Internal::Type::Enum
+
+        NONE = :none
+        AUTO = :auto
+        REQUIRED = :required
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+
+    BetaToolChoiceOptions = Beta::BetaToolChoiceOptions
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaToolChoiceShell < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The tool to call. Always `shell`.
+        #
+        #   @return [Symbol, :shell]
+        required :type, const: :shell
+
+        # @!method initialize(type: :shell)
+        #   Forces the model to call the shell tool when a tool call is required.
+        #
+        #   @param type [Symbol, :shell] The tool to call. Always `shell`.
+      end
+    end
+
+    BetaToolChoiceShell = Beta::BetaToolChoiceShell
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaToolChoiceTypes < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of hosted tool the model should to use. Learn more about
+        #   [built-in tools](https://platform.openai.com/docs/guides/tools).
+        #
+        #   Allowed values are:
+        #
+        #   - `file_search`
+        #   - `web_search_preview`
+        #   - `computer`
+        #   - `computer_use_preview`
+        #   - `computer_use`
+        #   - `code_interpreter`
+        #   - `image_generation`
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaToolChoiceTypes::Type]
+        required :type, enum: -> { OpenAI::Beta::BetaToolChoiceTypes::Type }
+
+        # @!method initialize(type:)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaToolChoiceTypes} for more details.
+        #
+        #   Indicates that the model should use a built-in tool to generate a response.
+        #   [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
+        #
+        #   @param type [Symbol, OpenAI::Models::Beta::BetaToolChoiceTypes::Type] The type of hosted tool the model should to use. Learn more about
+
+        # The type of hosted tool the model should to use. Learn more about
+        # [built-in tools](https://platform.openai.com/docs/guides/tools).
+        #
+        # Allowed values are:
+        #
+        # - `file_search`
+        # - `web_search_preview`
+        # - `computer`
+        # - `computer_use_preview`
+        # - `computer_use`
+        # - `code_interpreter`
+        # - `image_generation`
+        #
+        # @see OpenAI::Models::Beta::BetaToolChoiceTypes#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          FILE_SEARCH = :file_search
+          WEB_SEARCH_PREVIEW = :web_search_preview
+          COMPUTER = :computer
+          COMPUTER_USE_PREVIEW = :computer_use_preview
+          COMPUTER_USE = :computer_use
+          WEB_SEARCH_PREVIEW_2025_03_11 = :web_search_preview_2025_03_11
+          IMAGE_GENERATION = :image_generation
+          CODE_INTERPRETER = :code_interpreter
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaToolChoiceTypes = Beta::BetaToolChoiceTypes
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaToolSearchTool < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the tool. Always `tool_search`.
+        #
+        #   @return [Symbol, :tool_search]
+        required :type, const: :tool_search
+
+        # @!attribute description
+        #   Description shown to the model for a client-executed tool search tool.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute execution
+        #   Whether tool search is executed by the server or by the client.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaToolSearchTool::Execution, nil]
+        optional :execution, enum: -> { OpenAI::Beta::BetaToolSearchTool::Execution }
+
+        # @!attribute parameters
+        #   Parameter schema for a client-executed tool search tool.
+        #
+        #   @return [Object, nil]
+        optional :parameters, OpenAI::Internal::Type::Unknown, nil?: true
+
+        # @!method initialize(description: nil, execution: nil, parameters: nil, type: :tool_search)
+        #   Hosted or BYOT tool search configuration for deferred tools.
+        #
+        #   @param description [String, nil] Description shown to the model for a client-executed tool search tool.
+        #
+        #   @param execution [Symbol, OpenAI::Models::Beta::BetaToolSearchTool::Execution] Whether tool search is executed by the server or by the client.
+        #
+        #   @param parameters [Object, nil] Parameter schema for a client-executed tool search tool.
+        #
+        #   @param type [Symbol, :tool_search] The type of the tool. Always `tool_search`.
+
+        # Whether tool search is executed by the server or by the client.
+        #
+        # @see OpenAI::Models::Beta::BetaToolSearchTool#execution
+        module Execution
+          extend OpenAI::Internal::Type::Enum
+
+          SERVER = :server
+          CLIENT = :client
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaToolSearchTool = Beta::BetaToolSearchTool
+  end
+end

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaWebSearchPreviewTool < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the web search tool. One of `web_search_preview` or
+        #   `web_search_preview_2025_03_11`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::Type]
+        required :type, enum: -> { OpenAI::Beta::BetaWebSearchPreviewTool::Type }
+
+        # @!attribute search_content_types
+        #
+        #   @return [Array<Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::SearchContentType>, nil]
+        optional :search_content_types,
+                 -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::BetaWebSearchPreviewTool::SearchContentType] }
+
+        # @!attribute search_context_size
+        #   High level guidance for the amount of context window space to use for the
+        #   search. One of `low`, `medium`, or `high`. `medium` is the default.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::SearchContextSize, nil]
+        optional :search_context_size, enum: -> { OpenAI::Beta::BetaWebSearchPreviewTool::SearchContextSize }
+
+        # @!attribute user_location
+        #   The user's location.
+        #
+        #   @return [OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation, nil]
+        optional :user_location, -> { OpenAI::Beta::BetaWebSearchPreviewTool::UserLocation }, nil?: true
+
+        # @!method initialize(type:, search_content_types: nil, search_context_size: nil, user_location: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaWebSearchPreviewTool} for more details.
+        #
+        #   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).
+        #
+        #   @param type [Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::Type] The type of the web search tool. One of `web_search_preview` or `web_search_prev
+        #
+        #   @param search_content_types [Array<Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::SearchContentType>]
+        #
+        #   @param search_context_size [Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::SearchContextSize] High level guidance for the amount of context window space to use for the search
+        #
+        #   @param user_location [OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation, nil] The user's location.
+
+        # The type of the web search tool. One of `web_search_preview` or
+        # `web_search_preview_2025_03_11`.
+        #
+        # @see OpenAI::Models::Beta::BetaWebSearchPreviewTool#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          WEB_SEARCH_PREVIEW = :web_search_preview
+          WEB_SEARCH_PREVIEW_2025_03_11 = :web_search_preview_2025_03_11
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module SearchContentType
+          extend OpenAI::Internal::Type::Enum
+
+          TEXT = :text
+          IMAGE = :image
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # High level guidance for the amount of context window space to use for the
+        # search. One of `low`, `medium`, or `high`. `medium` is the default.
+        #
+        # @see OpenAI::Models::Beta::BetaWebSearchPreviewTool#search_context_size
+        module SearchContextSize
+          extend OpenAI::Internal::Type::Enum
+
+          LOW = :low
+          MEDIUM = :medium
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaWebSearchPreviewTool#user_location
+        class UserLocation < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of location approximation. Always `approximate`.
+          #
+          #   @return [Symbol, :approximate]
+          required :type, const: :approximate
+
+          # @!attribute city
+          #   Free text input for the city of the user, e.g. `San Francisco`.
+          #
+          #   @return [String, nil]
+          optional :city, String, nil?: true
+
+          # @!attribute country
+          #   The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+          #   the user, e.g. `US`.
+          #
+          #   @return [String, nil]
+          optional :country, String, nil?: true
+
+          # @!attribute region
+          #   Free text input for the region of the user, e.g. `California`.
+          #
+          #   @return [String, nil]
+          optional :region, String, nil?: true
+
+          # @!attribute timezone
+          #   The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+          #   user, e.g. `America/Los_Angeles`.
+          #
+          #   @return [String, nil]
+          optional :timezone, String, nil?: true
+
+          # @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: :approximate)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation} for more details.
+          #
+          #   The user's location.
+          #
+          #   @param city [String, nil] Free text input for the city of the user, e.g. `San Francisco`.
+          #
+          #   @param country [String, nil] The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of t
+          #
+          #   @param region [String, nil] Free text input for the region of the user, e.g. `California`.
+          #
+          #   @param timezone [String, nil] The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user
+          #
+          #   @param type [Symbol, :approximate] The type of location approximation. Always `approximate`.
+        end
+      end
+    end
+
+    BetaWebSearchPreviewTool = Beta::BetaWebSearchPreviewTool
+  end
+end

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

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaWebSearchTool < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::Type]
+        required :type, enum: -> { OpenAI::Beta::BetaWebSearchTool::Type }
+
+        # @!attribute filters
+        #   Filters for the search.
+        #
+        #   @return [OpenAI::Models::Beta::BetaWebSearchTool::Filters, nil]
+        optional :filters, -> { OpenAI::Beta::BetaWebSearchTool::Filters }, nil?: true
+
+        # @!attribute search_context_size
+        #   High level guidance for the amount of context window space to use for the
+        #   search. One of `low`, `medium`, or `high`. `medium` is the default.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::SearchContextSize, nil]
+        optional :search_context_size, enum: -> { OpenAI::Beta::BetaWebSearchTool::SearchContextSize }
+
+        # @!attribute user_location
+        #   The approximate location of the user.
+        #
+        #   @return [OpenAI::Models::Beta::BetaWebSearchTool::UserLocation, nil]
+        optional :user_location, -> { OpenAI::Beta::BetaWebSearchTool::UserLocation }, nil?: true
+
+        # @!method initialize(type:, filters: nil, search_context_size: nil, user_location: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaWebSearchTool} for more details.
+        #
+        #   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).
+        #
+        #   @param type [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::Type] The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+        #
+        #   @param filters [OpenAI::Models::Beta::BetaWebSearchTool::Filters, nil] Filters for the search.
+        #
+        #   @param search_context_size [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::SearchContextSize] High level guidance for the amount of context window space to use for the search
+        #
+        #   @param user_location [OpenAI::Models::Beta::BetaWebSearchTool::UserLocation, nil] The approximate location of the user.
+
+        # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+        #
+        # @see OpenAI::Models::Beta::BetaWebSearchTool#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          WEB_SEARCH = :web_search
+          WEB_SEARCH_2025_08_26 = :web_search_2025_08_26
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaWebSearchTool#filters
+        class Filters < OpenAI::Internal::Type::BaseModel
+          # @!attribute allowed_domains
+          #   Allowed domains for the search. If not provided, all domains are allowed.
+          #   Subdomains of the provided domains are allowed as well.
+          #
+          #   Example: `["pubmed.ncbi.nlm.nih.gov"]`
+          #
+          #   @return [Array<String>, nil]
+          optional :allowed_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!method initialize(allowed_domains: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Beta::BetaWebSearchTool::Filters} for more details.
+          #
+          #   Filters for the search.
+          #
+          #   @param allowed_domains [Array<String>, nil] Allowed domains for the search. If not provided, all domains are allowed.
+        end
+
+        # High level guidance for the amount of context window space to use for the
+        # search. One of `low`, `medium`, or `high`. `medium` is the default.
+        #
+        # @see OpenAI::Models::Beta::BetaWebSearchTool#search_context_size
+        module SearchContextSize
+          extend OpenAI::Internal::Type::Enum
+
+          LOW = :low
+          MEDIUM = :medium
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaWebSearchTool#user_location
+        class UserLocation < OpenAI::Internal::Type::BaseModel
+          # @!attribute city
+          #   Free text input for the city of the user, e.g. `San Francisco`.
+          #
+          #   @return [String, nil]
+          optional :city, String, nil?: true
+
+          # @!attribute country
+          #   The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+          #   the user, e.g. `US`.
+          #
+          #   @return [String, nil]
+          optional :country, String, nil?: true
+
+          # @!attribute region
+          #   Free text input for the region of the user, e.g. `California`.
+          #
+          #   @return [String, nil]
+          optional :region, String, nil?: true
+
+          # @!attribute timezone
+          #   The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+          #   user, e.g. `America/Los_Angeles`.
+          #
+          #   @return [String, nil]
+          optional :timezone, String, nil?: true
+
+          # @!attribute type
+          #   The type of location approximation. Always `approximate`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::UserLocation::Type, nil]
+          optional :type, enum: -> { OpenAI::Beta::BetaWebSearchTool::UserLocation::Type }
+
+          # @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Beta::BetaWebSearchTool::UserLocation} for more details.
+          #
+          #   The approximate location of the user.
+          #
+          #   @param city [String, nil] Free text input for the city of the user, e.g. `San Francisco`.
+          #
+          #   @param country [String, nil] The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of t
+          #
+          #   @param region [String, nil] Free text input for the region of the user, e.g. `California`.
+          #
+          #   @param timezone [String, nil] The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user
+          #
+          #   @param type [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::UserLocation::Type] The type of location approximation. Always `approximate`.
+
+          # The type of location approximation. Always `approximate`.
+          #
+          # @see OpenAI::Models::Beta::BetaWebSearchTool::UserLocation#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            APPROXIMATE = :approximate
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+
+    BetaWebSearchTool = Beta::BetaWebSearchTool
+  end
+end