OpenAI Embeddings
OpenAI 互換のテキスト埋め込みベクトルを作成します。
OpenAI Embeddings API は、単一または複数の入力をベクトル表現に変換します。セマンティック検索、クラスタリング、レコメンド、ベクトル検索などに利用できます。入力の上限、出力次元、オプションパラメーターの対応状況は、選択した Embedding モデルによって異なります。
POST
/v1/embeddings指定した入力のベクトル表現を作成します。セマンティック検索、クラスタリング、レコメンドなどのベクトル検索用途に利用できます。単一テキスト、複数テキスト、Token 配列、複数の Token 配列に対応します。
入力上限と出力次元は選択したモデルによって異なります。たとえば text-embedding-ada-002 は 1536 次元のベクトルを出力し、最大入力は 8192 Token です。その他のモデルでは制限が異なる場合があります。
認証
bearerAuth 認証Bearer <token>
Authorization Header に Bearer your-api-key を指定します。
指定位置: header
リクエストボディ
入力数に応じてテキスト構造を選択します。どちらの表示も同じ Embeddings エンドポイントを使用します。
application/json単一テキスト
1 つの空でない文字列を埋め込みベクトルに変換します。単一項目のテストやリアルタイム検索に適しています。
- model
- 現在の API キーで利用できる Embedding モデル ID です。
- input
- ベクトルに変換する 1 つの空でない文字列です。
- encoding_format
- ベクトルのエンコード形式です。既定値は float です。
{
"model": "MODEL_ID",
"input": "料理はおいしく、スタッフも親切でした。",
"encoding_format": "float"
}完全なフィールドリファレンステキストとトークンの単一入力および一括入力の構造を確認できます。
トークン配列とトークン配列の一括入力も完全なフィールドリファレンスで確認できます。入力数、長さ、ベクトル次元は選択したモデルの制限に従います。
レスポンスボディ
application/json
application/json
application/json
application/json
application/json