Teks
Buat Embedding
Membuat vektor embedding yang merepresentasikan teks input
Gunakan GET /v1/models?recommended_for=embedding untuk melihat daftar model embedding saat ini. Gunakan model yang detailnya mencantumkan operasi embedding atau text-embedding. Model yang mencantumkan multimodal-embedding akan mengembalikan 400 unsupported_endpoint di sini; kirimkan ke Buat Embedding Multimodal.
Body Permintaan
Endpoint ini mengembalikan respons setelah vektor siap. Untuk batch besar, atur timeout HTTP client Anda setidaknya ke 120s.
ID model embedding yang akan digunakan (misalnya, text-embedding-3-small).
Teks yang akan di-embed: sebuah string atau array string. Model yang mendukung input token juga menerima number[] untuk satu urutan token atau number[][] untuk beberapa urutan. Jumlah item, token per item, dan token per request bergantung pada model; baca detailnya di GET /v1/models/{model}.
floatFormat untuk embedding: float atau base64.
Jumlah dimensi dari setiap vektor yang dikembalikan, berupa bilangan bulat positif. Kirimkan parameter ini hanya jika detail model mencantumkan dimensions; nilai maksimum bergantung pada model.
Pengenal unik yang merepresentasikan pengguna akhir (end-user) Anda untuk pemantauan penyalahgunaan.
Respons
Selalu list.
Array objek embedding.
Setiap objek berisi:
object(string):embeddingindex(integer): Indeks dalam array inputembedding(array | string): Vektor numerik untukfloat, atau string Base64 untukbase64.
Model yang digunakan.
Penggunaan token dengan prompt_tokens dan total_tokens.
Permintaan
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"
}'Contoh vektor dipersingkat untuk kemudahan membaca.
Respons
{
"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 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")Error
| Status | Code | Penyebab |
|---|---|---|
400 | invalid_request | Sebuah field tidak ada atau memiliki tipe yang salah. param menyebutkannya |
400 | unsupported_endpoint | Model tidak dipublikasikan untuk endpoint ini |
413 | Request body terlalu besar |
Tangani status lainnya seperti dalam Menangani error API.
Antarmuka terkait
Untuk model yang mencantumkan multimodal-embedding, gunakan Buat Embedding Multimodal.
Otorisasi
BearerAuth Autentikasi API Key. Buat atau kelola API key di Dashboard > API > API Keys.
Lokasi: header
Header
Kebijakan Pengiriman per-permintaan. Menggantikan default API key dan Workspace. Secara otomatis mencoba TokenLab Verified terlebih dahulu dan dapat beralih satu kali ke Official saja sebelum output, penerimaan permintaan, atau pembuatan sumber daya persisten.
Nilai yang tersedia
- "auto"
- "verified"
- "official"
Body permintaan
application/json
Respons
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json