OpenAI 互換テキスト埋め込み - OpenSearch - Alibaba Cloud ドキュメントセンター

OpenSearch 互換モードの埋め込みサービスを使用して、1 つ以上のテキスト入力に対するベクター埋め込みを生成します。

エンドポイント

POST {host}/compatible-mode/v1/embeddings

host：サービスのエンドポイントです。このサービスはインターネットまたは仮想プライベートクラウド (VPC) 経由でアクセス可能です。エンドポイントの確認方法については、「サービスエンドポイントの照会」をご参照ください。

リクエストパラメーター

パラメーター	型	必須	説明	例
`model`	文字列	はい	使用するサービス ID です。システムサービス ID は `ops-` で始まります。対応するサービス ID の一覧については、「対応サービス一覧」をご参照ください。	`ops-text-embedding-001`
`input`	配列／文字列	はい	埋め込み対象のテキストです。単一の文字列または文字列の配列を指定できます。1 回のリクエストあたり最大 32 個の入力が可能です。各入力の最大長は選択したモデルによって異なります。空文字列は許可されません。	`["科学技術は第一の生産力である", "OpenSearch プロダクトドキュメント"]`

応答パラメーター

パラメーター	型	説明	例
`data`	リスト	埋め込み結果です。	—
`data.embedding`	浮動小数点数の配列	対応するインデックス位置にある入力に対する埋め込みベクターです。`ops-text-embedding-001` では、1536 個の浮動小数点数が返されます。	`[0.003143, 0.009750, ..., -0.017395]`
`data.index`	整数	リクエスト入力配列内でのこの結果の位置。 `0` から始まります。	`0`
`data.object`	文字列	オブジェクトタイプです。常に `embedding` です。	`embedding`
`object`	文字列	応答タイプです。常に `list` です。	`list`
`model`	文字列	リクエストで指定されたサービス ID です。	`ops-text-embedding-001`
`usage`	オブジェクト	このリクエストにおけるトークン使用量の統計情報です。	—
`usage.prompt_tokens`	整数	リクエスト入力内のトークン数です。	`5`
`usage.total_tokens`	整数	使用されたトークン総数です（`usage.prompt_tokens` ＋ `usage.completion_tokens`）。	`5`

実行例

リクエスト

curl http://xxxx-shanghai.opensearch.aliyuncs.com/compatible-mode/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-key>" \
  -d '{
    "model": "ops-text-embedding-001",
    "input": "検索開発プラットフォーム"
  }'

応答

{
  "id": "9085118afe14bee71d59c4a609fcf7c0",
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0021381378173828125,
        0.12109375,
        ...,
        -0.0389404296875
      ],
      "index": 0
    }
  ],
  "model": "ops-text-embedding-001",
  "usage": {
    "prompt_tokens": 5,
    "total_tokens": 5
  }
}

状態コード

状態コードの説明については、「状態コードの説明」をご参照ください。