指定されたカテゴリ内の 1 つ以上のドキュメントの詳細を取得します。
操作説明
-
Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、まず Alibaba Cloud Model Studio の API 権限 を取得し（
AliyunBailianDataFullAccessが必要で、sfm:ListFile 権限を含みます）、ワークスペースに参加 する必要があります。Alibaba Cloud アカウントは権限付与なしでこの操作を直接呼び出せます。最新の Alibaba Cloud Model Studio SDK を使用してこの操作を呼び出してください。 -
最初のページのページングでは、
MaxResultsのみを設定して返されるエントリ数を制限します。応答のNextTokenは後続ページをクエリするための認証情報として機能します。後続ページをクエリする場合、NextTokenパラメーターを前回の応答から取得したNextToken値に設定し（NextTokenが空の場合、すべての結果が返されており、追加のリクエストは不要です）、MaxResultsを設定して返されるエントリ数を制限します。 -
この操作はべき等です。
レート制限: この操作は頻繁に呼び出されるとスロットリングされます。1 秒あたり 5 回の呼び出しを超えないようにしてください。スロットリングされた場合は、後でリトライしてください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sfm:ListFile |
list |
*All Resource
|
なし | なし |
リクエスト構文
GET /{WorkspaceId}/datacenter/files HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkspaceId |
string |
必須 |
カテゴリが属するワークスペース ID。ワークスペース ID の取得方法については、ワークスペースの使用方法 を参照してください。フォーマットについてはドキュメントをご確認ください。 |
llm-3shx2gu255oqxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| CategoryId |
string |
必須 |
カテゴリ ID。AddCategory 操作で返される . |
cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| NextToken |
string |
任意 |
ページネーショントークン。前回の API 呼び出しで返された NextToken 値を設定してください。 |
AAAAAdH70eOCSCKtacdomNzak4U= |
| MaxResults |
integer |
任意 |
ページングにおける 1 ページあたりのエントリ数。有効な値: 1～200。 デフォルト値: 値が設定されていないか 1 未満の場合、デフォルト値は 20 です。値が 200 を超える場合、デフォルト値は 200 です。 |
20 |
| FileName |
string |
任意 |
ファイル名（拡張子なし）。完全に一致のみサポートされます。あいまい検索はサポートされていません。 |
product-overview |
| FileIds |
array |
任意 |
クエリするファイル ID のリスト。一度に最大 20 ファイルをクエリできます。 |
|
|
string |
任意 |
ファイル ID。 |
file_xxxx |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ。 |
||
| Code |
string |
エラーコード。 |
success |
| Data |
object |
操作によって返されるデータフィールド。 |
|
| FileList |
array<object> |
カテゴリ内のファイルのリスト。 |
|
|
object |
ファイルオブジェクト。 |
||
| CategoryId |
string |
ファイルが属するカテゴリの ID。 |
cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| CreateTime |
string |
ファイルが Alibaba Cloud Model Studio に追加された時間のタイムスタンプ。フォーマット: yyyy-MM-dd HH:mm:ss。タイムゾーン: 協定世界時 (UTC)+8。 |
2024-09-09 11:03:35 |
| FileId |
string |
ファイル ID。AddFile 操作で返される |
file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx |
| FileName |
string |
ファイル名。 |
product-overview.pdf |
| FileType |
string |
ファイル形式タイプ。有効な値: pdf、docx、doc、txt、md、pptx、ppt、xlsx、xls、html、png、jpg、jpeg、bmp、gif。 |
docx |
| Parser |
string |
ドキュメントパーサ。有効な値:
|
DASHSCOPE_DOCMIND |
| SizeInBytes |
integer |
ファイルサイズ（バイト単位）。 |
512 |
| Status |
string |
ファイルの解析ステータス。有効な値:
|
PARSE_SUCCESS |
| ParseErrorMessage |
string |
Error Message |
|
| Tags |
array |
ファイルに関連付けられたタグのリスト。ドキュメントは複数のタグに関連付けることができます。 |
|
|
string |
ファイルタグ。 |
tag-A |
|
| HasNext |
boolean |
クエリ条件に一致するカテゴリデータの次のページがあるかどうかを示します。有効な値:
|
true |
| MaxResults |
integer |
ページングにおける 1 ページあたりのエントリ数。 |
20 |
| NextToken |
string |
この呼び出しで返されたページネーショントークン。 |
4jzbJk9J6lNeuXD9hP0viA== |
| TotalCount |
integer |
返された結果のエントリの総数。 |
48 |
| Message |
string |
エラーメッセージ。 |
Requests throttling triggered. |
| RequestId |
string |
リクエスト ID。 |
8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1 |
| Status |
string |
操作によって返された状態コード。 |
200 |
| Success |
boolean |
操作が成功したかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"Code": "success",
"Data": {
"FileList": [
{
"CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx",
"CreateTime": "2024-09-09 11:03:35",
"FileId": "file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx",
"FileName": "product-overview.pdf",
"FileType": "docx",
"Parser": "DASHSCOPE_DOCMIND",
"SizeInBytes": 512,
"Status": "PARSE_SUCCESS",
"ParseErrorMessage": "Error Message",
"Tags": [
"tag-A"
]
}
],
"HasNext": true,
"MaxResults": 20,
"NextToken": "4jzbJk9J6lNeuXD9hP0viA==",
"TotalCount": 48
},
"Message": "Requests throttling triggered.",
"RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
"Status": "200",
"Success": true
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。