Supprime définitivement des fichiers d'une base de connaissances spécifiée.
Description de l'opération
- Cette opération ne prend pas en charge la suppression de données des bases de connaissances de requête de données ou de questions-réponses sur images. Utilisez plutôt la console Model Studio.
- Les utilisateurs Resource Access Management (RAM) doivent d'abord obtenir les autorisations d'API pour Model Studio (nécessitant
AliyunBailianDataFullAccess, qui inclut l'autorisation sfm:DeleteIndexDocument), avant d'appeler cette opération. Les comptes Alibaba Cloud peuvent appeler cette opération directement sans autorisation. Utilisez la dernière version du SDK Model Studio pour appeler cette opération. - Avant d'appeler cette opération, assurez-vous que votre base de connaissances a été créée et n'a pas été supprimée (c'est-à-dire que l'identifiant de la base de connaissances
IndexIdest valide). - Vous ne pouvez supprimer que les fichiers dont l'état est échec de l'importation (INSERT_ERROR) ou importation réussie (FINISH) dans la base de connaissances. Pour interroger l'état des fichiers dans une base de connaissances spécifiée, appelez l'opération ListIndexDocuments.
- La suppression est irréversible. Le contenu des fichiers supprimés ne peut pas être récupéré, et l'opération Retrieve ne peut plus récupérer les informations associées. Procédez avec prudence.
- L'appel de cette opération ne supprime pas les documents qui ont été importés dans les Données d'application.
- Cette opération est idempotente.
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Autorisation RAM
Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :
-
Action : les actions peuvent être utilisées dans l'élément
Actiondes instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération. - API : l'API que vous pouvez appeler pour exécuter l'action.
- Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
-
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément
Resourcede la politique. - Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément
Resourcede la politique.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément
- Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
- Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.
Action | Niveau d'accès | Type de ressource | Clé de condition | Action dépendante |
|---|---|---|---|---|
sfm:DeleteIndexDocument | delete | *All Resource
| Aucune | Aucune |
Syntaxe de la requête
Paramètres de chemin
Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
| WorkspaceId | string | Oui | L'identifiant de l'espace de travail auquel la base de connaissances appartient. Pour plus d'informations sur la façon d'obtenir l'identifiant de l'espace de travail, consultez Comment utiliser un espace de travail. | llm-3z7uw7fwz0vxxxx |
Paramètres de requête
Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
| IndexId | string | Oui | L'identifiant de la base de connaissances, qui correspond au | 79c0alxxxx |
| DocumentIds | array | Oui | La liste des identifiants de fichiers. | |
string | Non | L'identifiant du fichier, qui correspond au | file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx |
Éléments de réponse
| Élément | Type | Description | Exemple |
|---|---|---|---|
| object | Schéma de la réponse. | ||
| RequestId | string | L'identifiant de la requête. | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Code | string | Le code d'erreur. | Index.InvalidParameter |
| Message | string | Le message d'erreur. | Paramètre requis (%s) manquant ou non valide, veuillez vérifier les paramètres de la requête |
| Success | boolean | Indique si l'opération a réussi. Valeurs valides :
| true |
| Data | object | Le champ de données métier renvoyé par l'opération. | |
| DeletedDocument | array | La liste des identifiants des fichiers supprimés avec succès. | |
| string | L'identifiant du fichier. | file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx | |
| Status | string | Le code d'état renvoyé par l'opération. | 200 |
Exemples
正常返回示例
JSON format