インスタンス ID を指定して、条件に一致するモデルのリストを照会します。
操作説明
操作の説明
この API オペレーションは、指定されたインスタンスからモデルのリストを取得します。モデル名、タイプ、およびページネーションパラメーターで結果をフィルターできます。インスタンス ID をパスパラメーターとして指定します。その他のフィルター条件はオプションのクエリパラメーターです。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
searchengine:ListModels |
list |
*Instance
|
なし | なし |
リクエスト構文
GET /openapi/ha3/instances/{instanceId}/models HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンス ID。 |
ha-cn-test |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| name |
string |
任意 |
モデル名。 |
test1 |
| type |
string |
任意 |
モデルタイプ。 |
text_embedding |
| pageNumber |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| pageSize |
integer |
任意 |
1 ページあたりのエントリ数。デフォルト値: 10。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答にはリクエスト ID とモデルリストが含まれます。モデルリストの各要素には、名前、タイプ、URL、ステータスなどの詳細なモデル情報が含まれます。 |
||
| requestId |
string |
リクエスト ID。 |
38b079f1-7846-4226-8c90-3e2644b5c52b |
| totalCount |
integer |
エントリの総数。 |
14 |
| result |
array<object> |
モデルリスト。詳細については、Model を参照してください。 |
|
|
array<object> |
モデル情報。 |
||
| name |
string |
モデル名。 |
test |
| type |
string |
モデルタイプ。
|
text_embedding |
| url |
string |
モデルサービスのアクセス URL。 |
http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001 |
| status |
string |
モデルのステータス。有効な値:
|
ok |
| dimension |
integer |
モデルのディメンション。 |
128 |
| content |
object |
モデルのコンテンツ情報。 |
|
| modelName |
string |
モデル名。 |
test |
| modelType |
string |
モデルタイプ。
|
text_embedding |
| url |
string |
モデルサービスのエンドポイント。 |
http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001 |
| method |
string |
モデルサービスにアクセスするための HTTP メソッド。サポートされているメソッドは PUT と POST です。 |
POST |
| request |
object |
リクエスト構成。 |
|
| header |
object |
モデルサービスにアクセスするための HTTP ヘッダー。 |
|
| Authorization |
string |
認証情報。フォーマット: Bearer access_token |
Bearer OS-v0********6vvs |
| Content-Type |
string |
HTTP リクエストのコンテンツタイプ。 |
application/json |
| urlParams |
object |
URL 内のパラメーター。一部のモデルサービスでは、URL でパラメーターを渡す必要があります。 |
|
| build |
object |
インデックス構築中に渡されるパラメーター。 |
key: value |
| search |
object |
クエリ中に渡されるパラメーター。 |
key: value |
| requestBody |
string |
リクエスト本文のテンプレート文字列。 |
{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"} |
| parameters |
object |
本文パラメーターがビルドフェーズと検索フェーズで異なる必要がある場合は、このオブジェクトで定義します。 |
|
| build |
object |
インデックス構築フェーズのパラメーター。 |
|
| input_type |
string |
入力タイプ。 |
query |
| search |
object |
クエリフェーズのパラメーター。 |
|
| input_type |
string |
入力タイプ。 |
document |
| response |
object |
結果の解析に使用される JSONPath 式。 |
|
| embeddings |
string |
結果の解析に使用される JSONPath 式。 |
$.result.embeddings[*].embedding |
| createTime |
string |
作成時間。 |
2024-05-21 16:05:26 |
| updateTime |
string |
最終更新時間。 |
2024-05-21 16:05:26 |
例
成功レスポンス
JSONJSON
{
"requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
"totalCount": 14,
"result": [
{
"name": "test",
"type": "text_embedding",
"url": "http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001",
"status": "ok",
"dimension": 128,
"content": {
"modelName": "test",
"modelType": "text_embedding",
"url": "http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001",
"method": "POST",
"request": {
"header": {
"Authorization": "Bearer OS-v0********6vvs\n",
"Content-Type": "application/json\n"
},
"urlParams": {
"build": {
"test": "test",
"test2": 1
},
"search": {
"test": "test",
"test2": 1
}
},
"requestBody": "{\\\"input\\\": [\\\"%{input}\\\"], \\\"input_type\\\": \\\"%{input_type}\\\"}",
"parameters": {
"build": {
"input_type": "query\n"
},
"search": {
"input_type": "document\n"
}
}
},
"response": {
"embeddings": "$.result.embeddings[*].embedding\n"
}
},
"createTime": "2024-05-21 16:05:26",
"updateTime": "2024-05-21 16:05:26"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。