指定されたワークスペース内のナレッジベースのリストを取得します。
操作説明
Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、Alibaba Cloud Model Studio の API 権限 を取得する必要があります（
AliyunBailianDataFullAccessが必要で、sfm:ListIndex 権限を含みます）。Alibaba Cloud アカウントは権限付与なしでこの操作を直接呼び出せます。最新のAlibaba Cloud Model Studio SDK を使用してこの操作を呼び出してください。この操作はべき等です。
レート制限: この操作は頻繁に呼び出されるとスロットリングされます。1 秒あたり 10 回の呼び出しを超えないようにしてください。スロットリングされた場合は、後でリトライしてください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sfm:ListIndex |
list |
*All Resource
|
なし | なし |
リクエスト構文
GET /{WorkspaceId}/index/list_indices HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkspaceId |
string |
必須 |
ナレッジベースが属するワークスペースの ID。詳細については、ワークスペースの使用方法 を参照してください。 |
llm-3shx2gu255oq6xxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| IndexName |
string |
任意 |
ナレッジベースの名前。このパラメーターを使用して、名前でナレッジベースを検索できます。名前は 1～20 文字で、Unicode で文字に分類される文字（英字、中国語文字、数字を含む）を使用できます。また、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) も使用できます。 デフォルト値: 空。指定されたワークスペース内のすべてのナレッジベースを照会します。 |
idx_status_score |
| PageNumber |
string |
任意 |
ページ番号。最小値: 1。デフォルト値: 1。 |
1 |
| PageSize |
string |
任意 |
ページングクエリで 1 ページあたりに表示するナレッジベースの数。最大値の制限はありません。 デフォルト値: 10。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
17204B98-xxxx-4F9A-8464-2446A84821CA |
| Data |
object |
返されたデータ。 |
|
| PageNumber |
integer |
返されたページ番号。 |
1 |
| PageSize |
integer |
返された 1 ページあたりのエントリ数。 |
10 |
| TotalCount |
integer |
返されたエントリの総数。 |
48 |
| Indices |
array<object> |
ナレッジベースのリスト。 |
|
|
object |
ナレッジベースオブジェクト。 |
||
| Id |
string |
ナレッジベースの ID。 これは、CreateIndex 操作によって返される |
lecxr5xxxx |
| Name |
string |
ナレッジベースの名前。 |
XXXX产品清单 |
| Description |
string |
ナレッジベースの説明。 |
清单中产品主要面向海外客户。 |
| StructureType |
string |
ナレッジベースの構造タイプ。有効な値：
|
UNSTRUCTURED |
| ChunkSize |
integer |
各チャンクの推定長。値の範囲は 1 ～ 2048 です。 |
5 |
| OverlapSize |
integer |
チャンク間の重複の長さ。値の範囲は 0 ～ 1024 です。 |
10 |
| Separator |
string |
文の区切り文字。複数の区切り文字を指定する場合は、縦棒（|）を使用して区切ります。有効な値：
|
\n |
| EmbeddingModelName |
string |
埋め込みモデルの名前。有効な値：
|
text-embedding-v2 |
| RerankModelName |
string |
再ランク付けモデルの名前。有効な値：
|
gte-rerank-hybrid |
| RerankMinScore |
string |
類似度のしきい値。値の範囲は 0.01 ～ 1.00 です。 |
0.01 |
| SourceType |
string |
Alibaba Cloud Model Studio アプリケーションデータ 内のアプリケーションデータのデータ型。非構造化ナレッジベースの場合、有効な値は次のとおりです。
構造化ナレッジベースの場合、有効な値は次のとおりです。
|
DATA_CENTER_FILE |
| DocumentIds |
array |
ドキュメント ID のリスト。 |
|
|
string |
ドキュメント ID。 |
file_8c67b438043848199ffaa903d29addd4_xxxxxxxx |
|
| SinkType |
string |
ナレッジベースのベクトルストレージタイプ。有効な値：
|
BUILT_IN |
| SinkInstanceId |
string |
ベクトルストアのインスタンス ID。 |
gp-bp1gq62t1788yxxxx |
| SinkRegion |
string |
ベクトルストアインスタンスのリージョン。 |
cn-hangzhou |
| ConfgModel |
string |
このナレッジベースで使用される構成パターン。有効な値：
|
recommend |
| EnableRewrite |
boolean |
このナレッジベースに対してmulti-turn conversation の書き換えが有効かどうかを示します。有効な値：
|
false |
| Code |
string |
エラーコード。 |
Index.InvalidParameter |
| Message |
string |
エラーメッセージ。 |
Required parameter(%s) missing or invalid, please check the request parameters. |
| Success |
boolean |
操作が成功したかどうかを示します。有効な値:
|
true |
| Status |
string |
操作から返された状態コード。 |
200 |
例
成功レスポンス
JSONJSON
{
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 48,
"Indices": [
{
"Id": "lecxr5xxxx",
"Name": "XXXX产品清单",
"Description": "清单中产品主要面向海外客户。",
"StructureType": "UNSTRUCTURED",
"ChunkSize": 5,
"OverlapSize": 10,
"Separator": "\\n",
"EmbeddingModelName": "text-embedding-v2",
"RerankModelName": "gte-rerank-hybrid",
"RerankMinScore": "0.01",
"SourceType": "DATA_CENTER_FILE",
"DocumentIds": [
"file_8c67b438043848199ffaa903d29addd4_xxxxxxxx"
],
"SinkType": "BUILT_IN",
"SinkInstanceId": "gp-bp1gq62t1788yxxxx",
"SinkRegion": "cn-hangzhou",
"ConfgModel": "recommend",
"EnableRewrite": false
}
]
},
"Code": "Index.InvalidParameter",
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"Success": true,
"Status": "200"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。