Class: Vellum::GenerateResponse

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(results:, additional_properties: nil) ⇒ Vellum::GenerateResponse

Parameters:

  • results (Array<Vellum::GenerateResult>) —

    The results of each generation request.

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

    Additional properties unmapped to the current class definition



21
22
23
24
25
 
# File 'lib/vellum_ai/types/generate_response.rb', line 21

def initialize(results:, additional_properties: nil)
  @results = results
  @additional_properties = additional_properties
  @_field_set = { "results": results }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



11
12
13
 
# File 'lib/vellum_ai/types/generate_response.rb', line 11

def additional_properties
  @additional_properties
end

#results ⇒ Array<Vellum::GenerateResult> (readonly)

Returns The results of each generation request.

Returns:



9
10
11
 
# File 'lib/vellum_ai/types/generate_response.rb', line 9

def results
  @results
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::GenerateResponse

Parameters:

  • json_object (String)

Returns:



30
31
32
33
34
35
36
37
38
 
# File 'lib/vellum_ai/types/generate_response.rb', line 30

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  results = parsed_json["results"]&.map do | item |
  item = item.to_json
  Vellum::GenerateResult.from_json(json_object: item)
end
  new(results: results, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


51
52
53
 
# File 'lib/vellum_ai/types/generate_response.rb', line 51

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


42
43
44
 
# File 'lib/vellum_ai/types/generate_response.rb', line 42

def to_json
  @_field_set&.to_json
end