Class: Vellum::GenerateStreamResult

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_index:, data: OMIT, error: OMIT, additional_properties: nil) ⇒ Vellum::GenerateStreamResult

Parameters:



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

def initialize(request_index:, data: OMIT, error: OMIT, additional_properties: nil)
  @request_index = request_index
  @data = data if data != OMIT
  @error = error if error != OMIT
  @additional_properties = additional_properties
  @_field_set = { "request_index": request_index, "data": data, "error": error }.reject do | _k, v |
  v == OMIT
end
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



16
17
18
 
# File 'lib/vellum_ai/types/generate_stream_result.rb', line 16

def additional_properties
  @additional_properties
end

#data ⇒ Vellum::GenerateStreamResultData (readonly)

Returns:



12
13
14
 
# File 'lib/vellum_ai/types/generate_stream_result.rb', line 12

def data
  @data
end

#error ⇒ Vellum::GenerateResultError (readonly)

Returns:



14
15
16
 
# File 'lib/vellum_ai/types/generate_stream_result.rb', line 14

def error
  @error
end

#request_index ⇒ Integer (readonly)

Returns:

  • (Integer) 


10
11
12
 
# File 'lib/vellum_ai/types/generate_stream_result.rb', line 10

def request_index
  @request_index
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::GenerateStreamResult

Parameters:

  • json_object (String)

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/vellum_ai/types/generate_stream_result.rb', line 41

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  request_index = parsed_json["request_index"]
  unless parsed_json["data"].nil?
    data = parsed_json["data"].to_json
    data = Vellum::GenerateStreamResultData.from_json(json_object: data)
  else
    data = nil
  end
  unless parsed_json["error"].nil?
    error = parsed_json["error"].to_json
    error = Vellum::GenerateResultError.from_json(json_object: error)
  else
    error = nil
  end
  new(
    request_index: request_index,
    data: data,
    error: error,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


76
77
78
79
80
 
# File 'lib/vellum_ai/types/generate_stream_result.rb', line 76

def self.validate_raw(obj:)
  obj.request_index.is_a?(Integer) != false || raise("Passed value for field obj.request_index is not the expected type, validation failed.")
  obj.data.nil? || Vellum::GenerateStreamResultData.validate_raw(obj: obj.data)
  obj.error.nil? || Vellum::GenerateResultError.validate_raw(obj: obj.error)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


67
68
69
 
# File 'lib/vellum_ai/types/generate_stream_result.rb', line 67

def to_json
  @_field_set&.to_json
end