ListChunks - Tablestore - Centre de documentation Alibaba Cloud

Prérequis

Vous avez créé une instance AgentStorage dont l'état est normal, et vous avez récupéré son endpoint et son nom.
Vous avez créé une clé API.
La base de connaissances et le document à interroger existent déjà.

Paramètres de la requête

Paramètre

Type

Description

knowledgeBaseName

string

Nom de la base de connaissances. Obligatoire.

subspace

string

Nom du subspace. Obligatoire si la fonctionnalité subspace est activée.

docId

string

ID du document. Spécifiez ce paramètre ou ossKey.

ossKey

string

Chemin OSS. Spécifiez ce paramètre ou docId.

maxResults

int

Nombre d'entrées à renvoyer. Valeur par défaut : 10. Valeur maximale : 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 dans les en-têtes de requête x-ots-instancename et x-ots-apikey.

curl -X POST https://<endpoint>/ListChunks \
  -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",
  "ossKey": "oss://example-bucket/docs/manual.pdf",
  "maxResults": 10
}'

Réponse

Champ

Type

Description

chunkDetails[].subspace

string

Subspace auquel appartient le chunk.

chunkDetails[].chunkId

int

ID du chunk.

chunkDetails[].content

string

Contenu du chunk.

chunkDetails[].title

string

Titre du chunk.

chunkDetails[].chunkType

string

Type de chunk, par exemple TEXT.

chunkDetails[].status

string

active (interrogeable) ou inactive (non interrogeable).

chunkDetails[].docId

string

ID du document auquel appartient le chunk.

chunkDetails[].ossKey

string

Chemin OSS du document auquel appartient le chunk.

chunkDetails[].createdAt

int

Horodatage de création.

chunkDetails[].updatedAt

int

Horodatage de mise à jour.

nextToken

string

Jeton de pagination. Une valeur vide indique la dernière page.

{
    "code": "SUCCESS",
    "data": {
        "chunkDetails": [
            {
                "subspace": "default",
                "docId": "fc6ed97f-28ad-4dc0-9b73-bf4a7d67ab65",
                "ossKey": "oss://example-bucket/docs/manual.pdf",
                "chunkId": 0,
                "content": "Product installation steps: 1. Download and extract the installation package. 2. Follow the installation wizard to complete the installation. 3. Start the product and confirm that the installation success page is displayed.",
                "title": "Product installation steps",
                "chunkType": "TEXT",
                "status": "active",
                "createdAt": 1787636596495
            }
        ],
        "nextToken": ""
    },
    "message": "succeed"
}