ドキュメントチャンクの表示と更新 (ListChunks, UpdateChunks) - Tablestore

ドキュメントをアップロードすると、システムは自動的にドキュメントをチャンクに分割します。各チャンクにはベクトルデータと元のテキストが格納され、取得の最小単位として機能します。以下の API を使用して、チャンクの内容を表示および調整します。

チャンクの表示

list_chunks を呼び出して、指定したドキュメントのチャンクのページ分割されたリストを取得します。

リクエストパラメーター

パラメーター	タイプ	説明
`knowledgeBaseName`	文字列	ナレッジベースの名前です。必須です。
`subspace`	文字列	サブスペースの名前です。サブスペースが有効な場合は必須です。
`docId`	文字列	ドキュメント ID です。`ossKey` が指定されていない場合に必須です。
`ossKey`	文字列	ドキュメントの OSS パスです。`docId` が指定されていない場合に必須です。
`maxResults`	int	返される結果の最大件数です。デフォルト値は 10、最大値は 1,000 です。
`nextToken`	文字列	ページネーション用のトークンです。

コード例

resp = client.list_chunks({
    "knowledgeBaseName": "product_docs_kb",
    "docId": "fc6ed97f-...",
    "maxResults": 5
})

for chunk in resp["data"]["chunkDetails"]:
    print(f"[Chunk {chunk['chunkId']}] ({chunk['status']}) {chunk['content'][:80]}...")

レスポンスフィールド

パラメーター	タイプ	説明
`chunkDetails[].subspace`	文字列	チャンクが属するサブスペースです。
`chunkDetails[].chunkId`	int	チャンクの ID です。
`chunkDetails[].content`	文字列	チャンクの内容です。
`chunkDetails[].title`	文字列	チャンクのタイトルです。
`chunkDetails[].chunkType`	文字列	チャンクのタイプです。例：`TEXT`
`chunkDetails[].status`	文字列	ステータスは、`active` (取得可能) または `inactive` (取得不可) です。
`chunkDetails[].docId`	文字列	チャンクが属するドキュメントの ID です。
`chunkDetails[].ossKey`	文字列	チャンクが属するドキュメントの OSS パスです。
`chunkDetails[].createdAt`	int	作成タイムスタンプです。
`chunkDetails[].updatedAt`	int	更新タイムスタンプです。
`nextToken`	文字列	ページネーション用のトークンです。このフィールドが空の場合、結果が最終ページであることを示します。

チャンクの更新

update_chunks を呼び出して、複数のチャンクのタイトル、内容、またはステータスをバッチで更新します。

リクエストパラメーター

パラメーター	タイプ	説明
`knowledgeBaseName`	文字列	ナレッジベースの名前です。必須です。
`subspace`	文字列	サブスペースの名前です。サブスペースが有効な場合は必須です。
`chunks`	list<object>	更新するチャンクのリストです。必須です。1 リクエストあたり最大 10 個のチャンクを更新できます。説明この上限の引き上げを申請するには、チケットを送信するか、Tablestore テクニカルサポート DingTalk グループ (ID: 36165029092) に参加してください。
`chunks[].docId`	文字列	ドキュメント ID です。`ossKey` が指定されていない場合に必須です。
`chunks[].ossKey`	文字列	ドキュメントの OSS パスです。`docId` が指定されていない場合に必須です。
`chunks[].chunkId`	int	チャンクの ID です。必須です。
`chunks[].title`	文字列	チャンクの新しいタイトルです。
`chunks[].content`	文字列	チャンクの新しい内容です。
`chunks[].status`	文字列	チャンクの新しいステータスです。`active` (取得可能) または `inactive` (取得不可) のいずれかを指定します。

コード例

チャンクの内容を更新します：

resp = client.update_chunks({
    "knowledgeBaseName": "product_docs_kb",
    "chunks": [
        {
            "docId": "fc6ed97f-...",
            "chunkId": 1,
            "title": "Updated title",
            "content": "Updated content"
        }
    ]
})

不正確なチャンクをブロックするには、ステータスを inactive に設定します：

resp = client.update_chunks({
    "knowledgeBaseName": "product_docs_kb",
    "chunks": [
        {
            "docId": "fc6ed97f-...",
            "chunkId": 0,
            "status": "inactive"
        }
    ]
})

レスポンスフィールド

パラメーター	タイプ	説明
`updateDetails[].docId`	文字列	ドキュメントの ID です。
`updateDetails[].ossKey`	文字列	ドキュメントの OSS パスです。
`updateDetails[].chunkId`	int	チャンクの ID です。
`updateDetails[].updateStatus`	文字列	更新処理のステータスです。有効な値は `succeed` または `failed` です。
`updateDetails[].failureReason`	文字列	失敗した理由です。このパラメーターは、ステータスが `failed` の場合にのみ返されます。

使用上の注意

チャンクの status を inactive に設定すると、そのチャンクは取得結果に表示されなくなります。この機能を使用すると、ドキュメント全体を削除せずに、不正確な内容を一時的に取得対象から除外できます。