Class: OCI::GenerativeAiInference::Models::WebSearchOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/web_search_options.rb

Overview

Options for performing a web search to augment the response.

Constant Summary collapse

SEARCH_CONTEXT_SIZE_ENUM = 
[
  SEARCH_CONTEXT_SIZE_HIGH = 'HIGH'.freeze,
  SEARCH_CONTEXT_SIZE_MEDIUM = 'MEDIUM'.freeze,
  SEARCH_CONTEXT_SIZE_LOW = 'LOW'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebSearchOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 56

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.search_context_size = attributes[:'searchContextSize'] if attributes[:'searchContextSize']

  raise 'You cannot provide both :searchContextSize and :search_context_size' if attributes.key?(:'searchContextSize') && attributes.key?(:'search_context_size')

  self.search_context_size = attributes[:'search_context_size'] if attributes[:'search_context_size']

  self.user_location = attributes[:'userLocation'] if attributes[:'userLocation']

  raise 'You cannot provide both :userLocation and :user_location' if attributes.key?(:'userLocation') && attributes.key?(:'user_location')

  self.user_location = attributes[:'user_location'] if attributes[:'user_location']
end

Instance Attribute Details

#search_context_size ⇒ String

Specifies the size of the web search context. - HIGH: Most comprehensive context, highest cost, slower response. - MEDIUM: Balanced context, cost, and latency. - LOW: Least context, lowest cost, fastest response, but potentially lower answer quality.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 23

def search_context_size
  @search_context_size
end

#user_location ⇒ OCI::GenerativeAiInference::Models::ApproximateLocation

Returns:



26
27
28
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 26

def user_location
  @user_location
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



29
30
31
32
33
34
35
36
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'search_context_size': :'searchContextSize',
    'user_location': :'userLocation'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'search_context_size': :'String',
    'user_location': :'OCI::GenerativeAiInference::Models::ApproximateLocation'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



90
91
92
93
94
95
96
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 90

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    search_context_size == other.search_context_size &&
    user_location == other.user_location
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 121

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


101
102
103
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 101

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



110
111
112
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 110

def hash
  [search_context_size, user_location].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 154

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



148
149
150
 
# File 'lib/oci/generative_ai_inference/models/web_search_options.rb', line 148

def to_s
  to_hash.to_s
end