指定されたカテゴリの 1 つ以上のドキュメントの詳細情報を一覧表示します。
操作説明
-
RAM ユーザーは、この API を呼び出す前に、Alibaba Cloud Model Studio のデータベース権限を取得し、ワークスペースに参加する必要があります。必要な権限は、`sfm:ListFile` 権限を含む
AliyunBailianDataFullAccessです。Alibaba Cloud アカウントは、認証なしでこの API を直接呼び出すことができます。この API を呼び出すには、最新バージョンの Alibaba Cloud Model Studio SDK を使用します。 -
ページングクエリを実行するには、
MaxResultsパラメーターを使用して、各ページで返す項目数を指定します。レスポンスはNextTokenを返します。次のページの結果を取得するには、前のレスポンスのNextTokenを次のリクエストに含めます。レスポンスがNextTokenを返さない場合、すべての結果が返されています。 -
この API 操作はべき等です。
速度制限 この API への頻繁な呼び出しは速度制限されます。この操作は 1 秒間に 5 回以上呼び出さないでください。呼び出しが速度制限された場合は、後で再試行してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sfm:ListFile |
list |
*All Resource
|
なし | なし |
リクエスト構文
GET /{WorkspaceId}/datacenter/files HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkspaceId |
string |
必須 |
カテゴリが存在するワークスペースの ID です。詳細については、「ワークスペースの使用方法」をご参照ください。 |
llm-3shx2gu255oqxxxx |
| CategoryId |
string |
必須 |
カテゴリの ID です。これは、 AddCategory 操作によって返される `CategoryId` です。アプリケーションデータ ページの [非構造化データ] タブで、カテゴリ名の横にある ID アイコンをクリックして ID を取得することもできます。 |
cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| NextToken |
string |
任意 |
次のページの結果を取得するために使用されるトークンです。このパラメーターを、前の呼び出しで返された `NextToken` 値に設定します。 |
AAAAAdH70eOCSCKtacdomNzak4U= |
| MaxResults |
integer |
任意 |
各ページで返すエントリの数です。有効な値：1 ～ 200。 デフォルト値：このパラメーターを設定しないか、1 未満の値に設定した場合、デフォルト値は 20 です。200 を超える値に設定した場合、デフォルト値は 200 です。 |
20 |
| FileName |
string |
任意 |
拡張子を除くファイルの名前です。完全一致のみがサポートされています。あいまい検索はサポートされていません。 |
测试文件名 |
レスポンスフィールド
|
パラメーター |
型 |
説明 |
例 |
|
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 + 08:00 です。 |
2024-09-09 11:03:35 |
| FileId |
string |
ドキュメントの ID です。これは、 AddFile 操作によって返される `FileId` です。アプリケーションデータ ページで、ドキュメント名の横にあるアイコンをクリックして ID を取得することもできます。 |
file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx |
| FileName |
string |
ドキュメントの名前です。 |
XXX产品介绍.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 |
| Tags |
array |
ドキュメントに追加されているタグのリスト。ドキュメントには複数のタグを関連付けることができます。 |
|
|
string |
ドキュメントのタグ。 |
产品介绍 |
|
| HasNext |
boolean |
次のページの結果が存在するかどうかを示します。有効な値：
|
true |
| MaxResults |
integer |
各ページで返されるエントリの数。 |
20 |
| NextToken |
string |
次のページの結果を取得するために使用されるトークン。 |
4jzbJk9J6lNeuXD9hP0viA== |
| TotalCount |
integer |
返されたエントリの総数。 |
48 |
| Message |
string |
エラーメッセージ。 |
Requests throttling triggered. |
| RequestId |
string |
リクエストの ID。 |
8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1 |
| Status |
string |
HTTP ステータスコード。 |
200 |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値：
|
true |
例
成功レスポンス
JSONJSON
{
"Code": "success",
"Data": {
"FileList": [
{
"CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx",
"CreateTime": "2024-09-09 11:03:35",
"FileId": "file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx",
"FileName": "XXX产品介绍.pdf",
"FileType": "docx",
"Parser": "DASHSCOPE_DOCMIND",
"SizeInBytes": 512,
"Status": "PARSE_SUCCESS",
"Tags": [
"产品介绍"
]
}
],
"HasNext": true,
"MaxResults": 20,
"NextToken": "4jzbJk9J6lNeuXD9hP0viA==",
"TotalCount": 48
},
"Message": "Requests throttling triggered.",
"RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
"Status": "200",
"Success": true
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。