非構造化ナレッジベースの場合、この操作は、指定されたドキュメントのすべてのセグメントの詳細を取得します。構造化ナレッジベースの場合、この操作はすべてのテキストセグメントの詳細を取得します。
操作説明
RAM ユーザーはこの操作を呼び出す前に、Alibaba Cloud Model Studioに必要な API 権限 を取得し、ワークスペースに参加する 必要があります。
sfm:ChunkList権限ポイントを含む AliyunBailianDataFullAccess 権限が必要です。Alibaba Cloud アカウントは、承認なしでこの操作を呼び出すことができます。この操作は、Alibaba Cloud Model Studio ソフトウェア開発キット（SDK） の最新バージョンを使用して呼び出すことができます。この操作を呼び出す前に、ナレッジベースが作成済みであり、削除されていないことを確認してください。つまり、ナレッジベース ID（
IndexId）が有効である必要があります。この操作はべき等です。
速度制限： この操作への頻繁な呼び出しは速度制限されます。1 秒あたり 10 回を超えないようにしてください。速度制限が発生した場合は、待機してから再試行してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sfm:ChunkList |
list |
*All Resource
|
なし | なし |
リクエスト構文
POST /{WorkspaceId}/index/list_chunks HTTP/1.1リクエストパラメーター
|
パラメーター |
タイプ |
必須 / 任意 |
説明 |
例 |
| WorkspaceId |
string |
必須 |
ナレッジベースが属するワークスペースの ID。詳細については、「ワークスペースの使い方」をご参照ください。 |
llm-3z7uw7fwz0vxxxx |
| body |
object |
任意 |
リクエストパラメータの本文。 |
|
| Fields |
array |
任意 |
応答の `Metadata` フィールドにある非公開以外のフィールドをフィルタリングするために使用されるフィールド名の配列。非公開以外のフィールドとは、アンダースコア（_）で始まらないフィールドです。デフォルトでは、このパラメータは空で、`Metadata` の非公開以外のすべてのフィールドが返されます。`Metadata` フィールドに `title` などの特定の非公開以外のフィールドのみを返したい場合は、このパラメータを `title` に設定します。 デフォルト値：空。 |
|
|
string |
任意 |
フィールド名。 |
name |
|
| Filed |
string |
任意 |
これは、以前のバージョンの Alibaba Cloud Model Studio SDK のドキュメント ID フィールドです。その使用方法とデフォルト値は、
説明
Alibaba Cloud Model Studio SDK のバージョンを確認する方法：Alibaba Cloud Model Studio SDK センター にアクセスし、左側のナビゲーションウィンドウで [インストール] をクリックし、API バージョンを 2023-12-29 に設定し、プログラミング言語を選択してから、[バージョン履歴] をクリックします。 |
file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx |
| FileId |
string |
任意 |
ドキュメント ID。これは、AddFile 操作によって返される |
file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx |
| IndexId |
string |
必須 |
ナレッジベース ID。これは、CreateIndex 操作によって返される |
otoru9xxxx |
| PageNum |
integer |
任意 |
クエリするページ番号。値は 1 から始まります。デフォルト値：1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリで各ページに表示するテキストセグメントの数。最大値は 100 です。デフォルト値：10。 |
10 |
レスポンスパラメーター
|
パラメーター |
タイプ |
説明 |
例 |
|
object |
|||
| Code |
string |
エラーコード。 |
Index.InvalidParameter |
| Data |
object |
返されたデータ。 |
|
| Nodes |
array<object> |
テキストセグメントのリスト。 |
|
|
object |
テキストセグメントオブジェクト。 |
||
| Metadata |
any |
テキストセグメントのメタデータのマップ。 |
{ "file_path": "https://bailian-***", "parent": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。", "is_displayed_chunk_content": "true", "image_url": [], "nid": "83***", "source": "0", "_score": 0, "title": "", "doc_id": "file_24e***", "content": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。", "_rc_score": 0, "workspace_id": "llm-zna***", "hier_title": "", "doc_name": "什么是阿里云百炼", "pipeline_id": "j6b***", "_id": "llm-zna5***" } |
| Score |
number |
テキストセグメントの類似度スコア。 |
0 |
| Text |
string |
テキストセグメントの内容。 |
阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。 |
| Total |
integer |
返されたエントリの総数。 |
1 |
| Message |
string |
エラーメッセージ。 |
Required parameter(%s) missing or invalid, please check the request parameters. |
| RequestId |
string |
リクエスト ID。 |
8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1 |
| Status |
string |
操作によって返された状態コード。 |
200 |
| Success |
boolean |
呼び出しが成功したかどうかを示します。有効な値：
|
true |
例
成功レスポンス
JSONJSON
{
"Code": "Index.InvalidParameter",
"Data": {
"Nodes": [
{
"Metadata": "{\n \"file_path\": \"https://bailian-***\",\n \"parent\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。\",\n \"is_displayed_chunk_content\": \"true\",\n \"image_url\": [],\n \"nid\": \"83***\",\n \"source\": \"0\",\n \"_score\": 0,\n \"title\": \"\",\n \"doc_id\": \"file_24e***\",\n \"content\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。\",\n \"_rc_score\": 0,\n \"workspace_id\": \"llm-zna***\",\n \"hier_title\": \"\",\n \"doc_name\": \"什么是阿里云百炼\",\n \"pipeline_id\": \"j6b***\",\n \"_id\": \"llm-zna5***\"\n }",
"Score": 0,
"Text": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。"
}
],
"Total": 1
},
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
"Status": "200",
"Success": true
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。