L'opération DeleteDocuments permet de supprimer les documents spécifiés et tous leurs fragments. La réponse data.documentDetails contient les résultats pour chaque élément. Un statut HTTP 200 avec le code SUCCESS ne garantit pas la suppression réussie de tous les documents : vérifiez le statut de chaque élément (succeed ou failed) et consultez failureReason en cas d'échec.
Prérequis
Vous avez créé une instance AgentStorage dont l'état est
normal, et vous disposez du nom de l'instance ainsi que de son endpoint.Vous avez créé une clé API.
Les documents à supprimer existent déjà. La suppression est irréversible.
Paramètres de requête
|
Paramètre |
Type |
Description |
|
|
string |
Nom de la base de connaissances (obligatoire) |
|
|
string |
Nom du sous-espace. Obligatoire si le sous-espace est activé |
|
|
list<object> |
Liste des documents à supprimer (obligatoire). Limite par défaut de 10 éléments par requête |
|
|
string |
ID du document. Incompatible avec ossKey |
|
|
string |
Chemin OSS. Incompatible avec docId |
Exemple de requête
Pour l'authentification par clé API, indiquez le nom de l'instance et la clé API dans les en-têtes de requête x-ots-instancename et x-ots-apikey.
curl -X POST https://<endpoint>/DeleteDocuments \
-H "x-ots-instancename: <instance-name>" \
-H "x-ots-apikey: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"knowledgeBaseName": "product_docs_kb",
"subspace": "default",
"documents": [
{"ossKey": "oss://example-bucket/docs/manual.pdf"}
]
}'Réponse
{"code":"SUCCESS","data":{"documentDetails":[{"ossKey":"oss://example-bucket/docs/manual.pdf","status":"succeed"}]},"message":"succeed"}