Saltar al contenido

Usa el Asistente AI del Administrador de API de Jitterbit

Introducción

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

Encabezado del Administrador de API con el asistente AI abierto

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, utiliza el menú desplegable para seleccionar Asistente APIM.

  • Desde estas páginas del Administrador de API, haz clic en Nuevo > Construir con AI:

  • En Studio, usa el menú de acciones de operación para seleccionar Publicar como 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.

Controles del Asistente AI de APIM

El panel del Asistente AI de APIM 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.

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.

Comenzar

Para comenzar a usar el Asistente de IA de APIM, utiliza un 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 API a mi API existente "Clientes".
  • Enumera las APIs en borrador disponibles para mí.
  • Elimina uno de los servicios 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 Copia de, la raíz del servicio se precederá con Copia de y la versión se añadirá con 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 "Clientes" con un nuevo perfil para autenticación básica.
  • Asigna mi perfil de seguridad "Portal de Empleados" existente a la API "Empleados".
  • 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 "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.
  • 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 "Red de Oficina" con el rango 192.0.2.10 a 192.0.2.50
  • Agrega un nuevo rango de IP al grupo "Red de Oficina".
  • Muéstrame todos los grupos de IP de confianza.
  • Asigna el grupo de IP de confianza "Red de Oficina" a mi perfil de seguridad.

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 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, pregunta 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.

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.