Class: Vapi::ToolMessageStart

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(contents: OMIT, blocking: OMIT, content: OMIT, conditions: OMIT, additional_properties: nil) ⇒ Vapi::ToolMessageStart

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.

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

    This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false. @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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/vapi_server_sdk/types/tool_message_start.rb', line 52

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



29
30
31
 
# File 'lib/vapi_server_sdk/types/tool_message_start.rb', line 29

def additional_properties
  @additional_properties
end

#blocking ⇒ Boolean (readonly)

Returns This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false. @default false.

Returns:

  • (Boolean) —

    This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false. @default false



22
23
24
 
# File 'lib/vapi_server_sdk/types/tool_message_start.rb', line 22

def blocking
  @blocking
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.



27
28
29
 
# File 'lib/vapi_server_sdk/types/tool_message_start.rb', line 27

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.



24
25
26
 
# File 'lib/vapi_server_sdk/types/tool_message_start.rb', line 24

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.



18
19
20
 
# File 'lib/vapi_server_sdk/types/tool_message_start.rb', line 18

def contents
  @contents
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ToolMessageStart

Deserialize a JSON object to an instance of ToolMessageStart

Parameters:

  • json_object (String)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/vapi_server_sdk/types/tool_message_start.rb', line 72

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
  blocking = parsed_json["blocking"]
  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,
    blocking: blocking,
    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) 


107
108
109
110
111
112
 
# File 'lib/vapi_server_sdk/types/tool_message_start.rb', line 107

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.blocking&.is_a?(Boolean) != false || raise("Passed value for field obj.blocking 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 ToolMessageStart to a JSON object

Returns:

  • (String) 


97
98
99
 
# File 'lib/vapi_server_sdk/types/tool_message_start.rb', line 97

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