Class: Vellum::InitiatedExecutePromptEvent

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

Overview

returned and begun streaming.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:

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

    Additional properties unmapped to the current class definition



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

def initialize(state:, meta: OMIT, execution_id:, additional_properties: nil)
  @state = state
  @meta = meta if meta != OMIT
  @execution_id = execution_id
  @additional_properties = additional_properties
  @_field_set = { "state": state, "meta": meta, "execution_id": execution_id }.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



17
18
19
 
# File 'lib/vellum_ai/types/initiated_execute_prompt_event.rb', line 17

def additional_properties
  @additional_properties
end

#execution_id ⇒ String (readonly)

Returns:

  • (String) 


15
16
17
 
# File 'lib/vellum_ai/types/initiated_execute_prompt_event.rb', line 15

def execution_id
  @execution_id
end

#meta ⇒ Vellum::InitiatedPromptExecutionMeta (readonly)

Returns:



13
14
15
 
# File 'lib/vellum_ai/types/initiated_execute_prompt_event.rb', line 13

def meta
  @meta
end

#state ⇒ String (readonly)

Returns:

  • (String) 


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

def state
  @state
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::InitiatedExecutePromptEvent

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  state = parsed_json["state"]
  unless parsed_json["meta"].nil?
    meta = parsed_json["meta"].to_json
    meta = Vellum::InitiatedPromptExecutionMeta.from_json(json_object: meta)
  else
    meta = nil
  end
  execution_id = parsed_json["execution_id"]
  new(
    state: state,
    meta: meta,
    execution_id: execution_id,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


72
73
74
75
76
 
# File 'lib/vellum_ai/types/initiated_execute_prompt_event.rb', line 72

def self.validate_raw(obj:)
  obj.state.is_a?(String) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
  obj.meta.nil? || Vellum::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 ⇒ String

Returns:

  • (String) 


63
64
65
 
# File 'lib/vellum_ai/types/initiated_execute_prompt_event.rb', line 63

def to_json
  @_field_set&.to_json
end