Class: OCI::GenerativeAiInference::Models::CohereCitationV2

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

Overview

A source reference or citation for a piece of content.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_TEXT_CONTENT = 'TEXT_CONTENT'.freeze,
  TYPE_THINKING_CONTENT = 'THINKING_CONTENT'.freeze,
  TYPE_PLAN = 'PLAN'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CohereCitationV2

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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_inference/models/cohere_citation_v2.rb', line 83

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

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

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

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

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

Instance Attribute Details

#_end ⇒ Integer

End index of the cited snippet in the original source text.

Returns:

  • (Integer) 


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

def _end
  @_end
end

#content_index ⇒ Integer

Index of the content block in which this citation appears.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 33

def content_index
  @content_index
end

#sources ⇒ Array<OCI::GenerativeAiInference::Models::CohereCitationSourceV2>

List of source objects for this citation.

Returns:



41
42
43
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 41

def sources
  @sources
end

#start ⇒ Integer

Start index of the cited snippet in the original source text.

Returns:

  • (Integer) 


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

def start
  @start
end

#text ⇒ String

Text snippet that is being cited.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 29

def text
  @text
end

#type ⇒ String

The type of citation indicating what part of the response it is for.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 37

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'start': :'start',
    '_end': :'end',
    'text': :'text',
    'content_index': :'contentIndex',
    'type': :'type',
    'sources': :'sources'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'start': :'Integer',
    '_end': :'Integer',
    'text': :'String',
    'content_index': :'Integer',
    'type': :'String',
    'sources': :'Array<OCI::GenerativeAiInference::Models::CohereCitationSourceV2>'
    # 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



130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 130

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

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 165

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


145
146
147
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



154
155
156
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 154

def hash
  [start, _end, text, content_index, type, sources].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 198

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



192
193
194
 
# File 'lib/oci/generative_ai_inference/models/cohere_citation_v2.rb', line 192

def to_s
  to_hash.to_s
end