UpdateDocument API を使用して、指定したドキュメントのメタデータを更新します。更新するドキュメントは完了状態である必要があります。メタデータは上書きによって更新されます。渡した値は既存のメタデータを完全に置き換えます。1 つのフィールドのみを更新する場合でも、すべてのフィールドを含める必要があります。"metadata": null を渡すと、すべてのメタデータがクリアされます。
前提条件
AgentStorage インスタンスが作成され、
normal状態です。インスタンスのエンドポイントと名前を取得済みです。API キーが作成されていること。
更新対象のドキュメントが完了状態になっていること。
リクエストパラメーター
パラメーター | タイプ | 説明 |
| 文字列 | ナレッジベースの名前。このパラメーターは必須です。 |
| 文字列 | サブスペースの名前。サブスペースが有効な場合、このパラメーターは必須です。 |
| 文字列 | ドキュメントの OSS パス。このパラメーターまたは |
| 文字列 | ドキュメント ID。このパラメーターまたは |
| マップ | 新しいメタデータ。このパラメーターは任意です。このパラメーターを省略した場合、元の値が保持され、 |
リクエスト例
API キー認証を使用する場合、インスタンス名と API キーを x-ots-instancename および 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": "田中 太郎", "date": "2026-02-01 12:00:00", "score": 80}
}'レスポンス
フィールド | タイプ | 説明 |
| 文字列 | ドキュメント ID。 |
| 文字列 | OSS パス。 |
| long | 更新タイムスタンプ。 |
| 文字列 |
|