サービス名 | サービスID | サービスの説明 | API 呼び出しの QPS 制限 (Alibaba Cloud アカウントと RAM ユーザー) |
OpenSearch ベクトル次元削減サービス-001 | ops-embedding-dim-reduction-001 | ベクトル次元削減サービスを提供し、最大 4k までのベクトル次元削減をサポートします。ビジネスニーズに合わせてモデルを微調整できます。 | 50 説明 より高い QPS を申請するには、チケットを送信してください。
|
前提条件
認証情報の取得
API を介して OpenSearch Search Development Console サービスを呼び出す場合は、呼び出し元の ID を認証する必要があります。
サービスアクセスアドレスの取得
パブリックネットワークと VPC の両方でサービスの呼び出しをサポートしています。詳細については、サービス登録アドレスの取得を参照してください。
リクエストの説明
概要
リクエスト本文は 8MB を超えてはいけません。
HTTP リクエストメソッド
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/embedding-tuning/{service_id}host: サービスを呼び出すためのアドレス。パブリックネットワークと VPC の両方で API サービスの呼び出しをサポートしています。詳細については、エンドポイントのクエリを参照してください。
workspace_name: ワークスペースの名前。例: 'default'
service_id: システム組み込みのサービス ID。例: ops-embedding-dim-reduction-001
リクエストパラメータ
ヘッダーパラメータ
API-KEY 認証
パラメータ | タイプ | 必須 | 説明 | 値の例 |
Content-Type | String | はい | リクエストタイプ: application/json | application/json |
Authorization | String | はい | API-Key | Bearer OS-d1**2a |
ボディパラメータ
パラメータ | タイプ | 必須 | 説明 | 値の例 |
input | List<List<Float>> | はい | 入力ベクトルコレクション。 | [0.111,0.222,0.333] |
parameters | Map | いいえ | 調整可能なリクエストパラメータ。これらのパラメータは、サービス ID によって異なる場合があります。 | |
parameters.output_dimension | Integer | いいえ | 出力次元。デフォルト値: 512。 | 512 |
parameters.model_name | String | いいえ | ユーザーがトレーニングしたモデルの名前。ベクトル圧縮サービスの場合は必須です。 | xxxx-model |
レスポンスパラメータ
パラメータ | タイプ | 説明 | 値の例 |
result.output | List<List<Float>> | 微調整されたベクトル結果。 | |
usage.doc_count | Int | このリクエストで入力されたベクトルエントリの数。 | 2 |
Curl リクエスト例
curl --location 'http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/embedding-tuning/ops-embedding-dim-reduction-001/' \
--header 'Authorization: Bearer Your-API-KEY' \
--header 'Content-Type: application/json' \
--data '{
"input": [
[0.111,0.222,0.333],
[0.121,0.221,0.331]
],
"parameters":{
"output_dimension": "512",
"model_name" : "xxxx"
}
}'サンプルレスポンス
正常なサンプルレスポンス
{
"request_id": "450fcb80-f796-46c1-8d69-e1e86d29aa9f",
"latency": 564.903929,
"usage": {
"doc_count": 2
}
"result": {
"output":[
[0.111,0.222,0.333],
[0.121,0.221,0.331]
]
}
}サンプルエラーレスポンス
アクセスリクエストエラーが発生した場合、出力は code と message によってエラーの理由を指定します。
{
"request_id": "590A7EB8-AA84-****-AF31-8C35DC965972",
"latency": 0.0,
"code": "InvalidParameter",
"http_code": 400,
"message": "document.file_name required"
}ステータスコード
HTTP ステータスコード | エラーコード | 説明 |
200 | - | リクエスト成功。タスク失敗のシナリオも含みます。実際のタスクステータスは result.status から判断する必要があります |
404 | BadRequest.TaskNotExist | 指定されたタスクが存在しないために返されたエラーメッセージ。 |
400 | InvalidParameter | 無効なリクエスト |
500 | InternalServerError | 内部エラー |
詳細については、ステータスコードの説明を参照してください。