ナレッジベース内のファイルのリストを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
polardb:DescribeKnowledgeBaseFiles |
get |
*すべてのリソース。
|
なし | なし |
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-beijing |
| KnowledgeBaseId |
string |
必須 |
ナレッジベースの一意の識別子。 |
pkb-xxxxx |
| PageNumber |
integer |
任意 |
ページ番号。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのレコード数。 |
20 |
| SourceType |
string |
任意 |
ソースタイプ。 |
OSS |
| Keyword |
string |
任意 |
ファイル名のキーワード。 |
FinancialReport |
| FileIds |
string |
任意 |
カンマ区切りのファイル ID のリスト。 |
doc_a,doc_b |
| LinkId |
string |
任意 |
同期リンクの一意の識別子。 |
pkbl-2ze123456789abc |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答スキーマ。 |
||
| RequestId |
string |
リクエストの ID。 |
CED079B7-A408-41A1-BFF1-EC608E****** |
| PageNumber |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
1 ページあたりのレコード数。有効な値: 30、50、100。 デフォルト値: 30。 |
30 |
| TotalRecordCount |
integer |
レコードの総数。 |
9 |
| PageRecordCount |
integer |
現在のページのレコード数。 |
9 |
| Items |
array<object> |
ファイルのリスト。 |
|
|
array<object> |
ファイルの詳細。 |
||
| FileId |
string |
ファイルの ID。 |
5b2dbb13-xxxx-xxxx-xxxx-a55fe8daec8f |
| KnowledgeSpaceId |
string |
ナレッジスペースの ID。 |
pks-xxxxxx |
| KnowledgeBaseId |
string |
ナレッジベースの ID。 |
pkb-xxxxxx |
| FileName |
string |
ファイル名。 |
FinancialReport.pdf |
| OSSPath |
string |
OSS ファイルのパス。 |
oss://test-bucket-example/pks-xxxx/pkb-xxxx/FinancialReport.pdf |
| FileSize |
integer |
バイト単位のファイルサイズ。 |
318881 |
| FileType |
string |
ファイルタイプ。 |
|
| ShardCount |
integer |
シャードの数。 |
10 |
| ShardingStrategyConfig |
object |
ドキュメントに対して現在有効なチャンキング戦略構成。既存のインスタンスに対して完全な構成が保存されていない場合、この値は空になることがあります。 |
|
| DefaultStrategy |
object |
デフォルトのチャンキング戦略タイプ。有効な値: hybrid、階層。 |
|
| Type |
string |
デフォルトのチャンキング戦略タイプ。有効な値: hybrid、階層。 |
hybrid |
| Parameters |
object |
パラメーターリスト。 |
|
| MaxTokens |
integer |
シャードあたりのトークン数の最大値。 |
512 |
| MergePeers |
boolean |
同一見出し下の隣接する small シャードをマージするかどうかを指定します。 |
true |
| Rules |
array<object> |
注文でマッチしたオーバーライドルールのリスト。 |
|
|
array<object> |
ルールの詳細。 |
||
| Match |
object |
コンテンツタイプ。現在、table がサポートされています。 |
|
| ContentType |
string |
コンテンツタイプ。現在、table がサポートされています。 |
table |
| Strategy |
object |
チャンキング戦略。 |
|
| Type |
string |
ルールマッチ後のチャンキング戦略タイプ。 |
階層 |
| Parameters |
object |
パラメーターリスト。 |
|
| MaxTokens |
integer |
マッチしたコンテンツのシャードあたりのトークン数の最大値。 |
512 |
| MarkdownTables |
string |
Markdown テーブル処理モード。有効な値: auto、on、off。 |
auto |
| InheritSpaceStrategy |
boolean |
ナレッジスペースのチャンキング戦略を継承するかどうかを示します。 |
true |
| Status |
string |
ステータス。 |
COMPLETED |
| ErrorMessage |
string |
エラーメッセージ。 |
Not Support |
| Metadata |
object |
ドキュメントのメタデータ。 |
{} |
| SourceType |
string |
ソースタイプ。 |
OSS |
| UploadTime |
string |
アップロード時間。 時間は、ISO 8601 形式の協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。 |
2026-06-15T22:28:53Z |
| UpdatedAt |
string |
更新時間。 時間は、ISO 8601 形式の協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。 |
2026-06-15T22:28:53Z |
例
成功レスポンス
JSONJSON
{
"RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
"PageNumber": 1,
"PageSize": 30,
"TotalRecordCount": 9,
"PageRecordCount": 9,
"Items": [
{
"FileId": "5b2dbb13-xxxx-xxxx-xxxx-a55fe8daec8f",
"KnowledgeSpaceId": "pks-xxxxxx",
"KnowledgeBaseId": "pkb-xxxxxx",
"FileName": "Financial_report.pdf",
"OSSPath": "oss://test-bucket-example/pks-xxxx/pkb-xxxx/Financial_report.pdf",
"FileSize": 318881,
"FileType": "pdf",
"ShardCount": 10,
"ShardingStrategyConfig": {
"DefaultStrategy": {
"Type": "hybrid",
"Parameters": {
"MaxTokens": 512,
"MergePeers": true
}
},
"Rules": [
{
"Match": {
"ContentType": "table"
},
"Strategy": {
"Type": "階層",
"Parameters": {
"MaxTokens": 512,
"MarkdownTables": "auto"
}
}
}
]
},
"InheritSpaceStrategy": true,
"Status": "COMPLETED",
"ErrorMessage": "Not Support",
"Metadata": {},
"SourceType": "OSS",
"UploadTime": "2026-06-15T22:28:53Z",
"UpdatedAt": "2026-06-15T22:28:53Z"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。