Herramientas

Las herramientas amplían lo que Chat puede hacer durante una conversación. Un webhook puede obtener datos en tiempo real de un servicio externo, mientras que una herramienta JavaScript puede ejecutar código en el navegador del comprador y realizar una acción en tu tienda.

Nombre y descripción #

Ve a Chat > Tools y haz clic en + Add another tool para abrir el editor de herramientas. Asigna un nombre claro a la herramienta y describe cuándo Chat debe usarla.

La descripción actúa como una instrucción para la IA. Sé específico sobre la situación que debe activar la herramienta. Por ejemplo:

“Cuando un cliente pregunte sobre un pedido, utiliza los datos de pedido disponibles en product_data para proporcionar información sobre su pedido.”

Una descripción clara ayuda a Chat a usar la herramienta correctamente y evita que la llame para preguntas no relacionadas.

Construir con Ask #

Si no quieres configurar la herramienta tú mismo, pide a Ask Clerk.io que proponga un webhook o una herramienta JavaScript. Describe lo que Chat debe hacer, luego revisa y confirma el nombre, descripción, parámetros y configuración propuestos antes de utilizarlos.

Webhooks #

En Type, selecciona Webhook. Las herramientas webhook llaman a tu API HTTP. Úsalas cuando un servicio pueda proporcionar los datos o realizar la acción que Chat necesita a través de un endpoint.

Parámetros #

Define los valores que Chat necesita antes de que pueda ejecutar la herramienta. Chat recopila estos valores de la conversación y solicita al visitante cualquier valor requerido que falte.

Para cada parámetro, define:

• Name — El nombre de la variable utilizado por el endpoint o la función JavaScript.
• Type — El tipo de valor que Chat debe recopilar, como texto o un número entero.
• Description — Lo que representa el valor y lo que Chat debe pedir al visitante.

Marca un parámetro como Required cuando la herramienta no pueda funcionar sin él.

Endpoint #

Configura la petición HTTP que Chat envía cuando se ejecuta una herramienta webhook.

Method: Elige GET, POST, PUT o DELETE, según lo que requiera tu API.

URL: Ingresa la URL completa del endpoint. Los parámetros de consulta pueden ser estáticos o usar los valores recopilados de la conversación con {{parameter_name}}. Por ejemplo:

https://api.example.com/orders?email={{email}}&id={{order_number}}

Request body: Para solicitudes POST y PUT, ingresa el cuerpo en el formato que espera tu API. También puedes usar parámetros aquí.

Custom headers: Añade cualquier header que requiera tu API, como tokens de autenticación o cambios en el tipo de contenido.

Timeout: Elige cuánto tiempo debe esperar Chat una respuesta antes de rendirse. Las opciones disponibles van de 3 segundos a 10 minutos.

Guardar y probar #

Cuando la herramienta esté lista, haz clic en Save o Save & Close.

Usa la sección Test en la parte inferior del editor. Ingresa valores para los parámetros y haz clic en Test request para comprobar la conexión.

JavaScript #

En Type, selecciona JavaScript. Las herramientas JavaScript se ejecutan en el navegador del comprador y pueden conectar Chat con funcionalidades que ya existen en tu tienda, tales como:

• añadir un producto al carrito
• leer el carrito actual
• aplicar un código de descuento
• abrir el checkout
• abrir una guía de tallas
• guardar un producto en una lista de deseos
• abrir un localizador de tiendas o un flujo de recogida en tienda

Estas son acciones personalizadas, no operaciones integradas. Debes conectar cada herramienta con la funcionalidad correspondiente en tu tienda.

Parámetros #

Define los valores que Chat necesita antes de que pueda ejecutar la herramienta. Chat recopila estos valores de la conversación y solicita al visitante cualquier valor requerido que falte.

Para cada parámetro, define:

• Name — El nombre de la variable utilizado por la función JavaScript.
• Type — El tipo de valor que Chat debe recopilar, como texto o un número entero.
• Description — Lo que representa el valor y lo que Chat debe pedir al visitante.

Marca un parámetro como Required cuando la herramienta no pueda funcionar sin él. Lee los valores recopilados del objeto args en tu función.

Código #

Escribe una función asíncrona que la tienda ejecuta cuando Chat llama a la herramienta. El editor proporciona a la función los argumentos recopilados y el contexto de la tienda.

Utiliza el objeto args para leer los valores definidos en Parameters. Luego llama al código de la tienda que realiza la acción, como añadir un artículo al carrito o abrir el checkout. Devuelve un resultado claro para que Chat pueda decirle al visitante lo que ha ocurrido.

El JavaScript exacto depende de tu tienda. Asegúrate de que la función gestione los valores que faltan, no válidos o no disponibles de forma segura.

Guardar y probar #

Cuando la herramienta esté lista, haz clic en Save o Save & Close.

Prueba las herramientas JavaScript en una tienda de prueba o en vista previa antes de hacerlas disponibles para los visitantes. Verifica tanto la acción en la tienda como el mensaje que Chat proporciona después de completar la acción.