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

このドキュメントでは、OpenAI 互換のテキスト埋め込みサービスの API パラメーター構成について説明します。

URL

{host}/compatible-mode/v1/embeddings

host：サービスを呼び出すためのエンドポイント。インターネットまたは VPC 経由で API サービスを呼び出すことができます。詳細については、「サービスエンドポイントの照会」をご参照ください。

AI apikey截图.png

リクエストパラメータ

パラメータ

タイプ

必須

説明

値の例

model

String

はい

指定されたサービスID。

システムサービスIDは「ops-」で始まります。

サポートされているサービス ID の一覧については、「サポートされているサービスの一覧」をご参照ください。

ops-text-embedding-001

input

Array/String

はい

複数のテキスト入力をサポートし、リクエストごとに最大32個まで可能です。各入力の長さは、選択したモデルによって異なります。空の文字列は受け入れられません。

["科学技術は第一の生産力である", "OpenSearch製品ドキュメント"]

レスポンスパラメータ

パラメータ	タイプ	説明	値の例
data	List	データ情報を提供します。	-
data.embedding	Array[float]	埋め込み処理結果。ベクトルの配列を返します。	[ 0.003143, 0.009750, ... (ops-text-embedding-001の場合は合計1536個の浮動小数点数), -0.017395 ]
data.index	Int	リクエスト入力のインデックスに対応する序数。0から始まります。	0
data.object	String	静的な値「embedding」。	embedding
object	String	レスポンスタイプ。静的な値「list」。	list
model	String	リクエストで指定されたサービスID。	ops-text-embedding-001
usage	Object	このモデル呼び出しで使用されたトークンの統計情報。	-
usage.prompt_tokens	Int	ユーザーのリクエスト入力から生成されたトークンの数。	5
usage.total_tokens	Int	使用されたトークンの総数。usage.prompt_tokensとusage.completion_tokensの合計です。	5

CURL の例

curl http://xxxx-shanghai.opensearch.aliyuncs.com/compatible-mode/v1/chat/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer Your-API-Key" \
  -d '{
    "model": "ops-text-embedding-001",
    "input": "Search development platform"
  }'

レスポンスの例

{
  "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
          }
   }

ステータスコード

詳細については、AI Search Open Platform の「ステータスコードの説明」をご参照ください。