Class: OCI::GenerativeAiAgentRuntime::Models::Citation

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

Overview

The source of information for the agent's response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Citation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 75

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

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

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

  self.source_location = attributes[:'sourceLocation'] if attributes[:'sourceLocation']

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

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

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

  self.doc_id = attributes[:'docId'] if attributes[:'docId']

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

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

  self.page_numbers = attributes[:'pageNumbers'] if attributes[:'pageNumbers']

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

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

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

Instance Attribute Details

#doc_id ⇒ String

The id of the retrieved document, if available.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 25

def doc_id
  @doc_id
end

#metadata ⇒ Hash<String, Object>

The metadata of the retrieved document, if available.

Returns:

  • (Hash<String, Object>) 


33
34
35
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 33

def metadata
  @metadata
end

#page_numbers ⇒ Array<Integer>

The page numbers on the retrieved document, if available.

Returns:

  • (Array<Integer>) 


29
30
31
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 29

def page_numbers
  @page_numbers
end

#source_location ⇒ OCI::GenerativeAiAgentRuntime::Models::SourceLocation

Returns:



17
18
19
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 17

def source_location
  @source_location
end

#source_text ⇒ String

The text that's the source for the agent's response.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 14

def source_text
  @source_text
end

#title ⇒ String

The title of the source text, if available.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 21

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source_text': :'sourceText',
    'source_location': :'sourceLocation',
    'title': :'title',
    'doc_id': :'docId',
    'page_numbers': :'pageNumbers',
    'metadata': :'metadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source_text': :'String',
    'source_location': :'OCI::GenerativeAiAgentRuntime::Models::SourceLocation',
    'title': :'String',
    'doc_id': :'String',
    'page_numbers': :'Array<Integer>',
    'metadata': :'Hash<String, Object>'
    # 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



117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 117

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

  self.class == other.class &&
    source_text == other.source_text &&
    source_location == other.source_location &&
    title == other.title &&
    doc_id == other.doc_id &&
    page_numbers == other.page_numbers &&
    metadata == other.metadata
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 152

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


132
133
134
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



141
142
143
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 141

def hash
  [source_text, source_location, title, doc_id, page_numbers, metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 185

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



179
180
181
 
# File 'lib/oci/generative_ai_agent_runtime/models/citation.rb', line 179

def to_s
  to_hash.to_s
end