Class: Vellum::GenerateStreamResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(delta:, additional_properties: nil) ⇒ GenerateStreamResponse

Parameters:

  • delta (GenerateStreamResult)
  • 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_stream_response.rb', line 13

def initialize(delta:, additional_properties: nil)
  # @type [GenerateStreamResult]
  @delta = delta
  # @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_stream_response.rb', line 8

def additional_properties
  @additional_properties
end

#delta ⇒ Object (readonly)

Returns the value of attribute delta.



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

def delta
  @delta
end

Class Method Details

.from_json(json_object:) ⇒ GenerateStreamResponse

Deserialize a JSON object to an instance of GenerateStreamResponse

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["delta"].nil?
    delta = nil
  else
    delta = parsed_json["delta"].to_json
    delta = GenerateStreamResult.from_json(json_object: delta)
  end
  new(delta: delta, 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) 


47
48
49
 
# File 'lib/vellum_ai/types/generate_stream_response.rb', line 47

def self.validate_raw(obj:)
  GenerateStreamResult.validate_raw(obj: obj.delta)
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of GenerateStreamResponse to a JSON object

Returns:

  • (JSON) 


39
40
41
 
# File 'lib/vellum_ai/types/generate_stream_response.rb', line 39

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