​

Conversation Variable Tools Templates

This document details the new tools templates for manipulating conversation variables: Create/Update Conversation Variable and Delete Conversation Variable. These tools allow you to add, update, or remove variables within a conversation, providing greater flexibility for dynamic interactions.

Important: When crafting your agent’s prompt, make sure to include clear instructions that direct the agent to use the appropriate tool template for creating, updating, or deleting a conversation variable. This ensures that the variable manipulation is handled correctly through the API.

​

Create/Update Conversation Variable

Use this tool template to create a new conversation variable or update an existing one. The tool expects the following JSON structure as input:

{
  "conversationId": "123",
  "varName": "status",
  "varValue": "active"
}

• conversationId: Identifier for the conversation.
• varName: The name of the variable (e.g., “status”, “priority”, etc.). Note: varName is limited to 20 characters.
• varValue: The value assigned to the variable. Note: varValue is limited to 100 characters.

​

Usage Instructions

1. Include in Agent Prompt: When you want to set or update a variable, include instructions in the agent’s prompt that specify the variable details and direct the agent to use the Create/Update tool.
2. Example Prompt:

   “Please update the conversation variable ‘status’ to ‘active’ using the appropriate tool.”

3. Backend Handling: The API will upsert the variable. If the variable already exists for the given conversationId and varName, its value will be updated; otherwise, a new variable will be created.

​

Delete Conversation Variable

Use this tool template to delete an existing conversation variable. The tool requires the variable to be identified by the conversation ID and the variable name.

​

Endpoint Example

To delete a variable, the agent should send a request with the following parameters:

• conversationId: Identifier for the conversation.
• varName: The name of the variable to be deleted.

​

Usage Instructions

1. Include in Agent Prompt: When you want to remove a variable, clearly instruct the agent to delete the variable using the Delete tool.
2. Example Prompt:

   “Please delete the conversation variable ‘status’ using the appropriate tool.”

3. Backend Handling: The API will remove the variable identified by the given conversationId and varName and return a confirmation message upon successful deletion.

​

Summary & Important Notes

• Create/Update Tool: Use for setting a new variable or updating an existing one. Provide all required fields in the JSON payload.
• Delete Tool: Use for removing a variable. Ensure the conversation ID and variable name are provided.
• Data Freshness: The agent will only use, in the context of its prompt, the variables that have been created or updated within the last 3 days.
• Variable Restrictions:
  • varName is limited to 20 characters.
  • varValue is limited to 100 characters.

Always ensure that the agent’s prompt includes explicit instructions to invoke the correct tool. This guarantees that conversation variables are managed accurately and efficiently during the chat flow.

Need Help? Contact our support team for assistance with setting up or using these tool templates.