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

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

Overview

See Also:

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, 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(city: nil, country: nil, region: nil, timezone: nil) ⇒ Object

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

Approximate location parameters for the search.

Parameters:

  • city (String) (defaults to: nil) —

    Free text input for the city of the user, e.g. ‘San Francisco`.

  • country (String) (defaults to: nil) —

    The two-letter

  • region (String) (defaults to: nil) —

    Free text input for the region of the user, e.g. ‘California`.

  • timezone (String) (defaults to: nil) —

    The [IANA timezone](timeapi.io/documentation/iana-timezones)




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

Instance Attribute Details

#city ⇒ String?

Free text input for the city of the user, e.g. ‘San Francisco`.

Returns:

  • (String, nil) 


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

optional :city, String

#country ⇒ String?

The two-letter [ISO country code](en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. ‘US`.

Returns:

  • (String, nil) 


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

optional :country, String

#region ⇒ String?

Free text input for the region of the user, e.g. ‘California`.

Returns:

  • (String, nil) 


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

optional :region, String

#timezone ⇒ String?

The [IANA timezone](timeapi.io/documentation/iana-timezones) of the user, e.g. ‘America/Los_Angeles`.

Returns:

  • (String, nil) 


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

optional :timezone, String