vapi4k-core/com.vapi4k.api.tools/GhlTool

GhlTool

interface GhlTool : ToolWithMetaData

Properties

Link copied to clipboard
abstract val metadata: MutableMap<String, String>

Functions

Link copied to clipboard
abstract fun condition(requiredCondition: ToolMessageCondition, vararg additionalConditions: ToolMessageCondition, block: ToolCondition.() -> Unit)

Adds a ToolCondition to the optional array of conditions that the tool call arguments must meet in order for this message to be triggered.

Link copied to clipboard
abstract fun requestCompleteMessage(block: ToolMessageComplete.() -> Unit): ToolMessageComplete

Adds a ToolMessageComplete to the messages in the tool.
This message is triggered when the tool call is complete.
This message is triggered immediately without waiting for your server to respond for async tool calls.
If this message is not provided, the model will be requested to respond.
If this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.

Link copied to clipboard
abstract fun requestDelayedMessage(block: ToolMessageDelayed.() -> Unit): ToolMessageDelayed

Adds a ToolMessageDelayed to the messages in the tool.
This message is triggered when the tool call is delayed.
There are the two things that can trigger this message:

  1. The user talks with the assistant while your server is processing the request. Default is "Sorry, a few more seconds."
  2. The server doesn't respond within timingMilliseconds.
  3. This message is never triggered for async tool calls.

Link copied to clipboard
abstract fun requestFailedMessage(block: ToolMessageFailed.() -> Unit): ToolMessageFailed

Adds a ToolMessageFailed to the messages in the tool.
This message is triggered when the tool call fails.
This message is never triggered for async tool calls.
If this message is not provided, the model will be requested to respond.
If this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.

Link copied to clipboard
abstract fun requestStartMessage(block: ToolMessageStart.() -> Unit): ToolMessageStart

Adds a ToolMessageStart to the messages in the tool.
This message is triggered when the tool call starts.
This message is never triggered for async tools.
If this message is not provided, one of the default filler messages "Hold on a sec", "One moment", "Just a sec", "Give me a moment" or "This'll just take a sec" will be used.

Link copied to clipboard
abstract fun server(block: Server.() -> Unit): Server

This is the server that will be hit when this tool is requested by the LLM.
All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
his overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.