指定されたナレッジベースからファイルとそのまとめ情報を取得します。
操作説明
Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、まず Model Studio の API 権限（
AliyunBailianDataFullAccess（sfm:ListIndexFiles 権限を含む）が必要）を取得し、ワークスペースに参加する必要があります。Alibaba Cloud アカウントは、権限付与なしでこの操作を直接呼び出すことができます。最新のModel Studio SDKを使用してこの操作を呼び出してください。この操作を呼び出す前に、ナレッジベースが作成済みで削除されていないこと（つまり、ナレッジベース ID
IndexIdが有効であること）を確認してください。この操作はべき等性を持ちます。
速度制限: この操作は、頻繁に呼び出されると速度制限されます。1 秒あたり 15 回を超えないようにしてください。速度制限された場合は、後でリトライしてください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sfm:ListIndexFiles |
list |
*All Resource
|
なし | なし |
リクエスト構文
GET /{WorkspaceId}/index/list_index_documents HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkspaceId |
string |
必須 |
ナレッジベースのワークスペース ID。ワークスペース ID の取得方法については、ワークスペースの使用方法を参照してください。 |
llm-3z7uw7fwz0vexxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| IndexId |
string |
必須 |
ナレッジベース ID。CreateIndex 操作で返される |
79c0alxxxx |
| DocumentStatus |
string |
任意 |
ファイルインポートステータスで返されるファイルリストをフィルタリングします。有効な値:
デフォルト値: 空。ファイルインポートステータスによるフィルタリングを行いません。 列挙値:
|
FINISH |
| DocumentName |
string |
任意 |
ファイル名（ファイル拡張子を除く）で返されるファイルリストをフィルタリングします。デフォルト値: 空。ファイル名によるフィルタリングを行いません。 |
product-overview |
| EnableNameLike |
string |
任意 |
ファイル名のあいまい一致を有効にするかどうかを指定します。このパラメーターは
デフォルト値: false。 列挙値:
|
false |
| PageNumber |
integer |
任意 |
ページ番号。最小値: 1。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリで 1 ページあたりに表示するファイル数。最大値の制限はありません。 デフォルト値: 10。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code |
string |
エラー状態コード。 |
InvalidParameter |
| Message |
string |
エラーメッセージ。 |
Required parameter(%s) missing or invalid, please check the request parameters. |
| Success |
boolean |
操作が成功したかどうかを示します。有効な値:
|
true |
| Data |
object |
操作によって返されるデータフィールド。 |
|
| Documents |
array<object> |
ナレッジベース内のファイルリスト。ドキュメントインポート時間の降順でソートされます（コンソールと同じ）。 |
|
|
object |
ファイルオブジェクト。 |
||
| SourceId |
string |
ドキュメント検索ナレッジベースの場合、このパラメーターはカテゴリ ID を指定します。これは AddCategory 操作で返される データクエリまたはイメージ Q&A ナレッジベースの場合、このパラメーターはデータテーブル ID を指定します。アプリケーションデータのテーブルタブでデータテーブル名の横にある ID アイコンをクリックして取得できます。 |
cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx |
| Id |
string |
ファイル ID。 |
doc_c134aa2073204a5d936d870bf960f56axxxxxxxx |
| Name |
string |
ファイル名。 |
product-overview |
| Size |
integer |
ファイルサイズ（バイト単位）。 |
996765 |
| DocumentType |
string |
ファイル形式タイプ。有効な値: pdf、docx、doc、txt、md、pptx、ppt、png、jpg、jpeg、bmp、gif、EXCEL。 |
|
| Status |
string |
ファイルインポートステータス。有効な値:
列挙値:
|
RUNNING |
| Code |
string |
ファイルインポートのエラー状態コード。 |
110002 |
| Message |
string |
ファイルインポートのエラーメッセージ。 |
check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid |
| GmtModified |
integer |
ファイルがナレッジベースにインポートされた時間（UNIX タイムスタンプフォーマット）。 |
1744856423000 |
| IndexId |
string |
ナレッジベース ID。 |
pno97txxxx |
| TotalCount |
integer |
返された結果の総数。 |
2437 |
| PageNumber |
integer |
返されたページ番号。 |
1 |
| PageSize |
integer |
返された 1 ページあたりのエントリ数。 |
10 |
| Status |
string |
操作によって返された状態コード。 |
200 |
例
成功レスポンス
JSONJSON
{
"RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
"Code": "InvalidParameter",
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"Success": true,
"Data": {
"Documents": [
{
"SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx",
"Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx",
"Name": "product-overview",
"Size": 996765,
"DocumentType": "pdf",
"Status": "RUNNING",
"Code": "110002",
"Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
"GmtModified": 1744856423000
}
],
"IndexId": "pno97txxxx",
"TotalCount": 2437,
"PageNumber": 1,
"PageSize": 10
},
"Status": "200"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。