ListDocuments List documents - Tablestore - Centre de documentation Alibaba Cloud

Utilisez l'opération ListDocuments pour interroger la liste des documents d'une base de connaissances avec une pagination.

Prérequis

Vous avez créé une instance AgentStorage. Son statut est normal et vous disposez du endpoint ainsi que du nom de l'instance.
Vous avez créé une clé API.
La base de connaissances à interroger existe déjà.

Paramètres de la requête

Paramètre

Type

Description

knowledgeBaseName

string

Nom de la base de connaissances. Obligatoire.

subspace

list<string>

Liste des sous-espaces (jusqu'à 10). Obligatoire lorsque la fonctionnalité de sous-espace est activée.

maxResults

int

Nombre de résultats à renvoyer. Valeur par défaut : 10. Maximum : 1000.

nextToken

string

Jeton de pagination.

Exemple de requête

Pour l'authentification par clé API, transmettez le nom de l'instance et la clé API via les en-têtes de requête x-ots-instancename et x-ots-apikey.

curl -X POST https://<endpoint>/ListDocuments \
  -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"],
  "maxResults": 10
}'

Réponse

{
    "code": "SUCCESS",
    "data": {
        "documentDetails": [
            {
                "docId": "fc6ed97f-28ad-4dc0-9b73-bf4a7d67ab65",
                "ossKey": "oss://example-bucket/docs/manual.pdf",
                "subspace": "default",
                "chunkNum": 1,
                "status": "completed",
                "createdAt": 1787636583092,
                "eTag": "6227CEC56ABFAF47135E4C033FF24C98",
                "updatedAt": 1787636583092, "metadata": {"author": "John Doe", "date": "2026-01-22 10:00:59", "score": 80}
            }
        ],
        "nextToken": ""
    },
    "message": "succeed"
}