Class: OCI::GenerativeAiAgent::Models::IndexSchema

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent/models/index_schema.rb

Overview

The index schema details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IndexSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :body_key (String) —

    The value to assign to the #body_key property

  • :url_key (String) —

    The value to assign to the #url_key property

  • :title_key (String) —

    The value to assign to the #title_key property

  • :embedding_body_key (String) —

    The value to assign to the #embedding_body_key property



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 62

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.body_key = attributes[:'bodyKey'] if attributes[:'bodyKey']

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

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

  self.url_key = attributes[:'urlKey'] if attributes[:'urlKey']

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

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

  self.title_key = attributes[:'titleKey'] if attributes[:'titleKey']

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

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

  self.embedding_body_key = attributes[:'embeddingBodyKey'] if attributes[:'embeddingBodyKey']

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

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

Instance Attribute Details

#body_key ⇒ String

[Required] Body key name.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 14

def body_key
  @body_key
end

#embedding_body_key ⇒ String

Field within customer managed OCI OpenSearch document containing the vector embedding for queries.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 26

def embedding_body_key
  @embedding_body_key
end

#title_key ⇒ String

Title key that stores the Title of a document, if available.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 22

def title_key
  @title_key
end

#url_key ⇒ String

URL key that stores the URL of a document, if available.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 18

def url_key
  @url_key
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
37
38
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'body_key': :'bodyKey',
    'url_key': :'urlKey',
    'title_key': :'titleKey',
    'embedding_body_key': :'embeddingBodyKey'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'body_key': :'String',
    'url_key': :'String',
    'title_key': :'String',
    'embedding_body_key': :'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



100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 100

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

  self.class == other.class &&
    body_key == other.body_key &&
    url_key == other.url_key &&
    title_key == other.title_key &&
    embedding_body_key == other.embedding_body_key
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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 133

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


113
114
115
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



122
123
124
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 122

def hash
  [body_key, url_key, title_key, embedding_body_key].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 166

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



160
161
162
 
# File 'lib/oci/generative_ai_agent/models/index_schema.rb', line 160

def to_s
  to_hash.to_s
end