埋め込み (Embeddings)

テキストまたはトークンIDを入力とする OpenAI 埋め込み API。単一入力とバッチ入力に対応します。

埋め込みを作成する

model には、お使いのキーで利用できる埋め込みモデルを指定します(GET /v1/models で確認できます)。OpenAI の対象モデルは text-embedding-3-small、text-embedding-3-large、text-embedding-ada-002 です。結果と入力の対応は data[].index で照合してください。/api/v1/embeddings も同じルートに中継されます。

POST/v1/embeddings
curl https://api.experientiallabs.ai/v1/embeddings \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "text-embedding-3-small", "input": ["first document", "second document"]}'

リクエストフィールド

未知のフィールドは無視されず、拒否されます。

フィールド仕様
model必須。埋め込みモデルを指定します(チャットモデルは 400 unsupported_capability)
input必須。空でない文字列、空でない文字列のリスト、トークンID配列(ベクトル1件)、またはトークンID配列のリスト(バッチ)。テキストとトークンの混在、空の要素、負のID、浮動小数点数、真偽値は使用できません
dimensions任意。対応モデルのみ(text-embedding-3-* は対応、ada-002 は非対応)
encoding_formatfloat(生の HTTP での既定値)または base64。OpenAI Python SDK は base64 を要求し、自動でデコードします
stream省略するか false。true は非対応です
user任意。最大 1,024 文字。上流には転送されません

トークンIDはモデルのトークナイザーと一致している必要があります。そのまま転送されます。

import tiktoken

enc = tiktoken.encoding_for_model("text-embedding-3-small")
batches = [enc.encode(t) for t in ["A short document.", "A second document."]]
r = client.embeddings.create(model="text-embedding-3-small", input=batches)

請求、リトライ、キャッシュ

プロバイダーが報告した入力トークン数で請求されます(usage.prompt_tokens は total_tokens と等しくなります)。出力トークンはありません。BYOK の場合はお客様のプロバイダーから請求されます。レスポンスキャッシュはなく、Idempotency-Key も適用されません。同じリクエストを繰り返すと再度課金される可能性があるため、ベクトルはお客様側で保存し、リトライは意図的に行ってください(例では SDK のリトライを 0 に設定しています)。エラー:400 invalid_parameter(param を修正)、400 unsupported_parameter(フィールドを削除)。

from langchain_openai import OpenAIEmbeddings

emb = OpenAIEmbeddings(
    model="text-embedding-3-small",
    base_url="https://api.experientiallabs.ai/v1",
    api_key="YOUR_API_KEY",
)
vectors = emb.embed_documents(["A small example.", "A second document."])