Use a operação UpdateDocument para atualizar os metadados de um documento específico. O documento a ser atualizado deve estar no estado concluído. A atualização dos metadados ocorre por sobrescrita: o valor informado substitui completamente os metadados existentes. Para atualizar apenas um campo, inclua todos os campos. Informar "metadata": null limpa todos os metadados.
Pré-requisitos
Uma AgentStorage instance foi criada e está no estado
normal. Tenha em mãos o endpoint e o nome da instância.Uma chave de API foi criada.
O documento a ser atualizado está no estado concluído.
Parâmetros da requisição
|
Parâmetro |
Tipo |
Descrição |
|
|
string |
O nome da base de conhecimento. Esse parâmetro é obrigatório. |
|
|
string |
O nome do subespaço. Esse parâmetro é obrigatório quando o subespaço está habilitado. |
|
|
string |
O caminho do documento no OSS. Especifique este parâmetro ou |
|
|
string |
O ID do documento. Especifique este parâmetro ou |
|
|
map |
Os novos metadados. Esse parâmetro é opcional. Se for omitido, o sistema mantém o valor original e retorna NO_OP. Passar null explicitamente limpa todos os metadados. Passar um objeto substitui totalmente os metadados existentes. |
Exemplo de requisição
Ao usar a autenticação por chave de API, informe o nome da instância e a chave de API nos cabeçalhos de requisição x-ots-instancename e x-ots-apikey.
curl -X POST https://<endpoint>/UpdateDocument \
-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",
"metadata": {"author": "Li Si", "date": "2026-02-01 12:00:00", "score": 80}
}'Resposta
|
Campo |
Tipo |
Descrição |
|
|
string |
O ID do documento. |
|
|
string |
O caminho do OSS. |
|
|
long |
O timestamp de atualização. |
|
|
string |
|