Teks

Buat Embedding

Membuat vektor embedding yang merepresentasikan teks input

POST
/v1/embeddings

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.

modelstringwajib

ID model embedding yang akan digunakan (misalnya, text-embedding-3-small).

inputstring | arraywajib

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}.

encoding_formatstringbawaan: float

Format untuk embedding: float atau base64.

dimensionsinteger

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.

userstring

Pengenal unik yang merepresentasikan pengguna akhir (end-user) Anda untuk pemantauan penyalahgunaan.

Respons

objectstring

Selalu list.

dataarray

Array objek embedding.

Setiap objek berisi:

  • object (string): embedding
  • index (integer): Indeks dalam array input
  • embedding (array | string): Vektor numerik untuk float, atau string Base64 untuk base64.
modelstring

Model yang digunakan.

usageobject

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

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
  }
}

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

StatusCodePenyebab
400invalid_requestSebuah field tidak ada atau memiliki tipe yang salah. param menyebutkannya
400unsupported_endpointModel tidak dipublikasikan untuk endpoint ini
413Request 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
AuthorizationBearer <token>

Autentikasi API Key. Buat atau kelola API key di Dashboard > API > API Keys.

Lokasi: header

Header

X-TokenLab-Delivery-Policy?string

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