​
Introducción

Este documento menciona como se puede conectar el agente a Servicios externos del cliente, por ejemplo consultar servicios a base de datos, productos, reservar citas, etc.

✅ Se pueden agregar tantos servicios como se desee conectar, es importante poder diferenciar las referencias de los servicios para que el Agente pueda entender la intención. Mientras mas diferenciada esta la referencia, mejor sera el Agente para entender la intención.

​
Campos del Servicio

CampoDescripción
intentIdentificador único de la intención del servicio. Se usa para detectar qué está solicitando el usuario (por ejemplo, "schedule_appointment").
referenceFrase corta y descriptiva que ayuda a la IA a entender cuándo debe activarse este servicio. Ejemplo: “Servicio para reservar citas médicas”.
enabledBooleano que indica si el servicio está activo (true) o no (false).
methodMétodo HTTP usado para llamar a la API externa (GET, POST.), no se puede otra solicitud por el momento.
endpointURL completa de la API que se desea invocar cuando se activa la intención.
headersObjeto con pares clave-valor para incluir headers HTTP personalizados como Authorization.
requiredFieldsArreglo de strings que indica qué datos del usuario son requeridos antes de ejecutar el servicio (por ejemplo, ["nombre", "email"]).
bodyTemplateObjeto que se usa para construir el cuerpo del request. Soporta interpolación de variables como {{email}}, {{nombre}}.
responseMappingDefine cómo extraer datos desde la respuesta de la API (por ejemplo, "mensaje": "$.response.message").
responseMessageMensaje que el agente debe devolver al usuario tras ejecutar correctamente el servicio. Se pueden usar placeholders como {{fecha}}.
responseConditionsArreglo de objetos que define condiciones para el mensaje de respuesta. Cada objeto debe tener condition y message.

​
Ejemplo de headers

Los headers HTTP permiten enviar información adicional en las peticiones a las APIs externas. Aquí tienes varios ejemplos comunes:

Headers básicos con autenticación Bearer:

{
  "headers": {
    "Authorization": "Bearer tu_api_key_real_aqui",
    "Content-Type": "application/json"
  }
}

Headers con múltiples tipos de autenticación:

{
  "headers": {
    "Authorization": "Bearer sk-1234567890abcdef",
    "Content-Type": "application/json",
    "x-api-key": "your-secret-key-123",
    "x-client-id": "client_12345",
    "User-Agent": "Plazbot-Agent/2.0"
  }
}

Headers para APIs específicas (ejemplo: autenticación básica):

{
  "headers": {
    "Authorization": "Basic dXNlcjpwYXNzd29yZA==",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "x-workspace-id": "ws_abcd1234"
  }
}

Headers para APIs que requieren tokens personalizados:

{
  "headers": {
    "Content-Type": "application/json",
    "X-Auth-Token": "at_1a2b3c4d5e6f7g8h9i",
    "X-Workspace-ID": "workspace_789",
    "X-Source": "plazbot-agent"
  }
}

Importante: En los headers debes colocar tus credenciales reales del servicio externo (API keys, tokens, etc.). Estas NO son variables que se reemplacen automáticamente.

Las variables con dobles llaves {{variable}} solo se usan en el bodyTemplate para datos dinámicos del usuario como {{nombre}}, {{email}}, {{fecha}}, etc.

​
Ejemplo de bodyTemplate

El bodyTemplate define el cuerpo de la petición HTTP que se enviará a tu API externa. Aquí usas variables dinámicas que el agente recopila del usuario durante la conversación.

bodyTemplate básico para agendar citas:

{
  "bodyTemplate": {
    "nombre": "{{nombre}}",
    "email": "{{email}}",
    "fecha": "{{fecha|format('yyyy-MM-dd')}}"
  }
}

bodyTemplate avanzado con múltiples datos:

{
  "bodyTemplate": {
    "cliente": {
      "nombre_completo": "{{nombre}}",
      "email": "{{email}}",
      "telefono": "{{telefono}}"
    },
    "cita": {
      "fecha": "{{fecha|format('yyyy-MM-dd')}}",
      "hora": "{{hora|format('HH:mm')}}",
      "tipo_servicio": "{{tipo_servicio}}",
      "notas": "{{comentarios}}"
    },
    "metadata": {
      "canal": "plazbot",
      "timestamp": "{{now|format('yyyy-MM-dd HH:mm:ss')}}",
      "agente_id": "{{agent_id}}"
    }
  }
}

bodyTemplate para APIs de e-commerce:

{
  "bodyTemplate": {
    "customer": {
      "name": "{{nombre}}",
      "email": "{{email}}",
      "phone": "{{telefono}}"
    },
    "order": {
      "product_id": "{{producto_id}}",
      "quantity": "{{cantidad|number}}",
      "total_amount": "{{total|format('0.00')}}",
      "currency": "USD"
    },
    "shipping": {
      "address": "{{direccion}}",
      "city": "{{ciudad}}",
      "zip_code": "{{codigo_postal}}"
    }
  }
}

bodyTemplate para consultas de inventario:

{
  "bodyTemplate": {
    "query": {
      "product_name": "{{producto}}",
      "category": "{{categoria}}",
      "location": "{{ubicacion}}"
    },
    "filters": {
      "in_stock": true,
      "min_price": "{{precio_minimo|number}}",
      "max_price": "{{precio_maximo|number}}"
    }
  }
}

bodyTemplate para sistemas CRM:

{
  "bodyTemplate": {
    "lead": {
      "first_name": "{{nombre}}",
      "last_name": "{{apellido}}",
      "email": "{{email}}",
      "phone": "{{telefono}}",
      "company": "{{empresa}}"
    },
    "source": "plazbot",
    "interest": "{{servicio_interes}}",
    "budget": "{{presupuesto|number}}",
    "follow_up_date": "{{fecha_seguimiento|format('yyyy-MM-dd')}}"
  }
}

bodyTemplate con metadatos estáticos:

{
  "bodyTemplate": {
    "usuario": {
      "nombre": "{{nombre}}",
      "email": "{{email}}",
      "telefono": "{{telefono}}"
    },
    "metadata": {
      "canal": "plazbot",
      "version": "2.0",
      "tipo_solicitud": "{{tipo_servicio}}"
    }
  }
}

​
Formatos de Campos

Los campos que se usan en el bodyTemplate pueden usar formatos especiales para diferentes tipos de datos:

Para fechas:

  • {{fecha|format('yyyy-MM-dd')}} → “2024-01-15”
  • {{fecha|format('dd/MM/yyyy')}} → “15/01/2024”
  • {{fecha|format('yyyy-MM-dd HH:mm:ss')}} → “2024-01-15 14:30:00”

Para números:

  • {{precio|number}} → 1500 (número entero)
  • {{precio|format('0.00')}} → “1500.00” (dos decimales)
  • {{cantidad|number}} → 5

Para texto:

Variables dinámicas del usuario:

  • Las variables {{variable}} se reemplazan con los datos que el usuario proporciona durante la conversación
  • Solo funcionan las variables que están definidas en requiredFields o que el usuario haya proporcionado

👉 Formatos de Campos Completos

Importante: Las variables {{variable}} solo se reemplazan con datos que el usuario proporciona durante la conversación. Deben estar definidas en requiredFields para que el agente las solicite automáticamente.

Limitación actual: El sistema no incluye variables automáticas como fecha actual o IDs del sistema. Solo se interpolan las variables recopiladas del usuario.

​
Ejemplo de responseMapping

El responseMapping te permite extraer datos específicos de la respuesta de tu API externa usando JSONPath. Estos valores extraídos luego se pueden usar en el responseMessage y responseConditions.

responseMapping básico:

{
  "responseMapping": {
    "mensaje": "$.response.mensaje",
    "status": "$.response.status",
    "fecha": "$.response.fecha",
    "id": "$.response.id"
  }
}

Ejemplo con API de citas médicas:

Si tu API responde:

{
  "success": true,
  "data": {
    "appointment": {
      "id": "apt_12345",
      "date": "2024-01-15",
      "time": "14:30",
      "doctor": "Dr. García",
      "status": "confirmed"
    },
    "patient": {
      "name": "Juan Pérez",
      "email": "juan@email.com"
    }
  },
  "message": "Cita agendada exitosamente"
}

Tu responseMapping sería:

{
  "responseMapping": {
    "cita_id": "$.data.appointment.id",
    "fecha": "$.data.appointment.date",
    "hora": "$.data.appointment.time",
    "doctor": "$.data.appointment.doctor",
    "estado": "$.data.appointment.status",
    "nombre_paciente": "$.data.patient.name",
    "email": "$.data.patient.email",
    "mensaje_api": "$.message"
  }
}

Ejemplo con API de e-commerce:

Si tu API responde:

{
  "order": {
    "id": "ORD-789",
    "total": 299.99,
    "currency": "USD",
    "items": [
      {
        "name": "Producto A",
        "quantity": 2,
        "price": 149.99
      }
    ]
  },
  "shipping": {
    "tracking_number": "TRK123456",
    "estimated_delivery": "2024-01-20"
  },
  "status": "processing"
}

Tu responseMapping sería:

{
  "responseMapping": {
    "numero_orden": "$.order.id",
    "total": "$.order.total",
    "moneda": "$.order.currency",
    "producto": "$.order.items[0].name",
    "cantidad": "$.order.items[0].quantity",
    "numero_seguimiento": "$.shipping.tracking_number",
    "fecha_entrega": "$.shipping.estimated_delivery",
    "estado_orden": "$.status"
  }
}

Ejemplo con arrays y datos anidados:

{
  "responseMapping": {
    "primer_producto": "$.products[0].name",
    "precio_total": "$.summary.total_amount",
    "descuento": "$.summary.discount.percentage",
    "usuario_vip": "$.customer.membership.is_vip",
    "puntos_ganados": "$.customer.loyalty.points_earned"
  }
}

​
Sintaxis JSONPath

Acceso básico:

  • $.campo → Accede a un campo en la raíz
  • $.objeto.subcampo → Accede a campos anidados
  • $.array[0] → Primer elemento de un array
  • $.array[*] → Todos los elementos de un array

Ejemplos de rutas:

  • $.response.message → response.message
  • $.data.user.email → data.user.email
  • $.items[0].price → Precio del primer item
  • $.orders[-1].id → ID de la última orden

Los valores extraídos con responseMapping se convierten automáticamente en variables que puedes usar en responseMessage como {{variable}}. Por ejemplo, si extraes "fecha": "$.data.date", puedes usar {{fecha}} en tu mensaje de respuesta.

Si la ruta JSONPath no existe en la respuesta de la API, esa variable simplemente no se creará. Asegúrate de que las rutas coincidan con la estructura real de tu API.

​
Campos requeridos

Los campos requeridos son la base fundamental de los servicios. Definen qué información debe recopilar el agente del usuario antes de ejecutar el servicio. Estos campos son las variables que alimentarán el bodyTemplate.

​
Configuración de campos requeridos

Cada campo requerido se define con las siguientes propiedades:

PropiedadDescripciónEjemplo
nameNombre del campo que se usará en {{variable}}"nombre", "email", "fecha"
typeTipo de dato esperado"string", "number", "date", "datetime", "boolean"
descriptionExplicación del campo para que la IA entienda qué solicitar"Nombre completo del cliente"
promptHintSugerencia de cómo la IA debe preguntar este campo"¿Cuál es tu nombre completo?"

​
Ejemplos de campos requeridos

Para servicio de citas médicas:

{
  "requiredFields": [
    {
      "name": "nombre",
      "type": "string",
      "description": "Nombre completo del paciente",
      "promptHint": "¿Podrías indicarme tu nombre completo, por favor?"
    },
    {
      "name": "email",
      "type": "string",
      "description": "Correo electrónico del paciente para confirmaciones",
      "promptHint": "¿Cuál es tu dirección de correo electrónico?"
    },
    {
      "name": "telefono",
      "type": "string",
      "description": "Número de teléfono del paciente",
      "promptHint": "¿Me puedes proporcionar tu número de teléfono?"
    },
    {
      "name": "fecha",
      "type": "date",
      "description": "Fecha preferida para la cita médica",
      "promptHint": "¿Qué día te gustaría agendar tu cita?"
    },
    {
      "name": "especialidad",
      "type": "string",
      "description": "Tipo de especialidad médica requerida",
      "promptHint": "¿Qué tipo de especialidad médica necesitas?"
    }
  ]
}

Para servicio de e-commerce:

{
  "requiredFields": [
    {
      "name": "producto",
      "type": "string",
      "description": "Nombre del producto que desea comprar",
      "promptHint": "¿Qué producto te interesa?"
    },
    {
      "name": "cantidad",
      "type": "number",
      "description": "Cantidad de productos a comprar",
      "promptHint": "¿Cuántas unidades necesitas?"
    },
    {
      "name": "direccion",
      "type": "string",
      "description": "Dirección de envío completa",
      "promptHint": "¿Cuál es tu dirección de envío?"
    },
    {
      "name": "metodo_pago",
      "type": "string",
      "description": "Método de pago preferido",
      "promptHint": "¿Cómo te gustaría pagar?"
    }
  ]
}

Para servicio de soporte técnico:

{
  "requiredFields": [
    {
      "name": "problema",
      "type": "string",
      "description": "Descripción detallada del problema técnico",
      "promptHint": "¿Podrías describir el problema que estás experimentando?"
    },
    {
      "name": "dispositivo",
      "type": "string",
      "description": "Tipo de dispositivo donde ocurre el problema",
      "promptHint": "¿En qué dispositivo estás teniendo el problema?"
    },
    {
      "name": "urgencia",
      "type": "string",
      "description": "Nivel de urgencia del problema (alta, media, baja)",
      "promptHint": "¿Qué tan urgente es este problema?"
    }
  ]
}

​
Tipos de datos soportados

TipoDescripciónValidación
stringTexto libreValida que no esté vacío
numberNúmero decimalAcepta cualquier entrada (validación básica)
integerNúmero enteroAcepta cualquier entrada (validación básica)
dateFechaValida y normaliza fechas con IA ✅
datetimeFecha y horaValida fechas con hora ✅
booleanVerdadero/FalsoAcepta cualquier entrada (validación básica)

​
Flujo de recopilación

  1. El usuario expresa una intención que coincide con el servicio
  2. El agente identifica campos faltantes comparando con requiredFields
  3. Pregunta los campos uno por uno usando promptHint como guía
  4. Valida cada respuesta según el type especificado
  5. Una vez completos todos los campos, ejecuta el servicio con bodyTemplate

Importante: Los nombres de los campos en requiredFields deben coincidir exactamente con las variables usadas en bodyTemplate. Por ejemplo, si defines "name": "email", debes usar {{email}} en el bodyTemplate.

Validación parcial: El sistema actualmente valida automáticamente fechas (date/datetime) y campos vacíos (string). Si el usuario proporciona una fecha inválida, el agente pedirá el dato nuevamente con un mensaje de error. Para otros tipos como number o boolean, la validación es más básica.

​
Campos Condicionales

Con la plataforma se puede tener condicionales para que el Agente pueda responder de forma diferente en base a la respuesta del servicio.

Ejemplo de responseConditions

"responseConditions": [
  {
    "condition": "$.response.status == 'success'",
    "message": "¡Perfecto! Tu cita ha sido confirmada para el {{date}}. Te enviaremos un recordatorio por email a {{email}}."
  },
  {
    "condition": "$.response.status == 'conflict'",
    "message": "Lo siento, ese horario no está disponible. {{conflictReason}}. ¿Te gustaría que te sugiera otros horarios disponibles?"
  },
  {
    "condition": "$.response.status == 'error' && $.response.errorCode == 'invalid_email'",
    "message": "Parece que el email proporcionado no es válido. ¿Podrías verificar tu dirección de correo electrónico?"
  },
  {
    "condition": "$.response.status == 'error' && $.response.errorCode == 'past_date'",
    "message": "No puedo agendar citas en fechas pasadas. ¿Podrías elegir una fecha futura?"
  },
  {
    "condition": "$.response.status == 'pending'",
    "message": "Tu solicitud de cita está en proceso de revisión. Te contactaremos dentro de las próximas 24 horas para confirmar la disponibilidad."
  }
]

Operadores Condicionales

  • == (Igual a)
  • != (Distinto a)
  • < (Menor que)
  • > (Mayor que)
  • <= (Menor o igual a)
  • >= (Mayor o igual a)

El responseMessage por defecto se usa solo si ninguna de las condiciones en responseConditions se cumple, funcionando como un fallback.

​
Consideraciones

  • El Agente de IA consultará al usuario, los campos que se encuentran en el campo requiredFields en el formato: campo: campo, el usuario puede llenar un campo o todos, la IA entenderá si faltan o no campos antes del consumir el servicio.
  • El responseMapping te ayudará a poder completar los datos del campo requiredMessage, colocando la información en las llaves correspondientes, el json que te trae el servicio deberia de poder colocar los campos dentro del Mensaje.
  • Se pueden crear uno o varios servicios dentro de la configuración del Agente, para que pueda consultar sus servicios.