文字
建立 Embedding
建立代表輸入文字的 embedding 向量
使用 GET /v1/models?recommended_for=embedding 列出目前的 embedding 模型。請使用詳細資訊中列出 embedding 或 text-embedding 操作的模型。若模型列出 multimodal-embedding,在此處將會傳回 400 unsupported_endpoint;請改將其傳送至 建立多模態 Embedding。
請求主體
此端點會在向量準備就緒後傳回。對於大型批次,請將您的 HTTP 客戶端逾時時間設定為至少 120s。
要使用的 embedding 模型 ID(例如 text-embedding-3-small)。
要進行 embedding 的文字:字串或字串陣列。支援 token 輸入的模型也接受單一 token 序列的 number[],或多個序列的 number[][]。項目數量、每個項目的 token 數以及每個請求的 token 數取決於模型;可於 GET /v1/models/{model} 查看。
floatEmbedding 的格式:float 或 base64。
每個傳回向量的維度數量,為正整數。僅在模型詳細資訊中列出 dimensions 時才傳送此參數;最大值取決於模型。
代表您終端使用者的唯一識別碼,用於濫用監控。
回應
固定為 list。
Embedding 物件陣列。
每個物件包含:
object(string):embeddingindex(integer):輸入陣列中的索引embedding(array | string):若為float則為數值向量,若為base64則為 Base64 字串。
所使用的模型。
Token 使用量,包含 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
}
}批次 Embedding
# 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")錯誤
| 狀態 | 代碼 | 原因 |
|---|---|---|
400 | invalid_request | 欄位遺失或類型錯誤。param 會指出該欄位名稱 |
400 | unsupported_endpoint | 該模型未針對此端點發布 |
413 | 請求主體過大 |
其他狀態的處理方式請參閱 處理 API 錯誤。
相關介面
對於列出 multimodal-embedding 的模型,請使用 建立多模態 Embedding。
授權
BearerAuth API Key 驗證。請在 Dashboard > API > API Keys 建立或管理 API 金鑰。
位置: header
請求標頭
單次請求傳遞策略。會覆寫 API key 與 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