Normes API et SDK multilingues prédéfinis
L'OpenAPI de ce produit (bailian/2023-12-29) utilise le style de signature ROA. Des SDK sont disponibles pour les langages de programmation courants. Les développeurs peuvent télécharger le SDK pour appeler directement l'OpenAPI de ce produit, sans se soucier des détails techniques. Si le SDK existant ne répond pas à vos besoins, utilisez le mécanisme de signature pour une intégration par auto-signature. L'auto-signature étant particulièrement complexe, comptez environ 5 jours ouvrables. Nous vous recommandons donc de rejoindre notre groupe d'assistance DingTalk (147535001692) pour bénéficier d'un accompagnement expert lors de l'intégration.
Avant d'utiliser l'API, préparez votre compte d'identité et votre clé d'accès (AccessKey) afin d'accéder efficacement à l'API via des outils clients (tels que SDK et CLI). Pour plus d'informations, consultez Obtenir un AccessKey.
Scénarios de signature personnalisée
Si votre scénario métier présente des exigences particulières et nécessite une intégration par auto-signature, consultez d'abord notre équipe de support technique (groupe d'assistance DingTalk : 147535001692) pour obtenir un accompagnement professionnel et garantir une intégration efficace.
Préparation du compte et de la sécurité
Les comptes Alibaba Cloud disposent de permissions administratives complètes sur l'ensemble des ressources. En cas de compromission d'un AccessKey, toutes les ressources associées sont exposées à un risque d'accès non autorisé. Pour garantir la sécurité, créez un utilisateur RAM disposant uniquement de permissions d'accès API et configurez son AccessKey. Appliquez ensuite des politiques RAM selon le principe du moindre privilège (PoLP). N'utilisez le compte Alibaba Cloud que dans les scénarios spécifiques où ses permissions sont explicitement requises.
Catalogue des API
API | Titre | Description |
|---|---|---|
| AddCategory | Ajout d'une catégorie. | Crée une catégorie dans un espace de travail spécifié pour classer et gérer les fichiers. Chaque espace de travail prend en charge un maximum de 500 catégories. |
| AddChunk | Add a chunk | Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base. |
| AddConnector | AddConnector. | Crée un connecteur. Cette API prend actuellement en charge uniquement les connecteurs de fichiers. |
| AddFile | Ajouter un fichier. | Importe un fichier depuis le stockage temporaire d'Alibaba Cloud Model Studio vers une connexion de données Alibaba Cloud Model Studio (anciennement appelée données d'application). |
| AddFilesFromAuthorizedOss | Importation de fichiers depuis un compartiment OSS autorisé. | Importe des fichiers depuis un compartiment OSS autorisé vers les données d'application d'Alibaba Cloud Model Studio. |
| AddTable | AddTable | Add a table for the table data connector. |
| ApplyFileUploadLease | Demander un bail de téléversement de fichier. | Demande un bail de téléversement pour charger des fichiers de base de connaissances ou des fichiers destinés aux interactions conversationnelles des applications d'agent. |
| ApplyTempStorageLease | ApplyTempStorageLease | This interface is intended for pro-code deployment only; other scenarios are currently not supported. It is used to apply for a temporary file upload lease. After obtaining the lease, you must upload the file manually. |
| BatchUpdateFileTag | BatchUpdateFileTag | This operation updates document tags in a data connection in batches. |
| ChangeParseSetting | Modify category parsing settings | Configures the parsing method for specific file types. For example, specifies large model document parsing for .pdf files or Qwen VL parsing for .jpg files. |
| CreateIndex | Create a knowledge base | Creates a knowledge base, either an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A. |
| CreateMemory | Créer une mémoire à long terme. | Crée une mémoire à long terme. |
| CreateMemoryNode | Créer un nœud de mémoire. | Crée un nœud de mémoire. |
| CreatePromptTemplate | Créer un modèle d'invite. | Crée un modèle d'invite. |
| DeleteCategory | Supprimer une catégorie. | Supprime définitivement une catégorie spécifiée. |
| DeleteChunk | Suppression de fragments. | Supprime les fragments de texte spécifiés d'une base de connaissances. Les fragments de texte supprimés ne peuvent être ni récupérés ni rappelés. |
| DeleteConnector | Delete a connector | Deletes a connector. |
| DeleteFile | Supprimer un fichier. | Supprime définitivement un fichier spécifié des données d'application. La suppression de tables de données via l'API n'est pas prise en charge. Pour plus de détails, consultez le guide de l'API ci-dessous. |
| DeleteFiles | Delete files in batch | Delete files in batch |
| DeleteIndex | Suppression d'une base de connaissances. | Supprime définitivement une base de connaissances spécifiée. |
| DeleteIndexDocument | Suppression de fichiers d'une base de connaissances. | Supprime définitivement des fichiers d'une base de connaissances spécifiée. |
| DeleteMemory | Suppression de la mémoire à long terme. | Supprime définitivement une mémoire à long terme spécifiée. |
| DeleteMemoryNode | Suppression d'un fragment de mémoire. | Supprime un fragment de mémoire. |
| DeletePromptTemplate | Supprimer un modèle d'invite. | Supprime un modèle d'invite en fonction de l'identifiant du modèle. |
| DescribeFile | Consultation de l'état du fichier. | Consulte les informations de base d'un fichier dans les données d'application, notamment son nom, son type et son état. |
| GetAvailableParserTypes | GetAvailableParserTypes. | Répertorie tous les types d'analyseurs pris en charge en fonction du type de fichier d'entrée (extension de fichier). |
| GetConnector | GetConnector | Retrieves details about a connector. This operation currently supports only file connectors. |
| GetIndexJobStatus | Consultation de l'état de la tâche de base de connaissances. | Consulte l'état actuel d'une tâche de création de base de connaissances ou d'une tâche d'ajout de documents à une base de connaissances spécifiée. |
| GetMemory | Récupération de la mémoire à long terme. | Obtient la description d'une mémoire à long terme spécifiée. |
| GetMemoryNode | Obtenir un fragment de mémoire. | Obtient un fragment de mémoire. |
| GetParseSettings | GetParseSettings. | Consulte les paramètres d'analyse des données d'une catégorie spécifiée. |
| GetPromptTemplate | GetPromptTemplate. | Obtient un modèle d'invite en fonction de l'identifiant du modèle. |
| ListCategory | Liste des catégories. | Obtient les détails d'une ou plusieurs catégories dans un espace de travail spécifié. |
| ListChunks | Consultation de la liste des fragments sous un index. | Consulte la liste et les informations des fragments de texte. |
| ListFile | Liste des fichiers. | Obtient les détails d'un ou plusieurs documents dans une catégorie spécifiée. |
| ListIndexDocuments | Interrogation des fichiers dans une base de connaissances. | Obtient les fichiers et leurs informations de synthèse à partir d'une base de connaissances spécifiée. |
| ListIndexFileDetails | Consultation des détails des fichiers dans une base de connaissances. | Obtient les fichiers et leurs détails à partir d'une base de connaissances spécifiée. |
| ListIndices | Liste des bases de connaissances. | Obtient la liste des bases de connaissances dans un espace de travail spécifié. |
| ListMemories | Liste des mémoires à long terme. | Obtient les détails d'une ou plusieurs entités de mémoire à long terme dans un espace de travail spécifié. |
| ListMemoryNodes | Liste des nœuds de mémoire. | Obtient la liste des nœuds de mémoire. |
| ListPromptTemplates | ListPromptTemplates. | Obtient la liste des modèles d'invite. |
| Retrieve | Retrieve | Retrieves information from a specified knowledge base. |
| SubmitIndexAddDocumentsJob | Submit a knowledge base append job | Adds parsed files to the specified knowledge base. |
| SubmitIndexJob | Soumettre une tâche de création de base de connaissances. | Soumet une tâche CreateIndex spécifiée pour finaliser la création de la base de connaissances. |
| UpdateChunk | Mise à jour d'un fragment. | Modifie le contenu et le titre d'un fragment de texte spécifié dans une base de connaissances, et indique si le fragment participe à la récupération de la base de connaissances. |
| UpdateConnector | UpdateConnector. | Met à jour un connecteur. |
| UpdateFileTag | Mise à jour de la balise de fichier. | Met à jour les balises d'un fichier spécifié. |
| UpdateMemory | Mise à jour de la mémoire à long terme. | Met à jour la description d'une mémoire à long terme spécifiée. |
| UpdateMemoryNode | Mise à jour d'un fragment de mémoire. | Met à jour un fragment de mémoire. |
| UpdatePromptTemplate | UpdatePromptTemplate. | Met à jour un modèle de prompt en fonction de l'identifiant du modèle. |
| UpdateTableFromAuthorizedOss | UpdateTableFromAuthorizedOss | Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket. |