GetDocument Interroger des documents - Tablestore - Centre de documentation Alibaba Cloud

Utilisez l'opération GetDocument pour obtenir les informations détaillées d'un document spécifié. Le champ data de la réponse contient un tableau d'enregistrements de documents ; le tableau ci-dessous décrit la structure d'un enregistrement unique. Si vous effectuez une recherche par ossKey, la suppression puis la recréation du même fichier peuvent renvoyer plusieurs résultats, incluant des historiques. Pour vérifier l'état de l'importation en cours, utilisez le docId renvoyé par AddDocuments afin d'identifier l'enregistrement correspondant.

Prérequis

Vous avez créé une instance AgentStorage dont le statut est normal, et vous avez récupéré son endpoint ainsi que son nom.
Vous avez créé une API Key.
La base de connaissances et le document à interroger existent déjà.

Paramètres de requête

Paramètre

Type

Description

knowledgeBaseName

string

Nom de la base de connaissances. Obligatoire.

subspace

string

Nom du subspace. Obligatoire si le subspace est activé.

docId

string

ID du document. À utiliser exclusivement ou conjointement avec ossKey.

ossKey

string

Chemin du fichier OSS. À utiliser exclusivement ou conjointement avec docId.

Exemple de requête

Pour l'authentification par API Key, 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>/GetDocument \
  -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"
}'

Réponse

Champ

Type

Description

docId

string

ID du document.

ossKey

string

Chemin OSS.

subspace

string

Subspace.

chunkNum

int

Nombre de chunks.

status

string

État du document : pending/indexing/completed/failed/deleting

createdAt

int

Horodatage de création.

updatedAt

int

Horodatage de mise à jour.

eTag

string

eTag du document.

failedDetails

string

Raison de l'échec (uniquement si l'état est failed).

metadata

object

Métadonnées du document.

{
    "code": "SUCCESS",
    "data": [
        {
            "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}
        }
    ],
    "message": "succeed"
}