Class: OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/chat/completion_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Approximate

Instance Attribute Summary collapse

Instance Method Summary collapse

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, new_coerce_state, 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(approximate: , type: :approximate) ⇒ void

Some parameter documentations has been truncated, see OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation for more details.

Approximate location parameters for the search.

Parameters:




# File 'lib/openai/models/chat/completion_create_params.rb', line 685

Instance Attribute Details

#approximate ⇒ OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate

Approximate location parameters for the search.

Returns:



676
677
 
# File 'lib/openai/models/chat/completion_create_params.rb', line 676

required :approximate,
-> { OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate }

#type ⇒ Symbol, :approximate

The type of location approximation. Always approximate.

Returns:

  • (Symbol, :approximate) 


683
 
# File 'lib/openai/models/chat/completion_create_params.rb', line 683

required :type, const: :approximate