Adición de una extensión al asistente

Después de crear una extensión personalizada, debe añadirla al asistente para que se pueda acceder a ella mediante acciones.

Añadir la extensión al asistente configura la extensión para su uso en un entorno concreto, y hace que la extensión esté disponible para que pueda ser llamada desde acciones.

Puede utilizar distintos detalles de configuración para cada entorno. Por ejemplo, es posible que desee utilizar el URL para un servidor de prueba en el borrador de entorno, pero un servidor de producción en el entorno activo.

Para obtener información sobre cómo crear una extensión personalizada, consulte Crear una extensión personalizada.

Adición de la extensión al borrador de entorno

Para añadir una extensión personalizada al asistente, siga estos pasos:

  1. En la página Integraciones de ' Icono de integraciones ', desplácese hasta la sección Extensiones y busque la ficha de la extensión personalizada que desea añadir.

  2. Pulse Añadir. Revise la visión general de la extensión y pulse Confirmar para configurarla para su asistente.

    Cuando añade por primera vez una extensión a un asistente, los valores de configuración que especifique se aplican solo al borrador de entorno. Debe completar la configuración para el borrador de entorno antes de poder añadir la extensión al entorno activo. Lea la sección Configuración de la extensión para el entorno en vivo para aprender a añadir la extensión personalizada al entorno en vivo o a otro entorno.

  3. Lea la información del paso Cómo empezar y, a continuación, pulse Siguiente.

  4. En el paso Autenticación, especifique la información de autenticación y servidor que desea que utilice su asistente cuando llame al servicio.

    • En el campo Tipo de autenticación, seleccione el tipo de autenticación que desea utilizar (o Sin autenticación si la API no está autenticada). Los tipos de autenticación disponibles vienen determinados por los esquemas de seguridad definidos en el documento OpenAPI.

    • Especifique la información adicional necesaria para el tipo de autenticación que ha seleccionado (como el nombre de usuario y la contraseña, la clave de API, el token de portador o los detalles de OAuth 2.0 ).

      Para obtener más información sobre la configuración de la autenticación OAuth ' 2.0 ', consulte ' Autenticación OAuth ' 2.0 .

    • En el campo Servidores, seleccione el URL del servidor que desea utilizar.

      Si el URL seleccionado contiene alguna variable, especifique también los valores a utilizar. En función de cómo se defina cada variable en el documento de OpenAPI, puede seleccionar entre una lista de valores válidos o escribir el valor que desea utilizar en el campo.

      El mensaje URL generado muestra el URL completo que utiliza el asistente, incluidos los valores de las variables.

    Pulse Siguiente.

  5. La tabla Revisar operaciones muestra las operaciones que el asistente puede llamar desde un paso de acción. Una operación es una solicitud mediante el uso de un método concreto de HTTP, como GET o POST, en un recurso concreto.

    Revisar la tabla de operaciones
    Revisar la tabla de operaciones

    Para cada operación, una fila de la tabla muestra la siguiente información:

    • Operación: descripción de la operación, que se deriva de summary (si está presente) o de description en el archivo OpenAPI.
    • Método: el método HTTP utilizado para enviar la solicitud de API para la operación.
    • Recurso: la vía de acceso al recurso sobre el que actúa la operación.

    Para ver más información sobre una operación, haga clic en el icono " Etiqueta " situado junto a su fila en la tabla. Se muestran los siguientes detalles:

    • Parámetros de solicitud: la lista de parámetros de entrada definidos para la operación, junto con el tipo de cada parámetro y si el parámetro es necesario u opcional.
    • Propiedades de la respuesta: Las propiedades del cuerpo de la respuesta que se asignan a variables a las que puede acceder el asistente.

  6. Pulse Finalizar.

  7. Pulse Cerrar para volver a la página Integraciones.

La extensión está ahora conectada al asistente y está disponible para las acciones en el borrador de entorno.

Gestión de la ampliación

Después de añadir la extensión personalizada al entorno, puede revisar o sustituir el documento OpenAPI de la misma, y actualizar el tipo de autenticación.

  1. En la extensión, haga clic en Abrir.

  2. Seleccione el entorno en el que desea gestionar la extensión personalizada y haga clic en Confirmar.

  3. En el paso Gestionar extensión, puede revisar y sustituir el documento OpenAPI importado si es necesario. Para más información sobre la sustitución del documento " OpenAPI ", consulte " Sustitución del documento " OpenAPI .

  4. En la pestaña Autenticación, verá información sobre los métodos de autenticación definidos en el documento OpenAPI. La tabla " ". Campos de la pestaña Autenticación La tabla " proporciona información detallada sobre los campos de la pestaña Autenticación:

    Nombre de campo Descripción Valores
    Tipo de autenticación El tipo de autenticación configurado en el script OpenAPI. - OAuth 2.0
    - Basic Auth
    - API key auth
    - Bearer auth
    Nombre de usuario La credencial del nombre de usuario en el script OpenAPI. Por ejemplo: user
    Contraseña La credencial de contraseña configurada en el script OpenAPI. Por ejemplo: Password@123
    Servidores El enlace al servidor que se define en el documento Open API para conectarse a la extensión de la API. Por ejemplo: https://custom-extension-server.xyz

Autenticación OAuth 2.0

Si está configurando la autenticación OAuth 2.0, la información que debe proporcionar depende del tipo de concesión.

Para más información sobre OAuth ' 2.0' , consulte ' OAuth ' 2.0.

Para completar la configuración de la autenticación OAuth, siga estos pasos:

  1. Si aún no lo ha hecho, registre su aplicación en la API externa a la que desea acceder. Copie el ID de cliente y el secreto de cliente proporcionados por la API externa.

  2. En el campo Tipo de subvención, seleccione el tipo de subvención que desea utilizar. Los tipos de subvención disponibles vienen determinados por los flujos definidos en el objeto " securitySchemes " del documento OpenAPI. Se admiten códigos de autorización, credenciales de cliente, contraseñas y tipos de concesión personalizados que empiecen por " x- ".

    El tipo de concesión personalizada OAuth2 ' x-<any custom name> es utilizado por el mecanismo de autenticaciónIBM IAM y por watsonx.

  3. Especifique los valores requeridos que fueron proporcionados por la API externa cuando registró su aplicación. Los valores requeridos dependen del tipo de subvención:

    Tipos de otorgamiento
    Tipo de concesión Valores requeridos
    Código de autorización
    • ID de cliente
    • Secreto de cliente
    Credenciales de cliente
    • ID de cliente
    • Secreto de cliente
    Contraseña
    • ID de cliente
    • Secreto de cliente
    • Nombre de usuario
    • Contraseña
    x-<any custom name>
    • Una lista de los campos secretos mencionados en el archivo de especificaciones openAPI

  4. Si utiliza el tipo de subvención Código de autorización, siga estos pasos:

    1. Copie la redirección URL de la página de configuración de la extensión del AI assistant builder y péguela en el campo correspondiente de la página de registro de la aplicación para la API externa. (La redirección URL se denomina a veces devolución de llamada URL.)

    2. Haga clic en Conceder acceso. Se le redirige a la página de autorización del sitio web del servicio externo. Compruebe que se concede el acceso correcto y haga clic para aprobar. A continuación, se le redirige de nuevo a la página de configuración de la extensión mediante la redirección URL.

  5. En el campo Autenticación del cliente, especifique si las credenciales de autenticación se envían en un encabezado HTTP o como parte del cuerpo de la solicitud. (Las credenciales que se envían en el cuerpo de la solicitud utilizan el tipo de contenido " x-www-form-urlencoded ") Seleccione la opción esperada por el servicio externo.

  6. En el campo Prefijo de cabecera, especifique el prefijo que precede al token de acceso en la cabecera " Authorization ". (El prefijo por defecto es ' Bearer, que es el típico para la mayoría de las aplicaciones)

  7. Si utiliza el tipo de subvención personalizada " x-<any custom name> (por ejemplo, x-apikey), siga estos pasos:

    1. Añade los valores secretos asociados a los campos secretos.
    2. Añade los valores de los parámetros opcionales, si los hay.

Si el servicio externo admite el tipo de concesión Refresh Token, el generador de asistentes AI obtiene automáticamente un nuevo token de acceso cuando caduca el antiguo. Si el documento OpenAPI define el atributo refreshUrl , se utiliza el URL especificado; en caso contrario, se utiliza el tokenUrl URL.

Configuración de la extensión para el entorno activo

Para configurar la extensión para el entorno activo, siga estos pasos:

  1. En la página Integraciones de ' Icono de integraciones ', desplácese hasta la sección Extensiones y busque la ficha de la extensión personalizada que desea añadir.

  2. Haz clic en Abrir. Se abre la ventana Abrir extensión personalizada.

  3. En el campo Entorno, seleccione Activo. Pulse Confirmar.

  4. Repita el proceso de configuración, especificando los valores que desea utilizar para el entorno en vivo.

    Si utiliza varios entornos, siga los mismos pasos para configurar la extensión para cada entorno. Para obtener más información, consulte Añadir y utilizar varios entornos.

La extensión ya está disponible en los entornos que configuró, y puede llamarse desde el asistente. Para obtener más información sobre cómo llamar a una extensión de una acción, consulte Llamar a una extensión personalizada.