テキスト

Embedding を作成

入力テキストを表現する embedding ベクトルを作成します

POST
/v1/embeddings

リクエストボディ

入力が大きい場合、HTTP クライアントのタイムアウトを少なくとも 120s に設定してください。処理完了後にレスポンスを返します。

modelstring必須

使用する embedding モデルの ID(例: text-embedding-3-small)。

inputstring | array必須

入力は文字列または文字列の配列です。トークン入力に対応するモデルでは、単一のトークン列に number[]、複数の列に number[][] も指定できます。

encoding_formatstringデフォルト: float

embeddings の形式: float または base64。

dimensionsinteger

出力の次元数(モデル固有)。

userstring

不正使用の監視のためにエンドユーザーを表す一意の識別子。

利用可能なモデル

GET /v1/models?recommended_for=embedding で現在のモデルと次元数を確認できます。

レスポンス

objectstring

常に list です。

dataarray

embedding オブジェクトの配列。

各オブジェクトには以下が含まれます:

  • object (string): embedding
  • index (integer): 入力配列内のインデックス
  • embedding (array | string): float は数値ベクトル、base64 は Base64 文字列を返します。
modelstring

使用されたモデル。

usageobject

prompt_tokens および total_tokens を含む token 使用量。

リクエスト

curl -X POST "https://api.tokenlab.sh/v1/embeddings" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "text-embedding-3-small",
    "input": "The quick brown fox jumps over the lazy dog"
  }'

読みやすくするため、例のベクトルは短縮しています。

レスポンス

Response
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [0.0023, -0.0194, 0.0081]
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 9,
    "total_tokens": 9
  }
}

バッチ Embeddings

# Embed multiple texts at once
response = client.embeddings.create(
    model="text-embedding-3-small",
    input=[
        "First document text",
        "Second document text",
        "Third document text"
    ]
)

for i, data in enumerate(response.data):
    print(f"Document {i}: {len(data.embedding)} dimensions")

認証

BearerAuth
AuthorizationBearer <token>

APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。

場所: header

ヘッダー

X-TokenLab-Delivery-Policy?string

リクエストごとの配信ポリシー。APIキーおよびWorkspaceのデフォルト設定を上書きします。自動的にまず TokenLab Verified を試行し、出力、リクエストの受け入れ、または永続的なリソース作成の前に、一度だけ Official に切り替える場合があります。

指定できる値

  • "auto"
  • "verified"
  • "official"

リクエストボディ

application/json

レスポンス

application/json

application/json

application/json

application/json

application/json

application/json

application/json