Class: OCI::GenerativeAiInference::Models::UrlCitation

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

Overview

Contains metadata for a cited URL included in the assistantu2019s response. Includes the cited URL and title, and the character range (start and end indices) in the response content where the citation applies.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UrlCitation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :start_index (Integer) —

    The value to assign to the #start_index property

  • :end_index (Integer) —

    The value to assign to the #end_index property

  • :title (String) —

    The value to assign to the #title property

  • :url (String) —

    The value to assign to the #url property



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/generative_ai_inference/models/url_citation.rb', line 64

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_index = attributes[:'startIndex'] if attributes[:'startIndex']

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

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

  self.end_index = attributes[:'endIndex'] if attributes[:'endIndex']

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

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

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

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

Instance Attribute Details

#end_index ⇒ Integer

End character index in the response where the citation ends.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/oci/generative_ai_inference/models/url_citation.rb', line 20

def end_index
  @end_index
end

#start_index ⇒ Integer

Start character index in the response where the citation begins.

Returns:

  • (Integer) 


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

def start_index
  @start_index
end

#title ⇒ String

Title of the cited source.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/generative_ai_inference/models/url_citation.rb', line 24

def title
  @title
end

#url ⇒ String

URL of the cited source.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/generative_ai_inference/models/url_citation.rb', line 28

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'start_index': :'startIndex',
    'end_index': :'endIndex',
    'title': :'title',
    'url': :'url'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/generative_ai_inference/models/url_citation.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'start_index': :'Integer',
    'end_index': :'Integer',
    'title': :'String',
    'url': :'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



94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/generative_ai_inference/models/url_citation.rb', line 94

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

  self.class == other.class &&
    start_index == other.start_index &&
    end_index == other.end_index &&
    title == other.title &&
    url == other.url
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



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

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


107
108
109
 
# File 'lib/oci/generative_ai_inference/models/url_citation.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/oci/generative_ai_inference/models/url_citation.rb', line 116

def hash
  [start_index, end_index, title, url].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/generative_ai_inference/models/url_citation.rb', line 160

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



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

def to_s
  to_hash.to_s
end