Class: OCI::GenerativeAiInference::Models::Citation

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

Overview

A section of the generated reply which cites external knowledge.

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):

  • :start (Integer) —

    The value to assign to the #start property

  • :_end (Integer) —

    The value to assign to the #_end property

  • :text (String) —

    The value to assign to the #text property

  • :document_ids (Array<String>) —

    The value to assign to the #document_ids property



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/generative_ai_inference/models/citation.rb', line 61

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

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

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

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

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

  self.document_ids = attributes[:'documentIds'] if attributes[:'documentIds']

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

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

Instance Attribute Details

#_end ⇒ Integer

[Required] The index of text that the citation ends after, counting from zero.

Returns:

  • (Integer) 


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

def _end
  @_end
end

#document_ids ⇒ Array<String>

[Required] Identifiers of documents cited by this section of the generated reply.

Returns:

  • (Array<String>) 


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

def document_ids
  @document_ids
end

#start ⇒ Integer

[Required] The index of text that the citation starts at, counting from zero.

Returns:

  • (Integer) 


13
14
15
 
# File 'lib/oci/generative_ai_inference/models/citation.rb', line 13

def start
  @start
end

#text ⇒ String

[Required] The text of the citation

Returns:

  • (String) 


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

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'start': :'start',
    '_end': :'end',
    'text': :'text',
    'document_ids': :'documentIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/generative_ai_inference/models/citation.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'start': :'Integer',
    '_end': :'Integer',
    'text': :'String',
    'document_ids': :'Array<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



91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/generative_ai_inference/models/citation.rb', line 91

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

  self.class == other.class &&
    start == other.start &&
    _end == other._end &&
    text == other.text &&
    document_ids == other.document_ids
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



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

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


104
105
106
 
# File 'lib/oci/generative_ai_inference/models/citation.rb', line 104

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



113
114
115
 
# File 'lib/oci/generative_ai_inference/models/citation.rb', line 113

def hash
  [start, _end, text, document_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/generative_ai_inference/models/citation.rb', line 157

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



151
152
153
 
# File 'lib/oci/generative_ai_inference/models/citation.rb', line 151

def to_s
  to_hash.to_s
end