Class: OCI::GenerativeAiInference::Models::RerankTextResult

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

Overview

The rerank response to return to the caller.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RerankTextResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

Instance Attribute Details

#document_ranks ⇒ Array<OCI::GenerativeAiInference::Models::DocumentRank>

[Required] Top n documents with their index and relevance score.

Returns:



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

def document_ranks
  @document_ranks
end

#id ⇒ String

[Required] A unique identifier for this RerankResult.

Returns:

  • (String) 


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

def id
  @id
end

#model_id ⇒ String

The OCID of the model used in the rerank request.

Returns:

  • (String) 


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

def model_id
  @model_id
end

#model_version ⇒ String

The version of the model.

Returns:

  • (String) 


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

def model_version
  @model_version
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/generative_ai_inference/models/rerank_text_result.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'model_id': :'modelId',
    'model_version': :'modelVersion',
    'document_ranks': :'documentRanks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/generative_ai_inference/models/rerank_text_result.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'model_id': :'String',
    'model_version': :'String',
    'document_ranks': :'Array<OCI::GenerativeAiInference::Models::DocumentRank>'
    # 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



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

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

  self.class == other.class &&
    id == other.id &&
    model_id == other.model_id &&
    model_version == other.model_version &&
    document_ranks == other.document_ranks
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



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

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


108
109
110
 
# File 'lib/oci/generative_ai_inference/models/rerank_text_result.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/generative_ai_inference/models/rerank_text_result.rb', line 117

def hash
  [id, model_id, model_version, document_ranks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



155
156
157
 
# File 'lib/oci/generative_ai_inference/models/rerank_text_result.rb', line 155

def to_s
  to_hash.to_s
end