La base de connaissances Alibaba Cloud Model Studio fournit des API ouvertes pour l’intégration à vos systèmes métier existants, l’automatisation des opérations et les besoins de recherche complexes.
Prérequis
-
Pour gérer une base de connaissances par API, un utilisateur RAM doit obtenir les autorisations API (stratégie AliyunBailianDataFullAccess) et rejoindre un espace de travail. Ces opérations ne sont pas requises pour un compte Alibaba Cloud.
Un utilisateur RAM peut gérer les bases de connaissances uniquement dans les espaces de travail qu’il a rejoints. Un compte Alibaba Cloud peut les gérer dans tous les espaces de travail.
-
Installez la dernière version du SDK Alibaba Cloud Model Studio pour appeler les API de base de connaissances. Pour l’installation, consultez la référence de développement du SDK Alibaba Cloud.
Si le SDK ne répond pas à vos besoins, appelez les API par des requêtes HTTP utilisant le mécanisme de signature. Pour les détails de connexion, consultez Présentation des API.
-
Obtenez un AccessKey ID et un AccessKey Secret, ainsi qu’un ID d’espace de travail. Définissez-les comme variables d’environnement système pour exécuter les exemples. L’exemple suivant montre la configuration sous Linux :
Si vous utilisez un IDE ou des extensions de développement, définissez les variables
ALIBABA_CLOUD_ACCESS_KEY_ID,ALIBABA_CLOUD_ACCESS_KEY_SECRETetWORKSPACE_IDdans votre environnement de développement.
- Préparez le document d’exemple Alibaba Cloud Model Studio Phone Introduction.docx pour créer une base de connaissances.
Exemple de code
Exemple de code
- Créer une base de connaissances
- Rechercher dans une base de connaissances
- Mettre à jour une base de connaissances
- Gérer les bases de connaissances
Créer une base de connaissances
Créez une base de connaissances de recherche documentaire dans un espace de travail donné.
1. Initialiser le clientPour importer des fichiers et créer une base de connaissances, initialisez d’abord un client. Utilisez votre AccessKey et AccessKey Secret pour vous authentifier et configurezendpoint.
| Python |
2. Importer les fichiers de la base de connaissances | |
2.1. Demander une autorisation temporaire d’importation de fichierAvant de créer une base de connaissances, importez ses fichiers sources dans le même espace de travail. Appelez ApplyFileUploadLease pour demander une autorisation temporaire d’importation de fichier (lease), valable quelques minutes.
| Python
Exemple de requête
Exemple de réponse |
2.2. Importer le fichier dans le stockage temporaireAvec l’autorisation temporaire, utilisez les paramètres et l’URL d’importation pour transférer des fichiers depuis le stockage local ou une URL publique vers le serveur Model Studio. Chaque espace de travail accepte jusqu’à 10 000 fichiers. Formats pris en charge : PDF, DOCX, DOC, TXT, Markdown, PPTX, PPT, XLSX, XLS, HTML, PNG, JPG, JPEG, BMP et GIF.
|
Python |
2.3. Ajouter le fichier à une catégorieAprès l’importation, ajoutez le fichier à une catégorie du même espace de travail en appelant AddFile.
FileId du fichier et commence automatiquement son analyse. Le lease_id est immédiatement invalidé. Ne réutilisez pas le même identifiant d’autorisation pour un autre envoi. | Python
Exemple de requête
Exemple de réponse |
2.4. Consulter l’état d’analyse du fichierUn fichier doit être analysé avant de pouvoir être utilisé dans une base de connaissances. Aux heures de pointe, cette opération peut prendre plusieurs heures. Appelez DescribeFile pour consulter son état d’analyse.
Data.Status vaut PARSE_SUCCESS, l’analyse a réussi et vous pouvez importer le fichier dans la base de connaissances. | Python
Exemple de requête
Exemple de réponse |
3. Créer une base de connaissances | |
3.1. Initialiser la base de connaissancesUne fois le fichier analysé, vous pouvez créer une base de connaissances dans le même espace de travail. Commencez par appeler CreateIndex pour initialiser, sans la finaliser, une base de recherche documentaire.
Data.Id renvoyée est l’ID de la base de connaissances, utilisé ensuite pour construire l’index.Conservez l’ID de la base de connaissances en lieu sûr : il est requis pour toutes les opérations d’API ultérieures sur cette base. | Python
Exemple de requête
Exemple de réponse |
3.2. Soumettre une tâche d’indexationAprès l’initialisation, appelez SubmitIndexJob pour démarrer la construction de l’index.
Data.Id renvoyé par cet appel correspond à l’ID de la tâche. Utilisez-le à l’étape suivante pour consulter son état. | Python
Exemple de requête
Exemple de réponse |
3.3. Consulter l’état de la tâche d’indexationL’indexation prend du temps et peut durer plusieurs heures aux heures de pointe. Appelez GetIndexJobStatus pour consulter son état d’exécution.
Data.Status vaut COMPLETED, la base de connaissances est créée. | Python
Exemple de requête
Exemple de réponse |
Rechercher dans une base de connaissances
Deux méthodes permettent de rechercher des informations dans une base de connaissances :
- Avec une application Alibaba Cloud Model Studio : lors de l’appel d’une application, utilisez le paramètre
rag_optionspour transmettre l’ID de baseindex_idpour enrichir le modèle de connaissances privées et d’informations récentes. - Avec une API Alibaba Cloud : appelez l’API Retrieve pour rechercher dans une base donnée et renvoyer les segments de texte d’origine.
Pour rechercher des informations dans une base donnée et renvoyer les segments de texte, appelez l’API Retrieve.
| Python
Exemple de requête
Exemple de réponse |
Mettre à jour une base de connaissances
L’exemple suivant montre comment mettre à jour une base de recherche documentaire. Les applications qui utilisent cette base reflètent les mises à jour en temps réel. Le nouveau contenu devient disponible pour la recherche et le contenu supprimé n’est plus accessible.
L’API ne permet pas de mettre à jour les bases de requêtes de données ou de questions-réponses sur les images. Consultez Mettre à jour une base de connaissances.
- Mise à jour incrémentielle : seule une procédure en trois étapes est prise en charge : importer le fichier mis à jour, l’ajouter à la base, puis supprimer l’ancien fichier.
- Mise à jour complète : effectuez ces trois étapes pour chaque fichier de la base.
- Mise à jour ou synchronisation automatique : consultez Automatiser la mise à jour ou la synchronisation d’une base de connaissances.
- Nombre de fichiers par mise à jour : nous recommandons de ne pas dépasser 10 000 fichiers à la fois. Au-delà, la mise à jour peut ne pas fonctionner correctement.
1. Importer le fichier mis à jourSuivez Créer une base de connaissances : étape 2 pour importer le fichier mis à jour dans l’espace de travail contenant la base.Demandez une nouvelle autorisation temporaire d’importation pour obtenir de nouveaux paramètres pour le fichier mis à jour. | |
2. Ajouter le fichier à la base de connaissances | |
2.1. Soumettre une tâche d’ajoutUne fois le fichier importé analysé, appelez SubmitIndexAddDocumentsJob pour l’ajouter à la base et reconstruire son index.
Data.Id, l’ID de tâche (job_id). Utilisez-le à l’étape suivante pour consulter son état. | Python
Exemple de requête
Exemple de réponse |
2.2. Attendre la fin de la tâcheL’indexation prend du temps et peut durer plusieurs heures aux heures de pointe. Appelez GetIndexJobStatus pour consulter son état d’exécution.
COMPLETED du champ Data.Status indique que tous les fichiers mis à jour ont été ajoutés à la base.La liste | Python
Exemple de requête
Exemple de réponse |
3. Supprimer l’ancien fichierEnfin, appelez DeleteIndexDocument pour supprimer définitivement l’ancienne version du fichier de la base et éviter de récupérer des informations obsolètes par inadvertance.
Seuls les fichiers dont l’importation a échoué (INSERT_ERROR) ou réussi (FINISH) peuvent être supprimés. Appelez ListIndexDocuments pour consulter l’état des fichiers dans la base. | Python
Exemple de requête
Exemple de réponse |
Gérer les bases de connaissances
La création et l’utilisation de bases de connaissances ne sont pas prises en charge par l’API. Effectuez ces opérations dans la console Model Studio.
Consulter une base de connaissancesPour consulter les bases d’un espace de travail donné, appelez ListIndices.
| Python
Exemple de requête
Exemple de réponse |
Supprimer une base de connaissancesPour supprimer définitivement une base, appelez DeleteIndex. Au préalable, dissociez-la de toutes les applications Alibaba Cloud Model Studio liées dans la console. Sinon, la suppression échoue.
| Python
Exemple de requête
Exemple de réponse |
API
Consultez le Catalogue des API de base de connaissances pour obtenir la liste complète des API et de leurs paramètres de requête et de réponse.
FAQ
-
Comment automatiser les mises à jour et la synchronisation des bases de connaissances ?
- Recherche documentaire
- Requêtes de données et questions-réponses sur les images
Intégrez les API d’Object Storage Service (OSS), de Function Compute (FC) et des bases de connaissances Model Studio. Procédez comme suit :- Créer un bucket : dans la console OSS, créez un bucket pour stocker vos fichiers sources.
- Créer une base de connaissances : créez une base de recherche documentaire pour stocker vos connaissances privées.
- Créer une fonction personnalisée : dans la console FC, créez une fonction pour les événements de modification de fichiers, comme les ajouts ou suppressions. Consultez Créer une fonction. Ces fonctions synchronisent les modifications OSS avec votre base via les API décrites dans Mettre à jour une base de connaissances.
- Créer un déclencheur OSS : dans FC, associez un déclencheur OSS à la fonction créée à l’étape précédente. Lorsqu’une modification est détectée, par exemple l’importation d’un nouveau fichier dans OSS, le déclencheur s’active et FC exécute la fonction. Consultez Déclencheurs.
- Pourquoi ma nouvelle base de connaissances est-elle vide ? Cela se produit généralement si l’étape Soumettre une tâche d’indexation n’a pas été exécutée. Si CreateIndex est appelé mais que SubmitIndexJob échoue, la base reste vide. Soumettez à nouveau une tâche d’indexation, puis attendez sa fin.
- Que faire si je reçois l’erreur « Access your uploaded file failed. Please check if your upload action was successful » ? Cette erreur indique généralement que l’étape Importer le fichier dans le stockage temporaire a échoué. Vérifiez sa réussite avant d’appeler AddFile.
-
Que faire si je reçois l’erreur « Access denied: Either you are not authorized to access this workspace, or the workspace does not exist » ?
Cette erreur survient généralement pour les raisons suivantes :
-
Le point de terminaison demandé (point de terminaison) est incorrect : pour un accès par Internet, les utilisateurs du site chinois (cloud public) doivent utiliser le point de terminaison Chine (Pékin), et ceux du site international celui de Singapour. Avec le débogage en ligne, sélectionnez le bon point de terminaison, comme illustré ci-dessous.

-
La valeur de
WorkspaceIdest incorrecte, ou vous n’êtes pas membre de l’espace de travail : avant l’appel, vérifiez leWorkspaceIdet votre appartenance à l’espace. Consultez Rejoindre un espace de travail donné.
-
Le point de terminaison demandé (point de terminaison) est incorrect : pour un accès par Internet, les utilisateurs du site chinois (cloud public) doivent utiliser le point de terminaison Chine (Pékin), et ceux du site international celui de Singapour. Avec le débogage en ligne, sélectionnez le bon point de terminaison, comme illustré ci-dessous.
-
Que faire si je reçois l’erreur « Specified access key is not found or invalid » ?
Cette erreur indique généralement que
access_key_idouaccess_key_secretest incorrect, ou que l’access_key_ida été désactivé. Avant l’appel, vérifiez que l’access_key_idest correct et actif. -
Que faire si je reçois l’erreur « Category is mismatched » ?
Cette erreur survient généralement lorsque le
CategoryIdde l’appelApplyFileUploadLeasediffère duCategoryIdde l’appelAddFilesuivant. Utilisez le mêmeCategoryIdpendant toute l’importation, d’ApplyFileUploadLeaseàAddFile. AppelezListCategorypour obtenir les catégories de l’espace de travail actuel et vérifier leCategoryIdutilisé.
Facturation
- Toutes les fonctionnalités des bases de connaissances et leurs appels d’API sont gratuits. Consultez Base de connaissances : facturation.
- L’espace de stockage des données importées dans Model Studio, telles que les fichiers, est gratuit.
