Class: Vellum::NormalizedLogProbs

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/normalized_log_probs.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tokens:, likelihood: nil, additional_properties: nil) ⇒ NormalizedLogProbs

Parameters:

  • tokens (Array<NormalizedTokenLogProbs>)
  • likelihood (Float) (defaults to: nil)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



14
15
16
17
18
19
20
21
 
# File 'lib/vellum_ai/types/normalized_log_probs.rb', line 14

def initialize(tokens:, likelihood: nil, additional_properties: nil)
  # @type [Array<NormalizedTokenLogProbs>]
  @tokens = tokens
  # @type [Float]
  @likelihood = likelihood
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



8
9
10
 
# File 'lib/vellum_ai/types/normalized_log_probs.rb', line 8

def additional_properties
  @additional_properties
end

#likelihood ⇒ Object (readonly)

Returns the value of attribute likelihood.



8
9
10
 
# File 'lib/vellum_ai/types/normalized_log_probs.rb', line 8

def likelihood
  @likelihood
end

#tokens ⇒ Object (readonly)

Returns the value of attribute tokens.



8
9
10
 
# File 'lib/vellum_ai/types/normalized_log_probs.rb', line 8

def tokens
  @tokens
end

Class Method Details

.from_json(json_object:) ⇒ NormalizedLogProbs

Deserialize a JSON object to an instance of NormalizedLogProbs

Parameters:

  • json_object (JSON)

Returns:



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/vellum_ai/types/normalized_log_probs.rb', line 27

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  tokens = parsed_json["tokens"].map do |v|
    v = v.to_json
    NormalizedTokenLogProbs.from_json(json_object: v)
  end
  likelihood = struct.likelihood
  new(tokens: tokens, likelihood: likelihood, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


49
50
51
52
 
# File 'lib/vellum_ai/types/normalized_log_probs.rb', line 49

def self.validate_raw(obj:)
  obj.tokens.is_a?(Array) != false || raise("Passed value for field obj.tokens is not the expected type, validation failed.")
  obj.likelihood&.is_a?(Float) != false || raise("Passed value for field obj.likelihood is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of NormalizedLogProbs to a JSON object

Returns:

  • (JSON) 


41
42
43
 
# File 'lib/vellum_ai/types/normalized_log_probs.rb', line 41

def to_json(*_args)
  { "tokens": @tokens, "likelihood": @likelihood }.to_json
end