指定されたナレッジベース内の 1 つ以上のドキュメントの詳細を取得します。
操作説明
RAM ユーザーはこの操作を呼び出す前に、Alibaba Cloud Model Studio の API 権限を取得し、ワークスペースに参加する必要があります。 これには、sfm:ListIndexFiles 権限ポイントを含む
AliyunBailianDataFullAccess権限が必要です。 Alibaba Cloud アカウントは、認証なしでこの操作を呼び出すことができます。 この操作を呼び出すには、最新バージョンの Alibaba Cloud Model Studio SDK を使用してください。この操作を呼び出す前に、ナレッジベースが作成済みであり、削除されていないことを確認してください。 ナレッジベース ID（
IndexId）は有効である必要があります。この操作は冪等です。
速度制限: この操作は速度制限の対象となります。 1 秒あたり 15 回を超える呼び出しを行わないでください。 呼び出しが制限された場合は、待機してから再試行してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sfm:ListIndexFiles |
list |
*All Resource
|
なし | なし |
リクエスト構文
GET /{WorkspaceId}/index/list_index_documents HTTP/1.1リクエストパラメーター
|
パラメーター |
タイプ |
必須 / 任意 |
説明 |
例 |
| IndexId |
string |
必須 |
ナレッジベースの ID。 これは、CreateIndex 操作によって返される |
79c0alxxxx |
| DocumentStatus |
string |
任意 |
ドキュメントのインポートステータス。 このパラメーターを使用して、返されるドキュメントリストをフィルタリングします。 有効な値:
デフォルトでは、このパラメーターは空であり、結果はドキュメントのインポートステータスでフィルタリングされません。 |
FINISH |
| DocumentName |
string |
任意 |
ドキュメント名。 このパラメーターを使用して、返されるドキュメントリストをフィルタリングします。 デフォルトでは、このパラメーターは空であり、結果はドキュメント名でフィルタリングされません。 |
翻译平台运维文档 |
| EnableNameLike |
string |
任意 |
ドキュメント名にファジー一致を有効にするかどうかを示します。 このパラメーターは、
デフォルト値は false です。 |
false |
| PageNumber |
integer |
任意 |
クエリするページ番号。 値は 1 から始まります。 デフォルト値は 1 です。 |
1 |
| PageSize |
integer |
任意 |
各ページに返すドキュメントの数。 最大値は制限されていません。 デフォルト値は 10 です。 |
10 |
| WorkspaceId |
string |
必須 |
ナレッジベースが配置されているワークスペースの ID。 詳細については、「ワークスペースを使用する」をご参照ください。 |
llm-3z7uw7fwz0vexxxx |
レスポンスパラメーター
|
パラメーター |
タイプ |
説明 |
例 |
|
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 操作によって返される CategoryId です。 アプリケーションデータ ページの [非構造化データ] タブに移動し、カテゴリ名の横にある ID アイコンをクリックして ID を取得することもできます。 構造化データを持つナレッジベースの場合、これはデータテーブル ID です。 アプリケーションデータ ページの [構造化データ] タブに移動し、データテーブル名の横にある ID アイコンをクリックして ID を取得できます。 |
cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx |
| Id |
string |
ドキュメント ID。 |
doc_c134aa2073204a5d936d870bf960f56axxxxxxxx |
| Name |
string |
ドキュメント名。 |
翻译平台运维文档 |
| Size |
integer |
ドキュメントのサイズ（バイト単位）。 |
996764 |
| 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": "翻译平台运维文档",
"Size": 996764,
"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"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。