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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation

Defined in:

lib/openai/models/chat/completion_create_params.rb,
sig/openai/models/chat/completion_create_params.rbs

Overview

See Also:

• OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions#user_location

Defined Under Namespace

Classes: Approximate

Instance Attribute Summary

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

  Approximate location parameters for the search.

• #type ⇒ Symbol, :approximate

  The type of location approximation.

Instance Method Summary

• #initialize(approximate:, type: :approximate) ⇒ Object constructor

  Some parameter documentations has been truncated, see UserLocation for more details.

• #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(approximate:, type: :approximate) ⇒ Object

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

Approximate location parameters for the search.

Parameters:

• approximate (OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate) —

  Approximate location parameters for the search.

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

  The type of location approximation. Always approximate.

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

Instance Attribute Details

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

Approximate location parameters for the search.

Parameters:

• value (OpenAI::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate)

Returns:

• (OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation::Approximate)

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

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

#type ⇒ Symbol, :approximate

The type of location approximation. Always approximate.

Parameters:

• value (:approximate)

Returns:

• (Symbol, :approximate)

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

required :type, const: :approximate

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/chat/completion_create_params.rbs', line 572

def to_hash: -> {