Class: OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search::Source

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_function_web_search.rb

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

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

Action type “search” - Performs a web search query.

Parameters:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/openai/models/responses/response_function_web_search.rb', line 99

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::Responses::ResponseFunctionWebSearch::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`.

Returns:

  • (Symbol, :url) 


104
 
# File 'lib/openai/models/responses/response_function_web_search.rb', line 104

required :type, const: :url

#url ⇒ String

The URL of the source.

Returns:

  • (String) 


110
 
# File 'lib/openai/models/responses/response_function_web_search.rb', line 110

required :url, String