Class: OCI::GenerativeAiInference::Models::Annotation

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

Overview

An annotation attached to the assistant's message, used to represent additional metadata such as citations.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Annotation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 49

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

  self.url_citation = attributes[:'urlCitation'] if attributes[:'urlCitation']

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

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

Instance Attribute Details

#type ⇒ String

Type of annotation. For web search citations, this is url_citation.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 16

def type
  @type
end

#url_citation ⇒ OCI::GenerativeAiInference::Models::UrlCitation

Returns:



19
20
21
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 19

def url_citation
  @url_citation
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'url_citation': :'urlCitation'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 32

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'url_citation': :'OCI::GenerativeAiInference::Models::UrlCitation'
    # 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



71
72
73
74
75
76
77
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 71

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

  self.class == other.class &&
    type == other.type &&
    url_citation == other.url_citation
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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 102

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


82
83
84
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 82

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



91
92
93
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 91

def hash
  [type, url_citation].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 135

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



129
130
131
 
# File 'lib/oci/generative_ai_inference/models/annotation.rb', line 129

def to_s
  to_hash.to_s
end