Class: OCI::GenerativeAiInference::Models::CohereDocumentContentV2

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

Overview

Represents a single instance of Chat Document content

Constant Summary

Constants inherited from CohereContentV2

OCI::GenerativeAiInference::Models::CohereContentV2::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CohereContentV2

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CohereContentV2

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CohereDocumentContentV2

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :document (Object) —

    The value to assign to the #document property



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'DOCUMENT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

Instance Attribute Details

#document ⇒ Object

Relevant information that could be used by the model to generate a more accurate reply. The content of each document are generally short (should be under 300 words). Metadata should be used to provide additional information, both the key name and the value will be passed to the model.

Returns:

  • (Object) 


14
15
16
 
# File 'lib/oci/generative_ai_inference/models/cohere_document_content_v2.rb', line 14

def document
  @document
end

Class Method Details

.attribute_map ⇒ Object

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



17
18
19
20
21
22
23
24
 
# File 'lib/oci/generative_ai_inference/models/cohere_document_content_v2.rb', line 17

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

.swagger_types ⇒ Object

Attribute type mapping.



27
28
29
30
31
32
33
34
 
# File 'lib/oci/generative_ai_inference/models/cohere_document_content_v2.rb', line 27

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



63
64
65
66
67
68
69
 
# File 'lib/oci/generative_ai_inference/models/cohere_document_content_v2.rb', line 63

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

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/generative_ai_inference/models/cohere_document_content_v2.rb', line 94

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


74
75
76
 
# File 'lib/oci/generative_ai_inference/models/cohere_document_content_v2.rb', line 74

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



83
84
85
 
# File 'lib/oci/generative_ai_inference/models/cohere_document_content_v2.rb', line 83

def hash
  [type, document].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/generative_ai_inference/models/cohere_document_content_v2.rb', line 127

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



121
122
123
 
# File 'lib/oci/generative_ai_inference/models/cohere_document_content_v2.rb', line 121

def to_s
  to_hash.to_s
end