OpenSearch:ベクター次元削減サービス

サービス名	サービス ID	説明	QPS 制限
OpenSearch ベクター次元削減サービス-001	ops-embedding-dim-reduction-001	ベクター次元を削減します。モデルをファインチューニングして、ビジネスニーズに合わせたカスタムサービスを作成できます。このサービスは、最大 4,000 次元のベクターをサポートします。	50 説明 より高い API QPS 制限をリクエストするには、テクニカルサポートにチケットを送信してください。

前提条件

• 認証情報の取得

  AI Search オープンプラットフォームでは、認証に API キーが必要です。手順については、「API キーの取得」をご参照ください。

• サービスエンドポイントの取得

  パブリックネットワークまたは VPC 経由でサービスを呼び出すことができます。詳細については、「サービスエンドポイントの取得」をご参照ください。

リクエストフォーマット

一般的な説明

• リクエストボディは 8 MB を超えることはできません。

HTTP リクエストメソッド

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/embedding-tuning/{service_id}

• host：サービスエンドポイント。パブリックネットワークまたは VPC 経由で API を呼び出すことができます。詳細については、「サービスエンドポイントの取得」をご参照ください。エンドポイントを取得するには、AI Search オープンプラットフォームコンソールにログインします。左側のナビゲーションウィンドウで、[API キー] をクリックします。[アクセスドメイン名] セクションで、`{host}` の値として使用するドメイン名をコピーします。中国 (上海)、中国 (杭州)、中国 (深セン)、中国 (北京)、中国 (張家口)、および中国 (青島) リージョンでは、パブリックネットワークアクセスにはパブリックドメイン名を、VPC アクセスにはプライベートドメイン名を使用します。[API キーの作成] をクリックして、新しいキーを作成します。

• workspace_name：ワークスペース名 (例：`default`)。

• service_id：組み込みのサービス ID (例：`ops-embedding-dim-reduction-001`)。

リクエストパラメーター

ヘッダーパラメーター

API キー認証

パラメーター	型	必須	説明	例
Content-Type	String	はい	リクエストのフォーマット。`application/json` に設定します。	application/json
Authorization	String	はい	ご利用の API キー。	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	-	リクエストは成功です。
404	BadRequest.TaskNotExist	指定されたタスクは存在しません。
400	InvalidParameter	リクエストは無効です。
500	InternalServerError	内部サーバーエラーが発生しました。

エラーコードの完全なリストについては、「ステータスコード」をご参照ください。