Class: Vellum::GenerateResultData

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(completions:, additional_properties: nil) ⇒ GenerateResultData

Parameters:

  • completions (Array<EnrichedNormalizedCompletion>) —

    The generated completions. This will generally be a list of length one.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



13
14
15
16
17
18
 
# File 'lib/vellum_ai/types/generate_result_data.rb', line 13

def initialize(completions:, additional_properties: nil)
  # @type [Array<EnrichedNormalizedCompletion>] The generated completions. This will generally be a list of length one.
  @completions = completions
  # @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/generate_result_data.rb', line 8

def additional_properties
  @additional_properties
end

#completions ⇒ Object (readonly)

Returns the value of attribute completions.



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

def completions
  @completions
end

Class Method Details

.from_json(json_object:) ⇒ GenerateResultData

Deserialize a JSON object to an instance of GenerateResultData

Parameters:

  • json_object (JSON)

Returns:



24
25
26
27
28
29
30
31
32
 
# File 'lib/vellum_ai/types/generate_result_data.rb', line 24

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  completions = parsed_json["completions"].map do |v|
    v = v.to_json
    EnrichedNormalizedCompletion.from_json(json_object: v)
  end
  new(completions: completions, 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) 


45
46
47
 
# File 'lib/vellum_ai/types/generate_result_data.rb', line 45

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of GenerateResultData to a JSON object

Returns:

  • (JSON) 


37
38
39
 
# File 'lib/vellum_ai/types/generate_result_data.rb', line 37

def to_json(*_args)
  { "completions": @completions }.to_json
end