Visión general de API Agent

Editar en línea

Una visión general de la interfaz de usuario API Agent y sus componentes clave.

En esta página se supone que ya ha iniciado sesión en API Agent. Si necesitas ayuda para iniciar sesión, consulta la sección «Primeros pasos ».
Nota: El aspecto real de las imágenes puede variar ligeramente, ya que se actualizan con regularidad. Además, los temas locales de Visual Studio Code y las personalizaciones de la interfaz de usuario pueden afectar a la apariencia.

Detalles de la conexión

Después de conectarte, puedes ver los detalles de tu conexión en la barra superior izquierda. Puede hacer clic en el texto a la izquierda de AI para acceder a información más específica, que incluye la gestión de API Connect URL y su organización proveedora.

Captura de pantalla de la barra superior izquierda

Captura de pantalla de los detalles de la conexión

Nuevo chat

  1. Haga clic en el menú IBM Agente API y seleccione Nuevo chat para iniciar una nueva sesión.

    Captura de pantalla del menú Agente API

  2. Seleccione una organización proveedora. Ya debes ser miembro de esta organización, y el API Agent debe estar habilitado allí para ti. Esto le permite utilizar la página API Agent.

    Captura de pantalla del nuevo chat en el Agente API

  3. Haga clic en Continuar. Aparece un mensaje de bienvenida.

    Captura de pantalla del mensaje de bienvenida en el Agente API

  4. En el campo Escriba algo, introduzca texto para empezar a interactuar con API Agent.

Planifique

Después de introducir un comando, API Agent muestra o ejecuta un plan, que es una serie de herramientas, cada una con sus argumentos correspondientes, diseñadas para satisfacer la petición del usuario.
  • Los planes que no modifican el sistema (operaciones de sólo lectura) se ejecutan automáticamente y no requieren la aprobación del usuario.
  • Los planes que modifican el estado del sistema (como la creación, actualización o eliminación de recursos) requieren la aprobación explícita del usuario antes de su ejecución.

El siguiente ejemplo muestra el plan para el mensaje de usuario de create test cases for the petstore api and run the test cases.

Captura de pantalla de ejemplo de API de tienda de mascotas y casos de ejecución

Visualización y edición del plan

Después de visualizar un plan, puede ver y modificar las sugerencias para cada herramienta. Si las sugerencias por defecto proporcionadas por API Agent son satisfactorias, puede aprobarlas y continuar.

Para realizar cualquier cambio, seleccione Editar plan para abrir la ventana Editar plan, donde podrá realizar cambios en los valores.

Captura de pantalla de la opción de edición en el ejemplo de API de tienda de mascotas y casos de ejecución

Aprobación

Se requiere la aprobación del usuario para ejecutar cualquier herramienta que realice cambios en el estado del sistema. Estas herramientas no pueden ejecutarse sin el consentimiento explícito del usuario.

Comprender las respuestas

Cada respuesta es un resultado que se muestra para la ejecución de una única herramienta. Incluye un resumen, expanda la opción de la flecha para ver una respuesta detallada del sistema.

Después de hacer clic en Aprobar, la herramienta se ejecuta y muestra una respuesta. A continuación se muestra un ejemplo de ejecución con éxito.

Errores

Si su consulta solicita una acción que API Agent no puede realizar porque el sistema carece del conjunto de herramientas adecuado para la solicitud. En API Agent se indica que la solicitud no puede completarse con las herramientas actuales. A continuación, enumerará las herramientas disponibles y sus breves descripciones. Los demás errores son errores de ejecución de las herramientas. En estos casos, API Agent ofrece un resumen del error que se ha producido durante la ejecución de la herramienta.

Captura de pantalla del tiempo para San José en el agente API

Terminando de forma anómala

Tiene la opción de ignorar el plan generado e iniciar otra solicitud. Si elige esta opción, no se tendrán en cuenta la consulta y la acción anteriores.

Captura de pantalla de la lista rápida de API publicadas en el Agente API

Mandatos

Puede ejecutar directamente algunas de las herramientas disponibles utilizando /commands. Si empieza a escribir la barra oblicua (/), podrá ver la lista de comandos disponibles.

Captura de pantalla de los comandos disponibles en el agente API

Para pasar parámetros, hay que dar valores en formato key:value . Se permite un espacio antes del valor, lo que facilita la especificación del archivo a cargar. A continuación se muestra un ejemplo de uso de /command.

Captura de pantalla de ejemplo de formato clave:valor

Cargar y descargar archivos

Algunos comandos necesitan que se carguen archivos. El archivo debe estar en su espacio de trabajo Visual Studio Code para poder cargarlo.

Captura de pantalla del icono para cargar archivos

Si introduce @ en el campo Tipo algo, aparecerá una lista de los archivos disponibles. A medida que introduce caracteres, la lista se filtra en consecuencia. Puede seleccionar un archivo en cualquier momento de este proceso.

Captura de pantalla de los archivos listados después de escribir @ en el campo escribe algo

Si aparece @file name , puede cargar un archivo desde el espacio de trabajo local.

Siempre que se mencione api_name, puede utilizarlo con id, name:version, o el nombre de un draft API. Utilizar sólo el nombre es aceptable siempre que sólo haya un borrador de API con ese nombre específico. Sin embargo, no está permitido utilizar el título de una API. Las mismas directrices se aplican cuando se menciona product_name .

Algunos comandos permiten descargar archivos de la respuesta, lo que se indica mediante un icono de descarga.

Captura de pantalla del icono de descarga bajo el archivo descargable en el chat