¿Qué es la API ask() para sitios web?
La API ask() es un método (OkidokiWidget.ask()) que permite a los desarrolladores consultar la IA de Okidoki.chat directamente desde JavaScript del lado del cliente. En lugar de abrir el widget de chat, puedes preguntar programáticamente y recibir una respuesta JSON estructurada basada en tu base de conocimientos. Es ideal para crear funciones personalizadas impulsadas por IA — como búsqueda inteligente, recomendaciones de productos o FAQs dinámicas — sin configurar tu propia canalización LLM.
Cómo funciona la API ask()
Llama a OkidokiWidget.ask() con una pregunta en lenguaje natural y un JSON Schema opcional para el formato de respuesta. La IA consulta tu base de conocimientos usando RAG y devuelve una respuesta tipada que tu código frontend puede usar directamente.
Salida estructurada con JSON Schema
Pasa un JSON Schema para definir la forma exacta de la respuesta de la IA. Por ejemplo, solicita una matriz de recomendaciones de productos con campos de nombre, precio y razón. La IA adapta su salida a tu esquema, facilitando la integración.
Casos de uso de la API ask()
Crea una búsqueda inteligente en el sitio que entienda la intención, crea widgets de recomendación "selecciones IA para ti", genera secciones de FAQ dinámicas o potencia herramientas de comparación — todo usando tu base de conocimientos existente de Okidoki.chat.
Experiencia del desarrollador
El SDK incluye tipos completos de TypeScript. Las respuestas se devuelven como promesas, lo que facilita su uso con async/await. Los límites de velocidad y el manejo de errores están documentados en el portal de desarrolladores.
Preguntas frecuentes
¿Está la API ask() disponible en todos los planes?+
La API ask() está disponible en todos los planes de pago. Los límites de velocidad varían según el nivel del plan.
¿Utiliza la misma base de conocimientos que el widget de chat?+
Sí. La API ask() consulta los mismos documentos, contenido del sitio web y PDFs que alimentan tu widget de chat.
¿Puedo usarla del lado del servidor?+
La API ask() está diseñada para uso del lado del cliente mediante el SDK del widget. Para acceso del lado del servidor, usa la API REST.
¿Hay impacto de latencia en la página?+
Las solicitudes son asíncronas y no bloquean el renderizado de la página. El tiempo de respuesta típico es de 1–3 segundos.