Raíz es el producto de Arbol para el contacto con cada paciente. Sus agentes de IA hablan con los pacientes de una clínica o un hospital por teléfono, por WhatsApp y en un chat de su sitio web: responden cuando los pacientes se comunican y pueden llamarlos. Siguen las instrucciones que les das, consultan tus documentos, usan las herramientas de tus integraciones y le pasan una conversación a tu equipo cuando se necesita una persona. Todo lo que Raíz guarda pertenece a una organización, y llegas a ello a través de la API de Raíz.
El modelo
Raíz se compone de estas partes:
- La organización es tu clínica u hospital. Cada solicitud a la API actúa en una organización: aquella a la que pertenece su credencial. Consulta Organizaciones.
- Los agentes son la IA que habla por ti. Un agente es
voice, para llamadas telefónicas, otext, para WhatsApp y el chat web. - Los canales son donde trabajan los agentes: un número de WhatsApp, un número de teléfono o un widget de chat en tu sitio. En cada uno asignas el agente que responde.
- Las conversaciones ocurren en un canal, entre un agente, tu equipo y un contacto: el paciente, con sus números de teléfono, sus correos y sus documentos de identidad.
- Las definiciones y los hechos son los datos que capturan los agentes. Una definición dice qué capturar; un hecho es su valor para un contacto o una conversación.
- Conocimiento son los documentos que los agentes consultan antes de responder.
- Las campañas hacen que un agente de voz llame a una lista de personas. Las plantillas abren conversaciones de WhatsApp. Las novedades les cuentan a los agentes lo que pasa durante un tiempo, como un día cerrado.
- Las evaluaciones prueban un cambio en un agente con respuestas pasadas que tu equipo corrigió, antes de que llegue a los pacientes.
- Los reportes, el historial de cambios y las tareas te dan las cifras, quién cambió qué y el trabajo que corre en segundo plano.
Dónde se describe cada parte
| Parte | Se explica en | Referencia de la API |
|---|---|---|
| Agentes | Agentes | Agents, Voices |
| Canales | Canales | Channels |
| Conversaciones | Conversaciones | Conversations |
| Contactos, perfiles de contacto, reglas de no contactar | Contactos | Contacts, Profiles, Suppressions |
| Conocimiento | Conocimiento | Knowledge |
| Campañas, plantillas, novedades | Campañas, plantillas y novedades | Campaigns, Templates, Bulletins |
| Evaluaciones | Evaluaciones | Eval cases, Eval runs |
| Definiciones, hechos, reportes, cambios, tareas | Datos, reportes y tareas | Definitions, Facts, Reports, Changes, Tasks |
| La organización y su equipo | Más abajo | Organization, Members, Roles |
Llamar a la API de Raíz
Todas las operaciones viven bajo https://api.getarbol.com/v1/raiz/ y se llaman raiz.<resource>.<verb>, como raiz.agents.create. Todas aceptan por igual personas y máquinas, así que una API key con los scopes adecuados puede llamar a cualquiera de ellas.
Los permisos (scopes) llevan el nombre del recurso, como raiz:agents:read y raiz:agents:write, y la mayoría de las lecturas también aceptan el scope de escritura. Algunos recursos toman prestados los scopes de otro: las novedades usan los scopes de agentes, y las evaluaciones necesitan un scope de agentes y uno de conversaciones. La página de referencia de cada operación lista exactamente qué scopes acepta.
Las listas se paginan con cursores (Paginación), y las actualizaciones que reciben expectedVersion se aplican solo si nadie cambió el registro desde que lo leíste, y si no, responden 409 VERSION_CONFLICT (Reintentos).
La organización
raiz.organization.get lee tu organización tal como la ve Raíz: su nombre, el language por defecto de sus agentes, su timeZone, en la que los reportes cuentan los días y las campañas corren por defecto, y sus settings:
| Ajuste | Qué hace |
|---|---|
channels.maxConcurrentOutboundCalls |
Cuántas llamadas de campaña corren a la vez (5 por defecto). |
notifications |
Si enviar un correo a hasta 10 recipients cuando la IA le pasa una conversación al equipo (escalations), cuando no pudo responder (failures) o cuando la solicitud de una conversación cerrada no se resolvió (failedOutcomes). Los phones también reciben por WhatsApp el aviso de traspaso. Todo desactivado por defecto. |
dailyReport |
Si enviar un reporte diario por correo, a la hora sendAt, a hasta 10 recipients: las llamadas y conversaciones de las últimas 24 horas, las que esperan a tu equipo y las que hay que revisar. Desactivado por defecto. |
raiz.organization.update cambia el nombre, el idioma, la zona horaria y los ajustes: un ajuste omitido se queda como está, y null lo devuelve a su valor por defecto. raiz.organization.sendDailyReport envía el reporte diario ahora. Cuenta administra el equipo de la organización y sus roles mediante account.members.list y account.roles.list.
Empieza aquí
Para ver las partes funcionando juntas, crea un agente y ponlo en un canal. Luego lee Conversaciones para seguir lo que hace.