Class: OpenAI::Models::Beta::BetaResponseFunctionWebSearch::Action::Search::Source

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_function_web_search.rb,
sig/openai/models/beta/beta_response_function_web_search.rbs

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, 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(queries: nil, query: nil, sources: nil, type: :search) ⇒ Source

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaResponseFunctionWebSearch::Action::Search for more details.

Action type "search" - Performs a web search query.

Parameters:

  • queries (Array<String>) (defaults to: nil) —

    The search queries.

  • query (String) (defaults to: nil) —

    The search query.

  • sources (Array<OpenAI::Models::Beta::BetaResponseFunctionWebSearch::Action::Search::Source>) (defaults to: nil) —

    The sources used in the search.

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

    The action type.

  • url: (String)
  • type: (:url) (defaults to: :search) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/openai/models/beta/beta_response_function_web_search.rb', line 117

class Source < OpenAI::Internal::Type::BaseModel
  # @!attribute type
  #   The type of source. Always `url`.
  #
  #   @return [Symbol, :url]
  required :type, const: :url

  # @!attribute url
  #   The URL of the source.
  #
  #   @return [String]
  required :url, String

  # @!method initialize(url:, type: :url)
  #   Some parameter documentations has been truncated, see
  #   {OpenAI::Models::Beta::BetaResponseFunctionWebSearch::Action::Search::Source}
  #   for more details.
  #
  #   A source used in the search.
  #
  #   @param url [String] The URL of the source.
  #
  #   @param type [Symbol, :url] The type of source. Always `url`.
end

Instance Attribute Details

#type ⇒ Symbol, :url

The type of source. Always url.

Parameters:

  • value (:url)

Returns:

  • (Symbol, :url) 


122
 
# File 'lib/openai/models/beta/beta_response_function_web_search.rb', line 122

required :type, const: :url

#url ⇒ String

The URL of the source.

Parameters:

  • value (String)

Returns:

  • (String) 


128
 
# File 'lib/openai/models/beta/beta_response_function_web_search.rb', line 128

required :url, String

Instance Method Details

#to_hash ⇒ { type: :url, url: String }

Returns:

  • ({ type: :url, url: String }) 


98
 
# File 'sig/openai/models/beta/beta_response_function_web_search.rbs', line 98

def to_hash: -> { type: :url, url: String }