Class: OCI::GenerativeAiInference::Models::EmbedTextResult

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

Overview

The generated embedded result to return.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmbedTextResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/generative_ai_inference/models/embed_text_result.rb', line 88

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

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

  self.embed_contents = attributes[:'embedContents'] if attributes[:'embedContents']

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

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

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

  self.embeddings_by_type = attributes[:'embeddingsByType'] if attributes[:'embeddingsByType']

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

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

  self.model_id = attributes[:'modelId'] if attributes[:'modelId']

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

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

  self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion']

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

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

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

Instance Attribute Details

#embed_contents ⇒ Array<OCI::GenerativeAiInference::Models::EmbedContent>

The original inputs. Only present if "isEcho" is set to true.

Returns:



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

def embed_contents
  @embed_contents
end

#embeddings ⇒ Array<Array<Float>>

[Required] The embeddings corresponding to float.

Returns:

  • (Array<Array<Float>>) 


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

def embeddings
  @embeddings
end

#embeddings_by_type ⇒ Object

The embeddings corresponding to embedding types input.

Returns:

  • (Object) 


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

def embeddings_by_type
  @embeddings_by_type
end

#id ⇒ String

[Required] A unique identifier for the generated result.

Returns:

  • (String) 


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

def id
  @id
end

#inputs ⇒ Array<String>

The original inputs. Only present if "isEcho" is set to true.

Returns:

  • (Array<String>) 


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

def inputs
  @inputs
end

#model_id ⇒ String

The OCID of the model used in this inference request.

Returns:

  • (String) 


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

def model_id
  @model_id
end

#model_version ⇒ String

The version of the model.

Returns:

  • (String) 


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

def model_version
  @model_version
end

#usage ⇒ OCI::GenerativeAiInference::Models::Usage

Returns:



40
41
42
 
# File 'lib/oci/generative_ai_inference/models/embed_text_result.rb', line 40

def usage
  @usage
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'inputs': :'inputs',
    'embed_contents': :'embedContents',
    'embeddings': :'embeddings',
    'embeddings_by_type': :'embeddingsByType',
    'model_id': :'modelId',
    'model_version': :'modelVersion',
    'usage': :'usage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/generative_ai_inference/models/embed_text_result.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'inputs': :'Array<String>',
    'embed_contents': :'Array<OCI::GenerativeAiInference::Models::EmbedContent>',
    'embeddings': :'Array<Array<Float>>',
    'embeddings_by_type': :'Object',
    'model_id': :'String',
    'model_version': :'String',
    'usage': :'OCI::GenerativeAiInference::Models::Usage'
    # 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



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

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

  self.class == other.class &&
    id == other.id &&
    inputs == other.inputs &&
    embed_contents == other.embed_contents &&
    embeddings == other.embeddings &&
    embeddings_by_type == other.embeddings_by_type &&
    model_id == other.model_id &&
    model_version == other.model_version &&
    usage == other.usage
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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/generative_ai_inference/models/embed_text_result.rb', line 171

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



160
161
162
 
# File 'lib/oci/generative_ai_inference/models/embed_text_result.rb', line 160

def hash
  [id, inputs, embed_contents, embeddings, embeddings_by_type, model_id, model_version, usage].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/generative_ai_inference/models/embed_text_result.rb', line 204

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



198
199
200
 
# File 'lib/oci/generative_ai_inference/models/embed_text_result.rb', line 198

def to_s
  to_hash.to_s
end