Class: Vapi::ToolMessageComplete

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/tool_message_complete.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(contents: OMIT, role: OMIT, end_call_after_spoken_enabled: OMIT, content: OMIT, conditions: OMIT, additional_properties: nil) ⇒ Vapi::ToolMessageComplete

Parameters:

  • contents (Array<Vapi::TextContent>) (defaults to: OMIT) —

    This is an alternative to the content property. It allows to specify variants of the same content, one per language. Usage:

    • If your assistants are multilingual, you can provide content for each

    language.

    • If you don’t provide content for a language, the first item in the array will

    be automatically translated to the active language at that moment. This will override the content property.

  • role (Vapi::ToolMessageCompleteRole) (defaults to: OMIT) —

    This is optional and defaults to “assistant”. When role=assistant, content is said out loud. When role=system, content is passed to the model in a system message. Example: system: default one assistant: user: assistant: user: assistant: user: assistant: tool called tool: your server response <— system prompt as hint —> model generates response which is spoken This is useful when you want to provide a hint to the model about what to say next.

  • end_call_after_spoken_enabled (Boolean) (defaults to: OMIT) —

    This is an optional boolean that if true, the call will end after the message is spoken. Default is false. This is ignored if role is set to system. @default false

  • content (String) (defaults to: OMIT) —

    This is the content that the assistant says when this message is triggered.

  • conditions (Array<Vapi::Condition>) (defaults to: OMIT) —

    This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 88

def initialize(contents: OMIT, role: OMIT, end_call_after_spoken_enabled: OMIT, content: OMIT, conditions: OMIT,
               additional_properties: nil)
  @contents = contents if contents != OMIT
  @role = role if role != OMIT
  @end_call_after_spoken_enabled = end_call_after_spoken_enabled if end_call_after_spoken_enabled != OMIT
  @content = content if content != OMIT
  @conditions = conditions if conditions != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "contents": contents,
    "role": role,
    "endCallAfterSpokenEnabled": end_call_after_spoken_enabled,
    "content": content,
    "conditions": conditions
  }.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



48
49
50
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 48

def additional_properties
  @additional_properties
end

#conditions ⇒ Array<Vapi::Condition> (readonly)

Returns This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.

Returns:

  • (Array<Vapi::Condition>) —

    This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.



46
47
48
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 46

def conditions
  @conditions
end

#content ⇒ String (readonly)

Returns This is the content that the assistant says when this message is triggered.

Returns:

  • (String) —

    This is the content that the assistant says when this message is triggered.



43
44
45
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 43

def content
  @content
end

#contents ⇒ Array<Vapi::TextContent> (readonly)

Returns This is an alternative to the content property. It allows to specify variants of the same content, one per language. Usage:

  • If your assistants are multilingual, you can provide content for each

language.

  • If you don’t provide content for a language, the first item in the array will

be automatically translated to the active language at that moment. This will override the content property.

Returns:

  • (Array<Vapi::TextContent>) —

    This is an alternative to the content property. It allows to specify variants of the same content, one per language. Usage:

    • If your assistants are multilingual, you can provide content for each

    language.

    • If you don’t provide content for a language, the first item in the array will

    be automatically translated to the active language at that moment. This will override the content property.



19
20
21
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 19

def contents
  @contents
end

#end_call_after_spoken_enabled ⇒ Boolean (readonly)

Returns This is an optional boolean that if true, the call will end after the message is spoken. Default is false. This is ignored if role is set to system. @default false.

Returns:

  • (Boolean) —

    This is an optional boolean that if true, the call will end after the message is spoken. Default is false. This is ignored if role is set to system. @default false



41
42
43
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 41

def end_call_after_spoken_enabled
  @end_call_after_spoken_enabled
end

#role ⇒ Vapi::ToolMessageCompleteRole (readonly)

Returns This is optional and defaults to “assistant”. When role=assistant, content is said out loud. When role=system, content is passed to the model in a system message. Example: system: default one assistant: user: assistant: user: assistant: user: assistant: tool called tool: your server response <— system prompt as hint —> model generates response which is spoken This is useful when you want to provide a hint to the model about what to say next.

Returns:

  • (Vapi::ToolMessageCompleteRole) —

    This is optional and defaults to “assistant”. When role=assistant, content is said out loud. When role=system, content is passed to the model in a system message. Example: system: default one assistant: user: assistant: user: assistant: user: assistant: tool called tool: your server response <— system prompt as hint —> model generates response which is spoken This is useful when you want to provide a hint to the model about what to say next.



36
37
38
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 36

def role
  @role
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ToolMessageComplete

Deserialize a JSON object to an instance of ToolMessageComplete

Parameters:

  • json_object (String)

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 111

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  contents = parsed_json["contents"]&.map do |item|
    item = item.to_json
    Vapi::TextContent.from_json(json_object: item)
  end
  role = parsed_json["role"]
  end_call_after_spoken_enabled = parsed_json["endCallAfterSpokenEnabled"]
  content = parsed_json["content"]
  conditions = parsed_json["conditions"]&.map do |item|
    item = item.to_json
    Vapi::Condition.from_json(json_object: item)
  end
  new(
    contents: contents,
    role: role,
    end_call_after_spoken_enabled: end_call_after_spoken_enabled,
    content: content,
    conditions: conditions,
    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) 


148
149
150
151
152
153
154
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 148

def self.validate_raw(obj:)
  obj.contents&.is_a?(Array) != false || raise("Passed value for field obj.contents is not the expected type, validation failed.")
  obj.role&.is_a?(Vapi::ToolMessageCompleteRole) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
  obj.end_call_after_spoken_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.end_call_after_spoken_enabled is not the expected type, validation failed.")
  obj.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
  obj.conditions&.is_a?(Array) != false || raise("Passed value for field obj.conditions is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ToolMessageComplete to a JSON object

Returns:

  • (String) 


138
139
140
 
# File 'lib/vapi_server_sdk/types/tool_message_complete.rb', line 138

def to_json(*_args)
  @_field_set&.to_json
end