Usa el Asistente AI del Administrador de API de Jitterbit
Introducción
Usando lenguaje natural escrito, el Asistente AI de APIM te ayuda a crear y mantener activos en el Administrador de API, así como a consultar, explicar y descargar datos analíticos de API.
Nota
Para usar el Asistente AI de APIM, tu licencia de Harmony debe incluir la opción de Asistente AI de APIM. Contacta a tu Gerente de Éxito del Cliente (CSM) para agregar esta opción a tu licencia.
Acceso al Asistente AI de APIM
Accede al asistente desde estos lugares:
-
En el encabezado del portal de Harmony en cualquier página del Administrador de API o Studio, usa el ícono Jitterbit AI. En el panel, usa el menú desplegable para seleccionar Asistente AI de APIM.
-
Desde estas páginas del Administrador de API, haz clic en Nuevo > Construir con AI:
-
En la página de Analíticas, haz clic en Preguntar a AI.
-
En Studio, usa el menú de acciones de operación para seleccionar Publicar como una API usando AI.
-
En la página de Asistente AI de la Consola de Administración, accede a la interfaz dedicada de página completa para conversaciones extendidas.
Controles del Asistente AI de APIM
El panel del Asistente AI de APIM incluye estos controles:
- Inicio: Regresa al chat actual desde el historial de chats.
- Historial: Navega por tus chats anteriores con el Asistente AI y selecciona uno para ver.
- Copiar chat: Copia la conversación completa al portapapeles.
- Nuevo chat: Inicia un nuevo chat.
- Chat de usuarios: Ve el historial de chat para un usuario específico seleccionando su dirección de correo electrónico. Esta opción está disponible solo para usuarios con permiso de Admin.
- Expandir: Expande el chat. Una vez expandido, haz clic en el ícono Minimizar para regresar a la vista anterior.
- Redimensionar: Arrastra el borde izquierdo del panel para ajustar su ancho.
Interacciones y capacidades soportadas
Las siguientes interacciones y capacidades son soportadas:
- APIs personalizadas: Crear, publicar, editar, probar, clonar y eliminar.
- APIs proxy: Crear, publicar, editar y probar.
- Perfiles de seguridad: Crear, editar, asignar y eliminar.
- Grupos de IP de confianza: Crear, editar, asignar y eliminar.
- Grupos de API: Crear, editar, asignar y eliminar.
-
Información de API: Obtener explicaciones detalladas y perspectivas sobre las APIs existentes.
Consejo
El asistente proporciona explicaciones más ricas y detalladas cuando tu API incluye descripciones completas y documentación OpenAPI.
-
Analíticas: Consultar, explicar, resumir y descargar datos analíticos de API, incluyendo llamadas a la API, tiempo de respuesta, códigos de estado, errores, utilización de límites de tasa, violaciones de políticas y perspectivas de consumidores e IP.
Comenzar
Para comenzar a usar el Asistente AI de APIM, utiliza lenguaje natural para decirle al asistente lo que te gustaría que hiciera. El asistente te guiará a través del proceso de creación o actualización de activos. Te pedirá confirmación cuando sea necesario, te solicitará más información cuando lo requiera y confirmará cuando haya realizado una acción.
Si necesitas ayuda para entender cómo responder al asistente, pídele que aclare lo que significa o utiliza la documentación de la interfaz de usuario como referencia suplementaria.
APIs
Puedes crear, editar, publicar, probar, clonar y eliminar APIs.
Ejemplos de solicitudes de usuario
- Crea una nueva API proxy utilizando valores predeterminados.
- Agrega un nuevo servicio de API a mi API existente "Clientes".
- Enumera las APIs en borrador disponibles para mí.
- Elimina uno de los servicios de API de "Productos".
- Háblame sobre la API "Productos".
- 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á actualmente publicada, te pedirá que verifiques que deseas eliminarla y confirmará cuando haya sido eliminada con éxito.
Cuando clonas una API personalizada, el nombre de la API clonada se precederá con Copy of, la raíz del servicio se precederá con Copyof, y la versión se le añadirá un número incrementado.
Cuando el asistente está probando una API asegurada con autenticación básica, proporcionará un diálogo de interfaz de usuario separado para ingresar 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 al crear o editar una API, o como una interacción separada.
Ejemplos de solicitudes de usuario
- 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 entorno de Producción.
Grupos de API
Puedes crear, editar, asignar y eliminar grupos de API.
Ejemplos de solicitudes de usuario
- 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 él.
- Muéstrame todos los grupos de API en mi organización.
Grupos de IP de confianza
Puedes crear, editar, asignar y eliminar grupos de IP de confianza.
Ejemplos de solicitudes de usuario
- Crea un grupo de IP de confianza 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 de confianza.
- Asigna el grupo de IP de confianza "Office Network" a mi perfil de seguridad.
Analíticas
Puedes pedirle al asistente que consulte, explique, resuma y descargue datos de la página de Analíticas. El asistente utiliza automáticamente el entorno, rango de tiempo, API, versión, método, código de estado y filtros de perfil que actualmente se aplican en la página de Analíticas, por lo que no necesitas reiterar ese contexto en tu solicitud.
Ejemplos de solicitudes de usuario
- ¿Qué APIs tienen el mayor número de llamadas en los últimos 7 días?
- Muéstrame la tendencia de llamadas de esta API.
- ¿Qué APIs tienen más errores 5xx (error del servidor)?
- ¿Cuál es el número de llamadas por minuto (CPM) en este momento?
- ¿Estamos acercándonos a los límites de tasa?
- ¿Qué consumidores o direcciones IP generan más llamadas a la API?
- Resume el rendimiento de la API esta semana y destaca los problemas clave.
- Descarga las métricas de llamadas de los últimos 7 días.
- Expande el gráfico de "Total de llamadas".
- Colapsa este gráfico de "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 de Analítica.
También puedes hacer preguntas analíticas desde otras páginas del Administrador de API. El asistente te navega a la página de Analítica para responderlas.
También puedes pedirle al asistente que expanda o colapse un gráfico individual. El asistente hace esto solo cuando se lo pides.
También puedes pedirle al asistente que descargue datos de la tabla de monitoreo de salud de la API o de los gráficos dentro de las secciones de métricas de llamadas y consumidores de API 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 de Analítica a la descarga.
Nota
El asistente devuelve y descarga solo los datos analíticos que tienes permiso para ver.
Recomendaciones
Debes interactuar con el Asistente AI de APIM como lo harías con cualquier modelo de lenguaje grande (LLM) de producto de IA. Sigue estas sugerencias:
-
Escribe en inglés usando la redacción que te resulte natural, como si estuvieras hablando con una persona con tu propio nivel de conocimiento en TI y negocios. Se pueden usar otros idiomas, pero no han sido validados.
-
Para obtener ideas sobre qué interacciones puedes realizar, pregúntale al asistente en lenguaje natural qué puede hacer, o escribe
help. -
Lee las respuestas del asistente cuidadosamente antes de escribir tu respuesta. Si hay algo que no entiendes, pide al asistente que 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 interfaz de usuario. Si alguna configuración no es la esperada, puedes pedir al asistente que las edite o editarlas directamente.
Limitaciones
Las siguientes interacciones aún no son compatibles:
- Clonar y eliminar APIs proxy.
- Exportar e importar APIs.
- Subir un documento OpenAPI al crear una API proxy.
- Análisis predictivo, remediación automática o creación de alertas a partir de datos analíticos.
- Informes analíticos o exportaciones más allá de la descarga en CSV.
Problema conocido
Cuando el asistente te pida 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 y vuelve a iniciar sesión para que el asistente devuelva una lista actualizada de entornos.
