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

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/openai/models/responses/web_search_tool.rb

Overview

See Also:

• #user_location

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #city ⇒ String^?

  Free text input for the city of the user, e.g.

• #country ⇒ String^?

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

• #region ⇒ String^?

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

• #timezone ⇒ String^?

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

• #type ⇒ Symbol, ...

  The type of location approximation.

Instance Method Summary

• #initialize(city: nil, country: nil, region: nil, timezone: nil, type: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see UserLocation 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, meta_info, 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(city: nil, country: nil, region: nil, timezone: nil, type: nil) ⇒ Object

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

The approximate location of the user.

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, OpenAI::Models::Responses::WebSearchTool::UserLocation::Type) (defaults to: nil) —

  The type of location approximation. Always ‘approximate`.

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

Instance Attribute Details

#city ⇒ String^?

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

Returns:

• (String, nil)

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

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)

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

optional :country, String, nil?: true

#region ⇒ String^?

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

Returns:

• (String, nil)

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

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)

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

optional :timezone, String, nil?: true

#type ⇒ Symbol, ...

The type of location approximation. Always ‘approximate`.

Returns:

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

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

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