Mis herramientas
Aquí se pueden agrupar las API que el Agent/Workflow necesita invocar como herramientas. Una herramienta puede incluir varias API.
Crear herramienta
En Mis herramientas, se puede crear una herramienta completando la información básica de la herramienta para finalizar su creación.
Al configurar la información de la herramienta, se puede redactar siguiendo el estilo de Swagger/OpenAPI.
- Nombre: El nombre de la herramienta.
- Descripción: La función específica de la herramienta. Se recomienda describirla en detalle para facilitar el reconocimiento por parte del LLM y que tome decisiones de invocación correctas.
Después de crear la herramienta, se deben completar los pasos de Autenticación y Configuración de API.
Autenticación
En la página Autenticación, se selecciona el tipo de autenticación. Actualmente, se ofrecen tres tipos: Bearer, Basic y Service.
Además, se debe indicar si se completa la autenticación aquí:
- Sí: Se debe completar aquí la información de autenticación para finalizarla. De este modo, cuando el Agent/Workflow utilice esta herramienta, no será necesario autenticarse de nuevo y podrá usarla directamente.
- No: No es necesario completar aquí la información de autenticación, pero cuando el Agent/Workflow utilice esta herramienta, será necesario autenticarse primero antes de usarla. Se puede indicar una URL en la Guía de autenticación (Authentication Guide) para orientar al desarrollador del Agent/Workflow a realizar la autenticación.
En la sección inferior Headers, se pueden añadir encabezados (Headers) comunes a todas las API de esta herramienta, para evitar tener que configurar repetidamente los parámetros de Headers en cada API.
API
La configuración de una API de herramienta se completa en cuatro pasos.
Paso 1: Completar la información básica
- Nombre: El nombre de la API, que debe seguir las convenciones de nomenclatura de API. Se recomienda usar la nomenclatura camelCase.
- Descripción: La descripción de la API. Se recomienda describirla en detalle para facilitar el reconocimiento por parte del LLM y que tome decisiones de invocación correctas.
- Método: El método de invocación de esta API.
- Ruta: La ruta de esta API. Debe comenzar con
/. En la ruta, se pueden usar llaves simples{pathVar}para insertar parámetros de tipoPath. Este parámetro se puede configurar específicamente en el Paso 2 (Parámetros de entrada). Por ejemplo,/getName/{userId}, y después configurar un parámetro denominadouserIden los parámetros de entrada.
Paso 2: Configurar los parámetros de entrada
Aquí es necesario configurar los parámetros de entrada de la API.
Consejo: Si la API dispone de documentación correspondiente, se puede completar consultándola.
- Nombre: El nombre del campo.
- Descripción: La descripción del campo.
- Tipo: El tipo del campo.
- Método: El método al que pertenece este campo.
- Obligatorio: Si este campo es obligatorio.
- Valor predeterminado: Definir un valor predeterminado para este campo.
Paso 3: Configurar los parámetros de salida
Configurar aquí la estructura de retorno de la API.
Se puede usar Auto Parse, con lo que el sistema representará automáticamente en la lista la estructura devuelta tras invocar la API, lo que ahorra el tiempo de completarla manualmente.
Paso 4: Depurar
Aquí se puede llamar a la API y depurarla. Si la invocación se realiza correctamente, la configuración de la API queda completada.
Usar herramienta
En Agent
En Agent, en la página Configuración, se busca Tools y se añaden para incorporar herramientas al Agent.
Durante las conversaciones, el Agent decidirá de forma autónoma qué herramientas invocar en función del contenido de la conversación.
En FlowAgent, en la configuración del componente LLM, se busca Tools y se añaden para incorporar herramientas al Agent.
Durante las conversaciones, el Agent decidirá de forma autónoma qué herramientas invocar en función del contenido de la conversación.
En Workflow
En el componente LLM, se busca Tools en la configuración del componente y se añaden las herramientas necesarias.
Durante la ejecución del workflow, si la ruta de ejecución pasa por el componente LLM, el LLM decidirá de forma autónoma las invocaciones de herramientas.
En el componente Tool, añadir directamente las API específicas de las herramientas que se necesiten utilizar.
Tras añadirlas, no es necesario personalizar los parámetros de entrada del nodo; el propio nodo ya ha establecido los parámetros de entrada de la API como parámetros de entrada predeterminados, por lo que se pueden pasar valores y utilizarlos directamente.
Durante la ejecución del workflow, si la ruta de ejecución pasa por el componente Tool, se invocará la API y se transmitirá el resultado devuelto a los nodos posteriores.