ナレッジベース内のファイルチャンクのリストを照会します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-beijing |
| KnowledgeBaseId |
string |
必須 |
ナレッジベースの一意の ID。 |
pkb-xxxxx |
| FileId |
string |
必須 |
ファイル ID。 |
xxxx-xxxx-xxxx-xxxx |
| PageNumber |
integer |
任意 |
ページ番号。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのレコード数。 |
30 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンススキーマ。 |
||
| PageNumber |
integer |
現在のページ番号。 |
1 |
| PageRecordCount |
integer |
現在のページのレコード数。 |
10 |
| PageSize |
integer |
ページングクエリにおける 1 ページあたりのエントリ数。 |
30 |
| RequestId |
string |
リクエスト ID。 |
3E5CD764-xxxx-xxxx-xxxx-20E0DE84B2AF |
| Shards |
array<object> |
シャード情報。 |
|
|
array<object> |
|||
| Captions |
array |
シャードに関連付けられた図または表の字幕のリスト。 |
|
|
string |
図または表の字幕。 |
システムアーキテクチャ図 |
|
| DocItems |
array |
シャードに関連付けられた Docling ソースドキュメントの構造化要素リファレンスのリスト。これらのリファレンスを使用して、元のドキュメント要素を正確に特定できます。 |
|
|
string |
Docling ソースドキュメントの構造化要素リファレンス。 |
#/texts/2 |
|
| Headings |
array |
シャードが属するセクション見出しのチェーン。 |
|
|
string |
見出し。 |
概要 |
|
| ImageResources |
array<object> |
シャードがリファレンスするイメージリソースのリスト。 |
|
|
object |
イメージリソース。 |
||
| DocumentIndex |
integer |
イメージが属するソースドキュメントのインデックス。0 から始まります。 |
0 |
| Id |
string |
イメージリソースの一意の ID。 |
ドキュメント-0/pictures/1 |
| ItemRef |
string |
Docling ソースドキュメント構造内のイメージの要素リファレンス。 |
#/pictures/1 |
| MimeType |
string |
イメージリソースのメディアタイプ。 |
イメージ/png |
| Uri |
string |
イメージリソースの OSS URI。 |
oss://my-bucket/results/my-space/doc-001/artifacts/イメージ-1.png |
| PageNumbers |
array |
シャードが属するページ番号のリスト。 |
|
|
string |
ページ番号。 |
1 |
|
| ShardContent |
string |
シャードのテキストコンテンツ。 |
****** |
| ShardIndex |
integer |
シャードのインデックス。 |
1 |
| TotalRecordCount |
integer |
レコードの総数。 |
10 |
例
成功レスポンス
JSONJSON
{
"PageNumber": 1,
"PageRecordCount": 10,
"PageSize": 30,
"RequestId": "3E5CD764-xxxx-xxxx-xxxx-20E0DE84B2AF",
"Shards": [
{
"Captions": [
"系统架构图"
],
"DocItems": [
"#/texts/2"
],
"Headings": [
"Overview"
],
"ImageResources": [
{
"DocumentIndex": 0,
"Id": "document-0/pictures/1",
"ItemRef": "#/pictures/1",
"MimeType": "image/png",
"Uri": "oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png"
}
],
"PageNumbers": [
"1"
],
"ShardContent": "******",
"ShardIndex": 1
}
],
"TotalRecordCount": 10
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。