Class: OpenAI::Models::Responses::WebSearchTool

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::WebSearchTool

Defined in:

lib/openai/models/responses/web_search_tool.rb

Defined Under Namespace

Modules: SearchContextSize, Type Classes: UserLocation

Instance Attribute Summary

• #search_context_size ⇒ Symbol, ...

  High level guidance for the amount of context window space to use for the search.

• #type ⇒ Symbol, OpenAI::Models::Responses::WebSearchTool::Type

  The type of the web search tool.

• #user_location ⇒ OpenAI::Models::Responses::WebSearchTool::UserLocation^?

  The user’s location.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(type: , search_context_size: nil, user_location: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see WebSearchTool for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(type: , search_context_size: nil, user_location: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::WebSearchTool for more details.

This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](platform.openai.com/docs/guides/tools-web-search).

Parameters:

• type (Symbol, OpenAI::Models::Responses::WebSearchTool::Type) (defaults to: ) —

  The type of the web search tool. One of ‘web_search_preview` or `web_search_prev

• search_context_size (Symbol, OpenAI::Models::Responses::WebSearchTool::SearchContextSize) (defaults to: nil) —

  High level guidance for the amount of context window space to use for the search

• user_location (OpenAI::Models::Responses::WebSearchTool::UserLocation, nil) (defaults to: nil) —

  The user’s location.

# File 'lib/openai/models/responses/web_search_tool.rb', line 27

Instance Attribute Details

#search_context_size ⇒ Symbol, ...

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.

Returns:

• (Symbol, OpenAI::Models::Responses::WebSearchTool::SearchContextSize, nil)

# File 'lib/openai/models/responses/web_search_tool.rb', line 19

optional :search_context_size, enum: -> { OpenAI::Responses::WebSearchTool::SearchContextSize }

#type ⇒ Symbol, OpenAI::Models::Responses::WebSearchTool::Type

The type of the web search tool. One of ‘web_search_preview` or `web_search_preview_2025_03_11`.

Returns:

• (Symbol, OpenAI::Models::Responses::WebSearchTool::Type)

# File 'lib/openai/models/responses/web_search_tool.rb', line 12

required :type, enum: -> { OpenAI::Responses::WebSearchTool::Type }

#user_location ⇒ OpenAI::Models::Responses::WebSearchTool::UserLocation^?

The user’s location.

Returns:

• (OpenAI::Models::Responses::WebSearchTool::UserLocation, nil)

# File 'lib/openai/models/responses/web_search_tool.rb', line 25

optional :user_location, -> { OpenAI::Responses::WebSearchTool::UserLocation }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/responses/web_search_tool.rb', line 51