Using Tools
Additional Capabilities for Your Assistants
VoiceCreator.ai assistants are equipped with several built-in tools: transferCall, endCall, dialKeypad, and sendTextMessage. These tools enable the assistant to perform advanced actions such as transferring calls, hanging up calls, sending text messages, and interacting with automated menus. You don’t need to manually add these tools to your assistant’s configuration—they are provided automatically based on the assistant’s settings.
Predefined Tools
Transfer Call
The transferCall tool is automatically enabled when a forwardingPhoneNumber is present in the assistant configuration. This tool allows the assistant to seamlessly transfer calls to the specified number.
Example Configuration:
{
"model": {
"provider": "openai",
"model": "gpt-4o",
"messages": [
{
"role": "system",
"content": "You are an assistant for a co-working space. When the user requests to speak to the sales team, use the transferCall tool."
}
]
},
"forwardingPhoneNumber": "+61298765432"
}End Call
The endCall tool is available when endCallFunctionEnabled is set to true in the assistant configuration. This tool allows the assistant to end the call under specific conditions, such as when the user explicitly requests it or the conversation concludes.
Example Configuration:
{
"model": {
"provider": "openai",
"model": "gpt-4o",
"messages": [
{
"role": "system",
"content": "You are a support assistant for a fitness centre. If the user becomes abusive, use the endCall tool."
}
]
},
"endCallFunctionEnabled": true
}Dial Keypad
The dialKeypad tool is provided when dialKeypadFunctionEnabled is enabled in the assistant configuration. It allows the assistant to input digits on a keypad, which is particularly useful for navigating automated menus during calls.
Example Configuration:
{
"model": {
"provider": "openai",
"model": "gpt-4o",
"messages": [
{
"role": "system",
"content": "You are a receptionist assistant for an IT company. When navigating an automated phone menu, use the dialKeypad tool to enter menu options."
}
]
},
"dialKeypadFunctionEnabled": true
}Send Text Message
The sendTextMessage tool allows the assistant to send SMS messages to users. This tool is useful for sharing links, appointment details, or any other text-based communication.
The sendTextMessage tool requires the following parameters:
to: The recipient’s phone number in E.164 format.from: The assistant’s phone number in E.164 format.message: The text message content to send to the user.
Example Configuration:
{
"model": {
"provider": "openai",
"model": "gpt-4o",
"messages": [
{
"role": "system",
"content": "You are an assistant for a marketing agency. When the user asks to book a meeting, send them a Calendly link using the sendTextMessage tool."
}
]
},
"tools": [
{
"name": "sendTextMessage",
"parameters": {
"to": "+61400123456",
"from": "+61400987654",
"message": "Thank you for your interest! Please use this link to book a meeting: https://calendly.com/your-link"
}
}
]
}Custom Tools
Overview
In addition to predefined tools, VoiceCreator.ai supports custom tools to expand the assistant’s capabilities. These tools work similarly to OpenAI’s function-calling mechanism and allow the assistant to trigger specific actions based on your configuration.
Defining Custom Tools
To define a custom tool, include the tool’s configuration in the assistant’s definition. Each tool is represented as an object with the following properties:
name: The name of the tool (e.g.,scheduleAppointment). Must be a string containing letters, numbers, underscores, or dashes, and cannot exceed 64 characters.description: A brief description of the tool’s purpose to help the AI decide when to invoke it.parameters: An object specifying the tool’s expected input parameters, including their names, types, and descriptions.
Example Custom Tool Definition:
{
"tools": [
{
"name": "scheduleAppointment",
"description": "Schedules an appointment with the user.",
"parameters": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of the appointment in YYYY-MM-DD format."
},
"time": {
"type": "string",
"description": "The time of the appointment in HH:mm format."
}
}
}
}
]
}In this example, the scheduleAppointment tool accepts two parameters: date and time.
Configuring Server URLs for Tools
VoiceCreator.ai supports setting up a serverUrl to handle tool calls. This can be configured either at the account level or assistant level:
- Account Level: Set the
serverUrlin the VoiceCreator.ai dashboard. All assistants under the account will use this URL by default for tool calls. - Assistant Level: Specify the
serverUrlin the assistant configuration. This overrides the account-level URL for the specific assistant.
Example Server URL Configuration:
{
"serverUrl": "https://yourserver.com/api"
}If no serverUrl is configured, the tool calls are added to the chat history. This enables frontend applications to react to specific tool calls dynamically, such as updating the user interface or performing other actions in real time.
Transition from Custom Functions to Tools
VoiceCreator.ai is deprecating the "Custom Functions" feature in favour of "Tools." This transition simplifies the process of defining assistant capabilities while ensuring compatibility with external APIs. We are actively working on a migration solution to make this transition seamless.
Key Benefits of Tools in VoiceCreator.ai
- Built-in Predefined Tools: Simplifies common tasks like call transfers, hang-ups, keypad input, and sending text messages.
- Custom Tool Flexibility: Allows tailored solutions to meet unique business needs.
- Dynamic Integration: Server URL support enables seamless backend integration and real-time interaction with the user interface.
By leveraging both predefined and custom tools, VoiceCreator.ai empowers you to create highly capable and context-aware voice assistants tailored to your specific requirements.
Updated 2 months ago