IBM Cloud Docs
Adición de una extensión al asistente

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 dentro de 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 Icono Integraciones Integraciones, desplácese hasta la sección Extensiones y busque el recuadro correspondiente a 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.

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

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

    • En el campo Tipo de autenticación, seleccione el tipo de autenticación a utilizar (o Sin autenticación si la API no está autenticada). Los tipos de autenticación disponibles están 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 (por ejemplo, el nombre de usuario y la contraseña, la clave de API, la señal portadora o los detalles de OAuth 2.0 ).

      Para obtener más información sobre cómo configurar 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 generada muestra la URL completa que utiliza el asistente, incluidos los valores de las variables.

    Pulse Siguiente.

  5. En el paso Gestionar extensión, puede revisar y sustituir el documento OpenAPI importado si es necesario. Para obtener más información sobre cómo sustituir el documento OpenAPI, consulte Sustitución del documento OpenAPI.

  6. En la pestaña Autenticación, verá información sobre los métodos de autenticación definidos en el documento OpenAPI. Tabla. Los campos de la pestaña Autenticación proporcionan detalles 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 de 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 está definido en el documento de Open API para conectarse. a la extensión de API. Por ejemplo, https://custom-extension-server.xyz
  7. 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 un método HTTP determinado, como GET o POST, sobre un recurso concreto.

    Revisar tabla de operaciones
    Revisar 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, pulse el icono etiqueta situado junto a su fila de 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.
  8. Pulse Finalizar.

  9. 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.

Autenticación OAuth 2.0

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

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

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

  1. Si todavía no lo ha hecho, registre la aplicación con la API externa a la que desea acceder. Copie el ID de cliente y el secreto de cliente que proporciona la API externa.

  2. En el campo Tipo de otorgamiento, seleccione el tipo de otorgamiento que desea utilizar. Los tipos de otorgamiento disponibles los determinan los flujos definidos en el objeto securitySchemes en el documento OpenAPI. El código de autorización, las credenciales de cliente, la contraseña y los tipos de otorgamiento personalizados que empiezan por x- están soportados.

    El tipo de otorgamiento personalizado OAuth2 x-<any custom name> lo utiliza el mecanismo de autenticación de IBM IAM y watsonx.

  3. Especifique los valores necesarios proporcionados por la API externa al registrar la aplicación. Los valores necesarios dependen del tipo de otorgamiento:

    Tipos de otorgamiento
    Tipo de concesión Valores necesarios
    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 campos secretos mencionados en el archivo de especificación openAPI
  4. Si está utilizando el tipo de otorgamiento Código de autorización, siga estos pasos:

    1. Copie el URL de redirección de la página de valores de extensión watsonx Assistant y péguelo en el campo adecuado en la página de registro de la aplicación para la API externa. (El URL de redirección se denomina a veces callback URL.)

    2. Haga clic en Conceder acceso. Se le redirigirá a la página de autorización en el sitio web para el servicio externo. Verifique que se está otorgando el acceso correcto y pulse para aprobar. A continuación, se le redirigirá de nuevo a la página de configuración de extensión utilizando el URLde redirección.

  5. En el campo Autenticación de cliente, especifique si las credenciales de autenticación se envían en una cabecera 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 que espera el servicio externo.

  6. En el campo Prefijo de cabecera, especifique el prefijo que precede a la señal de acceso en la cabecera Authorization. (El prefijo predeterminado es Bearer, que es típico para la mayoría de las aplicaciones.)

  7. Si utiliza el tipo de otorgamiento personalizado x-<any custom name> (por ejemplo, x-apikey), siga estos pasos:

    1. Añada los valores de secreto asociados a los campos de secreto.
    2. Añada los valores de parámetro opcionales, si los hay.

Si el servicio externo da soporte al tipo de otorgamiento Señal de renovación, watsonx Assistant obtiene automáticamente una nueva señal de acceso cuando caduca la antigua. Si el documento OpenAPI define el atributo refreshUrl, se utiliza el URL especificado; de lo contrario, se utiliza el tokenUrl URL de 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 Icono Integraciones Integraciones, desplácese hasta la sección Extensiones y busque el recuadro correspondiente a la extensión personalizada que desea añadir.

  2. Pulse 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 está utilizando varios entornos, siga los mismos pasos para configurar la extensión para cada entorno. Para obtener más información, consulte Adición y utilización de 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.

Límites de plan

El número de extensiones personalizadas que puede añadir a un asistente depende de su plan. Si ya ha añadido el número máximo de extensiones al asistente, debe eliminar una para poder añadir una nueva.

Límites de extensión por plan
Plan Extensiones por asistente
Enterprise 100
Premium (heredado) 100
Plus 10
Prueba 5
Lite 3
Standard (heredado) 0