Class: Vellum::InitiatedExecutePromptEvent

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

Overview

The initial data returned indicating that the response from the model has returned and begun streaming.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(execution_id:, meta: nil, additional_properties: nil) ⇒ InitiatedExecutePromptEvent

Parameters:

  • meta (InitiatedPromptExecutionMeta) (defaults to: nil)
  • execution_id (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(execution_id:, meta: nil, additional_properties: nil)
  # @type [InitiatedPromptExecutionMeta]
  @meta = meta
  # @type [String]
  @execution_id = execution_id
  # @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.



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

def additional_properties
  @additional_properties
end

#execution_id ⇒ Object (readonly)

Returns the value of attribute execution_id.



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

def execution_id
  @execution_id
end

#meta ⇒ Object (readonly)

Returns the value of attribute meta.



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

def meta
  @meta
end

Class Method Details

.from_json(json_object:) ⇒ InitiatedExecutePromptEvent

Deserialize a JSON object to an instance of InitiatedExecutePromptEvent

Parameters:

  • json_object (JSON)

Returns:



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

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


52
53
54
55
 
# File 'lib/vellum_ai/types/initiated_execute_prompt_event.rb', line 52

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of InitiatedExecutePromptEvent to a JSON object

Returns:

  • (JSON) 


44
45
46
 
# File 'lib/vellum_ai/types/initiated_execute_prompt_event.rb', line 44

def to_json(*_args)
  { "meta": @meta, "execution_id": @execution_id }.to_json
end