Class: Vellum::NodeOutputCompiledChatHistoryValue

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

Overview

An output returned by a node that is of type CHAT_HISTORY.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, value: OMIT, node_output_id:, state: OMIT, additional_properties: nil) ⇒ Vellum::NodeOutputCompiledChatHistoryValue

Parameters:

  • type (String)
  • value (Array<Vellum::ChatMessage>) (defaults to: OMIT)
  • node_output_id (String)
  • state (Vellum::WorkflowNodeResultEventState) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/vellum_ai/types/node_output_compiled_chat_history_value.rb', line 32

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



19
20
21
 
# File 'lib/vellum_ai/types/node_output_compiled_chat_history_value.rb', line 19

def additional_properties
  @additional_properties
end

#node_output_id ⇒ String (readonly)

Returns:

  • (String) 


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

def node_output_id
  @node_output_id
end

#state ⇒ Vellum::WorkflowNodeResultEventState (readonly)

Returns:



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

def state
  @state
end

#type ⇒ String (readonly)

Returns:

  • (String) 


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

def type
  @type
end

#value ⇒ Array<Vellum::ChatMessage> (readonly)

Returns:



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

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::NodeOutputCompiledChatHistoryValue

Parameters:

  • json_object (String)

Returns:



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

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


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

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


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

def to_json
  @_field_set&.to_json
end