Usar el Asistente de IA de Jitterbit API Manager
Introducción
El Asistente de IA de APIM ayuda a crear y mantener activos en API Manager, y a consultar, explicar y descargar datos de análisis de API mediante lenguaje natural escrito.
Nota
Para usar el Asistente de IA de APIM, la licencia de Harmony debe incluir la opción Asistente de IA de APIM. Contacta a tu Gestor de Éxito del Cliente (CSM) para agregar esta opción a tu licencia.
Acceder al Asistente de IA de APIM
Accede al asistente desde estos lugares:
-
En el encabezado del portal Harmony en cualquier página de API Manager o Studio, usa el icono Jitterbit AI. En el panel, utiliza el menú desplegable para seleccionar APIM AI Assistant.
-
Desde estas páginas de API Manager, haz clic en New > Build with AI:
-
En la página Analytics, haz clic en Ask AI.
-
En Studio, utiliza el menú de acciones de operación para seleccionar Publish as an API using AI.
-
En la página AI Assistant de Management Console, accede a la interfaz dedicada de página completa para conversaciones extendidas.
Controles del Asistente de IA de APIM
El panel del Asistente de IA de APIM incluye estos controles:
- Home: Regresa al chat actual desde el historial de chats.
- History: Explora tus chats anteriores del Asistente de IA y selecciona uno para verlo. Para usuarios con permiso de Admin, cada chat en la lista también muestra su uso de tokens (Prompt, Cached y Response) una vez que el chat tenga al menos un intercambio de mensajes. Los usuarios sin permiso de Admin solo ven los títulos de los chats.
- Copy chat: Copia la conversación completa al portapapeles.
- New chat: Inicia un nuevo chat.
- Expand: Expande el chat. Una vez expandido, haz clic en el icono Minimize para volver a la vista anterior.
- More actions: Abre un menú con la siguiente opción:
- Users chat: Ver historial de chats para un usuario específico seleccionando su correo electrónico. La lista de chats incluye el uso de tokens de cada chat, como en History. Esta opción está disponible solo para usuarios con permiso de Admin.
- Resize: Arrastra el borde izquierdo del panel para ajustar su ancho.
Interacciones y capacidades admitidas
Se admiten las siguientes interacciones y capacidades:
- Custom APIs: Crear, publicar, editar, probar, clonar y eliminar.
- Proxy APIs: Crear, publicar, editar y probar.
- Security profiles: Crear, editar, asignar y eliminar.
- Trusted IP groups: Crear, editar, asignar y eliminar.
- API groups: Crear, editar, asignar y eliminar.
-
API information: Obtener explicaciones e información detallada sobre las APIs existentes.
Consejo
El asistente proporciona explicaciones más ricas y detalladas cuando la API incluye descripciones exhaustivas y documentación OpenAPI.
-
Analytics: Consultar, explicar, resumir y descargar datos de análisis de API, incluidas llamadas a API, tiempo de respuesta, códigos de estado, errores, utilización de límite de velocidad, violaciones de políticas e información sobre consumidores e IPs.
Primeros pasos
Para empezar a usar el Asistente de IA de APIM, utiliza lenguaje natural para decirle al asistente qué te gustaría que hiciera. El asistente te guiará a través del proceso de creación o actualización de activos. Pedirá confirmación cuando sea necesario, te solicitará más información cuando la requiera y confirmará cuando haya realizado una acción.
Si necesitas ayuda para entender cómo responder al asistente, pídele que aclare qué significa o utiliza la documentación de la UI como referencia complementaria.
APIs
Puedes crear, editar, publicar, probar, clonar y eliminar APIs.
Ejemplos de indicaciones de usuarios
- Crea una nueva API proxy usando valores predeterminados.
- Agrega un nuevo servicio de API a mi API existente "Customers".
- Lista las APIs en borrador disponibles para mí.
- Elimina uno de los servicios de API de "Products".
- Cuéntame sobre la API "Products".
- Dame una lista de APIs en borrador disponibles para publicar.
Cuando le pidas al asistente que elimine una API, te advertirá si la API está publicada actualmente, te pedirá que confirmes que deseas eliminarla y confirmará cuando se haya eliminado exitosamente.
Cuando clonas una API personalizada, el nombre de la API clonada se antepone con Copy of, la raíz del servicio se antepone con Copyof y la versión se agrega con un número incrementado.
Cuando el asistente prueba una API protegida con autenticación básica, proporciona un diálogo de UI separado para que ingreses tus credenciales por razones de seguridad. Tus credenciales no se comparten con el modelo de lenguaje grande (LLM).
Perfiles de seguridad
Puedes crear, editar, asignar y eliminar perfiles de seguridad, ya sea mientras creas o editas una API, o como una interacción separada.
Ejemplos de indicaciones de usuarios
- Asegura la API "Customers" con un nuevo perfil para autenticación básica.
- Asigna mi perfil de seguridad existente "Employee Portal" a la API "Employees".
- Crea un nuevo perfil de seguridad con autenticación OAuth 2.0.
- Muéstrame todos los perfiles de seguridad en el ambiente Production.
Grupos de API
Puedes crear, editar, asignar y eliminar grupos de API.
Ejemplos de indicaciones de usuarios
- Crea un grupo de API llamado "API_GRP_1" con las APIs "Customers" y "Products".
- Agrega la nueva API "Orders" a "API_GRP_1", luego lista todas las APIs en "API_GRP_1".
- Renombra "API_GRP_1" a "API_GROUP_1" y elimina la API "Customers" de ella.
- Muéstrame todos los grupos de API en mi organización.
Grupos de IP confiables
Puedes crear, editar, asignar y eliminar grupos de IP confiables.
Ejemplos de indicaciones de usuarios
- Crea un grupo de IP confiables llamado "Office Network" con el rango 192.0.2.10 a 192.0.2.50
- Agrega un nuevo rango de IP al grupo "Office Network".
- Muéstrame todos los grupos de IP confiables.
- Asigna el grupo de IP confiables "Office Network" a mi perfil de seguridad.
Analytics
Puedes pedirle al asistente que consulte, explique, resuma y descargue datos de la página Analytics. El asistente utiliza automáticamente el ambiente, rango de tiempo, API, versión, método, código de estado y filtros de perfil actualmente aplicados en la página Analytics, así que no necesitas reestablecer ese contexto en tu indicación.
Ejemplos de indicaciones de usuarios
- ¿Cuáles APIs tienen las llamadas de API más altas en los últimos 7 días?
- Muéstrame la tendencia de llamadas de API para esta API.
- ¿Cuáles APIs tienen más errores 5xx (error de servidor)?
- ¿Cuál es el número de llamadas por minuto (CPM) ahora mismo?
- ¿Nos estamos acercando a los límites de velocidad?
- ¿Cuáles consumidores o direcciones IP generan la mayoría de las llamadas de API?
- Resume el rendimiento de la API esta semana y destaca los problemas clave.
- Descarga métricas de llamadas de los últimos 7 días.
- Expande el gráfico "Total calls".
- Colapsa este gráfico "Hits".
Cuando una solicitud requiere filtrar los datos, por ejemplo "mostrar solo errores 4xx" o "filtrar a esta API", el asistente aplica el filtro correspondiente en la página Analytics.
También puedes hacer preguntas de analytics desde otras páginas de API Manager. El asistente te navega a la página Analytics para responderlas.
También puedes pedirle al asistente que expanda o colapse un gráfico individual. El asistente hace esto solo cuando se lo solicites.
También puedes pedirle al asistente que descargue datos de la tabla API health monitoring o de los gráficos dentro de las secciones Call metrics y API consumers como un archivo CSV, coincidiendo con el comportamiento de Descargar como CSV para la tabla y el comportamiento de Descargar como CSV para gráficos individuales. El asistente aplica los filtros actualmente activos en la página Analytics a la descarga.
Nota
El asistente devuelve y descarga solo los datos analíticos que tienes permiso de ver.
Recomendaciones
Debes interactuar con el Asistente de IA de APIM como lo harías con cualquier producto de IA de modelo de lenguaje grande (LLM). Sigue estas sugerencias:
-
Escribe en inglés usando las palabras que te salgan de forma natural, como si hablaras con una persona con tu mismo nivel de conocimientos en TI y negocios. Pueden usarse otros idiomas pero no han sido validados.
-
Para obtener ideas sobre qué interacciones puedes realizar, pregunta al asistente en lenguaje natural qué puede hacer, o escribe
help. -
Lee atentamente las respuestas del asistente antes de escribir tu respuesta. Si hay algo que no entiendas, pídele al asistente que lo aclare.
-
Una vez que el asistente haya realizado una acción, puedes revisar y confirmar lo que hizo navegando por la configuración en la IU. Si alguna configuración no es la esperada, puedes pedirle al asistente que la edite o editarla directamente.
Limitaciones
Las siguientes interacciones aún no son compatibles:
- Clonar y eliminar API proxy.
- Exportar e importar API.
- Cargar un documento OpenAPI al crear una API proxy.
- Análisis predictivos, remediación automática o creación de alertas a partir de datos analíticos.
- Reportes de análisis o exportaciones más allá de la descarga de CSV.
Problema conocido
Cuando el asistente te solicita seleccionar un entorno, la lista puede estar desactualizada si has realizado cambios en los entornos en la misma sesión del navegador. Como solución alternativa, cierra sesión en el portal de Harmony e inicia sesión para que el asistente devuelva una lista actualizada de entornos.
