Class: OCI::GenerativeAiAgentRuntime::Models::OciOpenSearchSourceLocation

Inherits:
SourceLocation
  • Object
show all
Defined in:
lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb

Overview

The location of the OCI Search with OpenSearch that the agent will use.

Constant Summary

Constants inherited from SourceLocation

SourceLocation::SOURCE_LOCATION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from SourceLocation

#source_location_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SourceLocation

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ OciOpenSearchSourceLocation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :index_name (String) —

    The value to assign to the #index_name property

  • :url (String) —

    The value to assign to the #url property



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 58

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

  attributes['sourceLocationType'] = 'OCI_OPEN_SEARCH'

  super(attributes)

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

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

  self.index_name = attributes[:'indexName'] if attributes[:'indexName']

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

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

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

Instance Attribute Details

#id ⇒ String

The OCID of the OCI OpenSearch cluster.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 15

def id
  @id
end

#index_name ⇒ String

The name of the index in OpenSearch that contains the source text.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 19

def index_name
  @index_name
end

#url ⇒ String

The URL of the retrieved document, if available.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 23

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source_location_type': :'sourceLocationType',
    'id': :'id',
    'index_name': :'indexName',
    'url': :'url'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source_location_type': :'String',
    'id': :'String',
    'index_name': :'String',
    'url': :'String'
    # 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



86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 86

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

  self.class == other.class &&
    source_location_type == other.source_location_type &&
    id == other.id &&
    index_name == other.index_name &&
    url == other.url
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



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

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


99
100
101
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 99

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



108
109
110
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 108

def hash
  [source_location_type, id, index_name, url].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 152

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



146
147
148
 
# File 'lib/oci/generative_ai_agent_runtime/models/oci_open_search_source_location.rb', line 146

def to_s
  to_hash.to_s
end