テキスト
Create Embedding
入力テキストを表す埋め込み(Embedding)ベクトルを作成します
現在の埋め込みモデルを一覧取得するには、GET /v1/models?recommended_for=embedding を使用します。詳細に embedding または text-embedding オペレーションが記載されているモデルを使用してください。multimodal-embedding が記載されているモデルは、ここでは 400 unsupported_endpoint を返します。マルチモーダル Embedding の作成 にリクエストを送信してください。
リクエストボディ
このエンドポイントは、ベクトルの準備が完了した後にレスポンスを返します。大規模なバッチ処理の場合は、HTTPクライアントのタイムアウトを少なくとも 120s に設定してください。
使用する埋め込みモデルのID(例: text-embedding-3-small)。
埋め込むテキスト: 文字列または文字列の配列。トークン入力をサポートするモデルは、1つのトークンシーケンスに対して number[] を、複数のシーケンスに対して number[][] を受け付けることもできます。アイテム数、アイテムあたりのトークン数、リクエストあたりのトークン数はモデルによって異なります。GET /v1/models/{model} で確認してください。
float埋め込みのフォーマット: float または base64。
返される各ベクトルの次元数(正の整数)。モデルの詳細に dimensions が記載されている場合にのみ送信してください。最大値はモデルによって異なります。
不正利用の監視を目的とした、エンドユーザーを表す一意の識別子。
レスポンス
常に list。
埋め込みオブジェクトの配列。
各オブジェクトには以下が含まれます:
object(string):embeddingindex(integer): 入力配列内のインデックスembedding(array | string):floatの場合は数値ベクトル、base64の場合は Base64 文字列。
使用されたモデル。
prompt_tokens および total_tokens を含むトークン使用量。
リクエスト
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"
}'サンプルのベクトルは、読みやすさのために省略されています。
レスポンス
{
"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
}
}Batch 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")Errors
| ステータス | コード | 原因 |
|---|---|---|
400 | invalid_request | フィールドが欠落しているか、型が正しくありません。param にその名前が示されます |
400 | unsupported_endpoint | このモデルはこのエンドポイント向けに公開されていません |
413 | リクエストボディが大きすぎます |
その他のステータスの処理方法については、APIエラーの処理を参照してください。
関連インターフェース
multimodal-embedding が記載されているモデルについては、マルチモーダル Embedding の作成 を使用してください。
認証
BearerAuth APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。
場所: header
ヘッダー
リクエストごとの配信ポリシー。APIキーおよびWorkspaceのデフォルト設定を上書きします。自動的にまず TokenLab Verified を試行し、出力、リクエストの受け入れ、または永続的なリソース作成の前に、一度だけ Official に切り替える場合があります。
指定できる値
- "auto"
- "verified"
- "official"
リクエストボディ
application/json
レスポンス
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json