指定されたナレッジベース内のファイルとその詳細を取得します。
操作説明
Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、Alibaba Cloud Model Studio の API 権限（
AliyunBailianDataFullAccessが必須で、sfm:ListIndexFiles 権限を含みます）を取得する必要があります。Alibaba Cloud アカウントは権限付与なしでこの操作を直接呼び出すことができます。最新のAlibaba Cloud Model Studio SDKを使用してこの操作を呼び出してください。この操作を呼び出す前に、ナレッジベースが作成済みで削除されていないこと（つまり、ナレッジベース ID
IndexIdが有効であること）を確認してください。この操作はべき等性を持ちます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sfm:ListIndexFileDetails |
list |
*All Resource
|
なし | なし |
リクエスト構文
POST /{WorkspaceId}/index/list_index_file_detail HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkspaceId |
string |
必須 |
ナレッジベースが属するワークスペースの ID。ワークスペース ID の取得フォーマットについては、ワークスペースの使用方法を参照してください。 |
llm-3z7uw7fwz0vexxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| IndexId |
string |
任意 |
ナレッジベース ID。CreateIndex 操作で返される |
79c0alxxxx |
| DocumentStatus |
string |
任意 |
ファイルインポートステータスで返されるファイルリストをフィルタリングします。有効な値:
デフォルト値: 空。ファイルインポートステータスによるフィルタリングを行いません。 列挙値:
|
FINISH |
| DocumentName |
string |
任意 |
ファイル名で返されるファイル詳細リストをフィルタリングします。デフォルト値: 空。ファイル名によるフィルタリングを行いません。 |
翻译平台运维文档 |
| PageNumber |
integer |
任意 |
クエリするページ番号。最小値: 1。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングで 1 ページあたりに表示するファイル数。最大値: 10。 |
10 |
| EnableNameLike |
string |
任意 |
ファイル名のあいまい一致を有効にするかどうかを指定します。このパラメーターは
デフォルト値: false。 列挙値:
|
false |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
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 |
ファイルオブジェクト。 |
||
| Status |
string |
ファイルのインポートステータス。有効な値:
|
RUNNING |
| EnableHeaders |
string |
Excel ファイルのヘッダーが連結をサポートするかどうかを示します。 |
true |
| OverlapSize |
string |
セグメント間の重複の長さ。 |
100 |
| Message |
string |
ファイルのインポートエラーメッセージ。 |
check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid |
| Size |
integer |
ファイルサイズ（バイト単位）。 |
996764 |
| SourceId |
string |
カテゴリ ID。 |
cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx |
| GmtModified |
integer |
ファイルがナレッジベースにインポートされた時間（UNIX タイムスタンプフォーマット）。 |
1744856423000 |
| DocumentType |
string |
ファイル形式タイプ。有効な値: pdf、docx、doc、txt、md、pptx、ppt、png、jpg、jpeg、bmp、gif、EXCEL。 |
|
| ChunkMode |
string |
カスタムチャンクモード。 |
DashSplitter |
| Code |
string |
ファイルのインポートエラー状態コード。 |
110002 |
| separator |
string |
文の区切り文字。 |
" " |
| Name |
string |
ファイル名。 |
翻译平台运维文档 |
| ChunkSize |
string |
セグメントの長さ。テキストチャンク内の文字数です。 |
600 |
| Id |
string |
ファイル ID。 |
doc_c134aa2073204a5d936d870bf960f56axxxxxxxx |
| IndexId |
string |
ナレッジベース ID。 |
79c0alxxxx |
| TotalCount |
integer |
返された結果の総数。 |
2437 |
| PageNumber |
integer |
返されたページ番号。 |
1 |
| PageSize |
integer |
返された 1 ページあたりのエントリ数。 |
10 |
| Status |
string |
操作によって返された状態コード。 |
200 |
例
成功レスポンス
JSONJSON
{
"RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
"Code": "InvalidParameter\n",
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"Success": true,
"Data": {
"Documents": [
{
"Status": "RUNNING",
"EnableHeaders": "true",
"OverlapSize": "100",
"Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
"Size": 996764,
"SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx\n",
"GmtModified": 1744856423000,
"DocumentType": "pdf",
"ChunkMode": "DashSplitter",
"Code": "110002",
"separator": "\" \"",
"Name": "翻译平台运维文档\n",
"ChunkSize": "600",
"Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx\n"
}
],
"IndexId": "79c0alxxxx",
"TotalCount": 2437,
"PageNumber": 1,
"PageSize": 10
},
"Status": "200"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。