GetDocument Query documents - Tablestore: Central de Documentação do Alibaba Cloud

Pré-requisitos

Uma instância do AgentStorage foi criada e está no estado normal, e você possui o endpoint e o nome da instância.
Uma chave de API foi criada.
A base de conhecimento e o documento que você deseja consultar existem.

Parâmetros da solicitação

Parâmetro	Tipo	Descrição
`knowledgeBaseName`	string	O nome da base de conhecimento. Obrigatório.
`subspace`	string	O nome do subespaço. Obrigatório quando o subespaço está habilitado.
`docId`	string	O ID do documento. Especifique este parâmetro ou `ossKey`.
`ossKey`	string	O caminho do arquivo no OSS. Especifique este parâmetro ou `docId`.

Exemplo de solicitação

Ao usar a autenticação por chave de API, passe o nome da instância e a chave de API nos cabeçalhos de solicitação x-ots-instancename e 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"
}'

Resposta

Campo	Tipo	Descrição
`docId`	string	O ID do documento.
`ossKey`	string	O caminho do OSS.
`subspace`	string	O subespaço.
`chunkNum`	int	O número de chunks.
`status`	string	O status do documento: pending/indexing/completed/failed/deleting.
`createdAt`	int	O timestamp de criação.
`updatedAt`	int	O timestamp de atualização.
`eTag`	string	O eTag do documento.
`failedDetails`	string	O motivo da falha. Retornado apenas quando o status é failed.
`metadata`	object	Os metadados do documento.

{
    "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"
}