Crear una API con el Asistente AI del Jitterbit API Manager

Introducción

El Asistente AI de APIM te ayuda a crear y mantener activos en el API Manager interactuando con él utilizando lenguaje natural escrito.

Nota

Para usar el Asistente AI de APIM, tu licencia de Harmony debe incluir la opción del Asistente AI de APIM. Contacta a tu Gerente de Éxito del Cliente (CSM) para agregar esta opción a tu licencia.

Acceder al Asistente AI

Accede al asistente desde estos lugares:

En el encabezado del portal de Harmony en cualquier página del API Manager o Studio, utiliza el ícono Jitterbit AI. En el panel, usa el menú desplegable para seleccionar Asistente APIM.
En la página de APIs del API Manager, haz clic en Nuevo > Construir con AI.
En Studio, utiliza el menú de acciones de operación para seleccionar Publicar como una API usando AI.
En la página del Asistente AI de la Consola de Gestión, accede a la interfaz dedicada de página completa para conversaciones extendidas.

Interacciones soportadas

Las siguientes interacciones 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 confiables: Crear, editar, asignar y eliminar.
Grupos de API: Crear, editar, asignar y eliminar.
Información de API: Obtener explicaciones detalladas y perspectivas sobre APIs existentes.

Consejo

El asistente proporciona explicaciones más ricas y detalladas cuando tu API incluye descripciones completas y documentación OpenAPI.

Controles del Asistente AI

El panel del Asistente AI incluye estos controles:

Inicio: Regresar al chat actual desde el historial de chats.
Historial: Navegar por tus chats anteriores con el Asistente AI y seleccionar uno para ver.
Nuevo chat: Iniciar un nuevo chat.
Chat de usuarios: Ver 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 Admin permiso.

Comenzar

Para comenzar a usar el Asistente AI de APIM, utiliza un lenguaje natural para decirle al asistente lo que te gustaría que hiciera. Por ejemplo:

Ejemplos de solicitudes de usuario

Crea una nueva API proxy usando valores predeterminados.
Agrega un nuevo servicio API a mi API existente "Clientes".
Lista las APIs en borrador disponibles para mí.
Elimina uno de los servicios API de "Productos".
Cuéntame sobre la API "Productos".

El asistente te guiará a través del proceso de creación o actualización de una API. Pedirá confirmación cuando sea necesario, te solicitará más información cuando lo requiera y confirmará cuando haya realizado una acción.

También puedes crear, editar, asignar y eliminar perfiles de seguridad, grupos de API y grupos de IP de confianza, ya sea al crear o editar una API, o como una interacción separada:

Ejemplos de solicitudes de usuario

Crea un grupo de API llamado "API_GRP_1" con las APIs "Clientes" y "Productos".
Agrega la nueva API "Órdenes" a "API_GRP_1", luego lista todas las APIs en "API_GRP_1".
Cambia el nombre de "API_GRP_1" a "API_GROUP_1" y elimina la API "Clientes" de él.
Asegura la API "Clientes" con un nuevo perfil para autenticación básica.
Asigna mi perfil de seguridad existente "OAuth 123".

También puedes eliminar o clonar una API personalizada para crear una copia de ella:

Ejemplos de solicitudes de usuario

Elimina la API en borrador "Órdenes".
Quiero clonar una API existente. Muéstrame todas las APIs disponibles para clonar.

Al pedirle al asistente que elimine una API, te advertirá si la API está actualmente publicada, te pedirá que verifiques que deseas eliminarla y confirmará si ha sido eliminada con éxito.

Un nombre de API clonada se precederá con Copy of, la raíz del servicio se precederá con Copyof, y la versión se anexará con un número incrementado.

También puedes publicar y probar APIs:

Ejemplos de solicitudes de usuario

Dame una lista de APIs en borrador disponibles para publicar.
Publica la API "Clientes".
Prueba la API "Clientes".

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 motivos de seguridad. (Tus credenciales no se comparten con el LLM.)

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.

Recomendaciones

Deberías interactuar con el Asistente de IA de APIM como lo harías con cualquier modelo de lenguaje grande (LLM) de producto de IA.

Se recomiendan las siguientes sugerencias:

Escribe en inglés utilizando la redacción que te resulte más 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, pregunta al asistente en lenguaje natural qué puede hacer, o escribe help.
Lee las solicitudes cuidadosamente antes de escribir tu respuesta. Si hay algo que no entiendes, pídele al asistente que aclare.
Una vez que el asistente haya terminado la configuración de los activos, revisa y confirma lo que creó navegando por la configuración en el Administrador de API. Si alguna configuración no es la esperada, puedes pedirle 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 mientras se crea una API proxy.

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.