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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/web_search_tool.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, type: :approximate) ⇒ Object

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

The user’s location.

Parameters:

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

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

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

    The two-letter [ISO country code](en.wikipedia.org/wiki/ISO_3166-1) of t

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

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

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

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

  • type (Symbol, :approximate) (defaults to: :approximate) —

    The type of location approximation. Always ‘approximate`.




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

Instance Attribute Details

#city ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :city, String, nil?: true

#country ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :country, String, nil?: true

#region ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :region, String, nil?: true

#timezone ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :timezone, String, nil?: true

#type ⇒ Symbol, :approximate

The type of location approximation. Always ‘approximate`.

Returns:

  • (Symbol, :approximate) 


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

required :type, const: :approximate