Eddy AI está integrado en tu referencia de API publicada, para que los desarrolladores puedan hacer preguntas sobre un endpoint y obtener respuestas sin dejar la documentación. En lugar de reconstruir cómo funciona un endpoint solo a partir de los parámetros, el esquema y la muestra de código, un desarrollador puede preguntar directamente a Eddy — cómo se comporta el endpoint, qué autenticación necesita o una muestra de código en un lenguaje específico — y obtener una respuesta basada en la propia especificación de ese endpoint.
Este artículo explica cómo los desarrolladores utilizan Eddy AI en la referencia de la API y cómo habilitarlo para la documentación de tu API. Para una visión general de la experiencia del lector, véase fundamentos de API.
Dónde encontrar Eddy AI
Eddy AI está disponible directamente desde los paneles en una página de endpoint. Busca el icono de Ask Eddy AI en cada uno de los siguientes lugares:
- Panel de código — pregunta por el ejemplo de la solicitud, por ejemplo para explicarlo o convertirlo a otro lenguaje.
- Panel de solicitudes — pregunta sobre la petición que estás construyendo en Pruébalo!.
- Panel de respuesta — pregunta sobre la respuesta, como qué significa un campo o estado en particular.
Al hacer clic en el icono se abre el panel de Eddy AI, que ya está con el alcance del punto final que estás viendo.
Haciendo una pregunta
Cuando abras Eddy AI, puedes elegir uno de los prompts sugeridos o escribir tu propia pregunta.
Los prompts sugeridos son:
- Explica este punto final
- Muestra un ejemplo de rizo
- ¿Qué autenticación necesita esto?
Para preguntar otra cosa, escribe tu pregunta en el campo Hacer una pregunta... y envíala. Eddy responde usando la especificación del endpoint actual, por lo que sus respuestas reflejan el camino real, los parámetros, la autenticación y el esquema de ese endpoint — no ejemplos genéricos.
Por ejemplo, pedir una muestra de solicitud en un lenguaje concreto devuelve un fragmento listo para usar creado para ese punto final, incluyendo su URL correcta y autenticación, con un control para copiar el código.
Habilitar Eddy AI para la documentación de tu API
Eddy AI debe estar habilitada para la documentación de tu API antes de aparecer en la referencia publicada. Esto lo configura un administrador en el portal de la Base de conocimiento.
- Ve a Ajustes > Configuración de IA > Ajustes de Eddy AI.
- En la sección de la suite de búsqueda , selecciona la casilla de verificación de documentación de la API .
- Guarda tus cambios.
Una vez habilitado, el icono de Ask Eddy AI aparece en los paneles de endpoint en tu referencia de API publicada.
Cosas a tener en cuenta
- Las respuestas de Eddy AI se dirigen al punto final. Las respuestas se generan a partir de la especificación del endpoint que estás viendo, por lo que reflejan los detalles reales de ese endpoint en lugar de ejemplos genéricos.
- El uso de la IA consume créditos. Dependiendo de tu plan, el uso de Eddy AI puede contar para la asignación de crédito de IA de tu proyecto. Consulta los términos de crédito de IA de tu plan si esperas un uso intensivo.
Preguntas frecuentes
¿Dónde aparece Eddy AI en la referencia de la API?
El icono de Ask Eddy AI aparece en los paneles de Código, Solicitud y Respuesta de una página de endpoint. Al hacer clic se abre el panel de IA de Eddy que lleva a ese punto final.
¿Qué puedo preguntarle a Eddy AI?
Puedes usar uno de los prompts sugeridos — Explica este endpoint, Muestra un ejemplo de curl o ¿Qué autenticación necesita esto? — o escribe tu propia pregunta. Eddy responde usando la especificación del endpoint actual, por lo que sus respuestas reflejan el camino real, los parámetros y la autenticación de ese endpoint.
¿Por qué no veo el icono de Ask Eddy AI en mi referencia de API?
Eddy AI debe estar habilitada primero para la documentación de la API. Un administrador puede activarlo en Configuración > configuración de IA > configuración de Eddy AI seleccionando la casilla de documentación de la API en la sección de la suite de búsqueda.