Ajout d'une extension à votre assistant

Après avoir créé une extension personnalisée, vous devez l'ajouter à l'assistant avant de pouvoir y accéder par des actions.

L'ajout de l'extension à l'assistant configure l'extension pour une utilisation dans un environnement particulier et rend l'extension disponible pour qu'elle puisse être appelée à partir d'actions.

Vous pouvez utiliser différents détails de configuration pour chaque environnement. Par exemple, vous pouvez envisager d'utiliser l'URL d'un serveur de test dans l'environnement de brouillon, mais un serveur de production dans l'environnement de production.

Pour plus d'informations sur la création d'une extension personnalisée, voir Générer une extension personnalisée.

Ajout de l'extension à l'environnement de brouillon

Pour ajouter une extension personnalisée à l'assistant, procédez comme suit :

Sur la page " " Integrations, faites défiler jusqu'à la section Extensions et trouvez la tuile correspondant à l'extension personnalisée que vous souhaitez ajouter.
Cliquez sur Ajouter. Passez en revue la présentation de l'extension et cliquez sur Confirmer pour la configurer pour votre assistant.

Lorsque vous ajoutez une extension à un assistant, les paramètres de configuration que vous fournissez sont appliqués uniquement à l'environnement de brouillon. Vous devez terminer la configuration de l'environnement de brouillon avant de pouvoir ajouter l'extension dans l'environnement de production. Lisez la section Configurer l'extension pour l'environnement réel pour savoir comment ajouter l'extension personnalisée à l'environnement réel ou à un autre environnement.
Lisez les informations de l'étape Démarrage, puis cliquez sur Suivant.
Dans l'étape Authentification, indiquez les informations d'authentification et de serveur que votre assistant doit utiliser lorsqu'il appelle le service.
- Dans le champ Type d'authentification, sélectionnez le type d'authentification à utiliser (ou Pas d'authentification si l'API n'est pas authentifiée). Les types d'authentification disponibles sont déterminés par les schémas de sécurité définis dans le document OpenAPI.
- Spécifiez les informations supplémentaires requises pour le type d'authentification sélectionné (telles que le nom d'utilisateur et le mot de passe, la clé API, le jeton porteur ou les détails OAuth 2.0 ).
  
  Pour plus d'informations sur la configuration de l'authentification OAuth 2.0, voir Authentification OAuth 2.0.
- Dans la zone Serveurs, sélectionnez l'URL du serveur à utiliser.
  
  Si l'URL sélectionnée contient des variables, indiquez également les valeurs à utiliser. Selon la façon dont chaque variable est définie dans le document OpenAPI, vous pouvez effectuer une sélection dans une liste de valeurs valides ou saisir la valeur à utiliser dans la zone.
  
  Le message Generated URL affiche le site URL complet utilisé par l'assistant, y compris les valeurs des variables.
Cliquez sur Suivant.
Le tableau des opérations de révision présente les opérations que l'assistant peut appeler à partir d'une étape d'action. Une opération est une demande effectuée à l'aide d'une méthode particulière HTTP, telle que GET ou POST, sur une ressource particulière.

Réviser le tableau des opérations

Pour chaque opération, une ligne du tableau affiche les informations suivantes :
- Opération : Description de l'opération, dérivée de summary (le cas échéant) ou de description dans le fichier OpenAPI.
- Méthode : Méthode HTTP utilisée pour envoyer la demande d'API pour l'opération.
- Ressource : Chemin d'accès à la ressource sur laquelle l'opération agit.
Pour obtenir plus d'informations sur une opération, cliquez sur l'icône " située à côté de la ligne correspondante dans le tableau. Les détails suivants sont affichés :
- Paramètres de la demande : Liste des paramètres d'entrée définis pour l'opération, ainsi que le type de chaque paramètre et si le paramètre est obligatoire ou facultatif.
- Propriétés de la réponse: Les propriétés du corps de la réponse qui sont associées à des variables auxquelles l'assistant peut accéder.
Cliquez sur Terminer.
Cliquez sur Fermer pour revenir à la page Intégrations.

L'extension est maintenant connectée à votre assistant et disponible pour être utilisée par des actions dans l'environnement brouillon.

Gestion de l'extension

Après avoir ajouté l'extension personnalisée à l'environnement, vous pouvez réviser ou remplacer son document OpenAPI et mettre à jour le type d'authentification.

Dans l'extension, cliquez sur Ouvrir.
Sélectionnez l'environnement dans lequel vous souhaitez gérer l'extension personnalisée, puis cliquez sur Confirmer.
Dans l'étape Gérer l'extension, vous pouvez revoir et remplacer le document OpenAPI importé si nécessaire. Pour plus d'informations sur le remplacement du document OpenAPI, voir Remplacement du document OpenAPI.

Dans l'onglet Authentification, vous trouverez des informations sur les méthodes d'authentification définies dans le document OpenAPI. Le tableau " . le tableau Champs de l'onglet Authentification donne des détails sur les champs de l'onglet Authentification :

Nom de zone	Description	Valeurs
Type d'authentification	Le type d'authentification défini dans le script OpenAPI.	- `OAuth 2.0` - `Basic Auth` - `API key auth` - `Bearer auth`
Nom d'utilisateur	Le nom d'utilisateur dans le script OpenAPI.	Exemple: `user`
Mot de passe	Le mot de passe défini dans le script OpenAPI.	Exemple: `Password@123`
Serveurs	Le lien vers le serveur défini dans le document Open API pour se connecter à l'extension API.	Exemple: `https://custom-extension-server.xyz`

Authentification OAuth 2.0

Si vous configurez l'authentification OAuth 2.0, les informations que vous devez fournir dépendent du type de subvention.

Pour plus d'informations sur OAuth 2.0, voir OAuth 2.0.

Pour terminer la configuration de l'authentification OAuth, suivez les étapes suivantes :

Si vous ne l'avez pas encore fait, enregistrez votre application auprès de l'API externe à laquelle vous souhaitez accéder. Copiez l'identifiant et le secret du client fournis par l'API externe.
Dans le champ Type de subvention, sélectionnez le type de subvention que vous souhaitez utiliser. Les types de subventions disponibles sont déterminés par les flux définis dans l'objet " securitySchemes du document OpenAPI. Le code d'autorisation, les informations d'identification du client, le mot de passe et les types de subventions personnalisées commençant par " x- sont pris en charge.

Le type de subvention personnalisé OAuth2 " x-<any custom name> est utilisé par le mécanisme d'authentificationIBM IAM et par watsonx.

Spécifiez les valeurs requises qui ont été fournies par l'API externe lorsque vous avez enregistré votre application. Les valeurs requises dépendent du type de subvention :

Types d'octroi
Type d'octroi	Valeurs requises
Code d'autorisation	ID de client Secret client
Données d'identification du client	ID de client Secret client
Mot de passe	ID de client Secret client Nom d'utilisateur Mot de passe
`x-<any custom name>`	Une liste des champs secrets mentionnés dans le fichier spec de openAPI

Si vous utilisez le type de subvention Code d'autorisation, procédez comme suit :
1. Copiez la redirection URL à partir de la page des paramètres de l'extension AI assistant builder et collez-la dans le champ approprié de la page d'enregistrement de l'application pour l'API externe. (La redirection URL est parfois appelée le rappel URL )
2. Cliquez sur Accorder l'accès. Vous êtes redirigé vers la page d'autorisation du site web du service externe. Vérifiez que l'accès est correct et cliquez pour approuver. Vous êtes ensuite redirigé vers la page de configuration de l'extension en utilisant la redirection URL.
Dans le champ Authentification du client, indiquez si les informations d'authentification sont envoyées dans un en-tête HTTP ou dans le corps de la requête. (Les informations d'identification envoyées dans le corps de la demande utilisent le type de contenu " x-www-form-urlencoded ) Sélectionnez l'option attendue par le service externe.
Dans le champ Préfixe de l'en-tête, indiquez le préfixe qui précède le jeton d'accès dans l'en-tête " Authorization. (Le préfixe par défaut est " Bearer, ce qui est typique pour la plupart des applications)
Si vous utilisez le type de subvention personnalisé " x-<any custom name> (par exemple, x-apikey), procédez comme suit :
1. Ajouter les valeurs secrètes associées aux champs secrets.
2. Ajouter les valeurs des paramètres facultatifs, le cas échéant.

Si le service externe prend en charge le type de subvention "Rafraîchir le jeton", l'assistant AI obtient automatiquement un nouveau jeton d'accès lorsque l'ancien expire. Si le document OpenAPI définit l'attribut refreshUrl , l'attribut URL spécifié est utilisé; sinon, l'attribut tokenUrl URL est utilisé.

Configuration de l'extension pour l'environnement de production

Pour configurer l'extension pour l'environnement de production, procédez comme suit :

Sur la page " " Integrations, faites défiler jusqu'à la section Extensions et trouvez la tuile correspondant à l'extension personnalisée que vous souhaitez ajouter.
Cliquez sur Ouvrir. La fenêtre Ouvrir l'extension personnalisée s'ouvre.
Dans la zone Environnement, sélectionnez Live. Cliquez sur Confirmer.
Répétez le processus de configuration en spécifiant les valeurs que vous souhaitez utiliser pour l'environnement réel.

Si vous utilisez plusieurs environnements, suivez les mêmes étapes pour configurer l'extension pour chaque environnement. Pour plus d'informations, voir Ajout et utilisation de plusieurs environnements.

L'extension est maintenant disponible dans les environnements que vous avez configurés et peut être appelée à partir de l'assistant. Pour plus d'informations sur l'appel d'une extension à partir d'une action, voir Appel d'une extension personnalisée.