Class: OpenAI::Models::Beta::WebSearchAction::Search

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::WebSearchAction::Search

Defined in:

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

Instance Attribute Summary

• #queries ⇒ Array<String>^?

  The search queries, when multiple queries were used.

• #query ⇒ String^?

  The search query, when a single query was used.

• #type ⇒ Symbol, :search

  The type of the object.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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/web_search_action.rbs', line 23

def initialize: (

Instance Attribute Details

#queries ⇒ Array<String>^?

The search queries, when multiple queries were used.

Parameters:

• value (::Array[String], nil)

Returns:

• (Array<String>, nil)

# File 'lib/openai/models/beta/web_search_action.rb', line 29

required :queries, OpenAI::Internal::Type::ArrayOf[String], nil?: true

#query ⇒ String^?

The search query, when a single query was used.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/web_search_action.rb', line 35

required :query, String, nil?: true

#type ⇒ Symbol, :search

The type of the object. Always search.

Parameters:

• value (:search)

Returns:

• (Symbol, :search)

# File 'lib/openai/models/beta/web_search_action.rb', line 41

required :type, const: :search

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/web_search_action.rbs', line 29

def to_hash: -> {