Class: OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation

Defined in:

lib/openai/models/beta/beta_web_search_preview_tool.rb,
sig/openai/models/beta/beta_web_search_preview_tool.rbs

Overview

See Also:

• OpenAI::Models::Beta::BetaWebSearchPreviewTool#user_location

Instance Attribute Summary

• #city ⇒ String^?

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

• #country ⇒ String^?

  The two-letter ISO country code of the user, e.g.

• #region ⇒ String^?

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

• #timezone ⇒ String^?

  The IANA timezone of the user, e.g.

• #type ⇒ Symbol, :approximate

  The type of location approximation.

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/openai/models/beta/beta_web_search_preview_tool.rbs', line 99

def initialize: (

Instance Attribute Details

#city ⇒ String^?

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/beta_web_search_preview_tool.rb', line 100

optional :city, String, nil?: true

#country ⇒ String^?

The two-letter ISO country code of the user, e.g. US.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/beta_web_search_preview_tool.rb', line 107

optional :country, String, nil?: true

#region ⇒ String^?

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/beta_web_search_preview_tool.rb', line 113

optional :region, String, nil?: true

#timezone ⇒ String^?

The IANA timezone of the user, e.g. America/Los_Angeles.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/beta_web_search_preview_tool.rb', line 120

optional :timezone, String, nil?: true

#type ⇒ Symbol, :approximate

The type of location approximation. Always approximate.

Parameters:

• value (:approximate)

Returns:

• (Symbol, :approximate)

# File 'lib/openai/models/beta/beta_web_search_preview_tool.rb', line 94

required :type, const: :approximate

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/beta_web_search_preview_tool.rbs', line 107

def to_hash: -> {