TokenLab

Văn bản

Tạo Embedding

Tạo một vector embedding đại diện cho văn bản đầu vào

POST
/v1/embeddings

Sử dụng GET /v1/models?recommended_for=embedding để liệt kê các model embedding hiện tại. Sử dụng model có thông tin chi tiết liệt kê thao tác embedding hoặc text-embedding. Model liệt kê multimodal-embedding sẽ trả về 400 unsupported_endpoint tại đây; hãy gửi yêu cầu tới Tạo Multimodal Embedding.

Phần thân yêu cầu (Request Body)

Endpoint này sẽ trả về sau khi các vector đã sẵn sàng. Đối với các batch lớn, hãy đặt timeout cho HTTP client của bạn tối thiểu là 120s.

modelstringbắt buộc

ID của model embedding cần sử dụng (ví dụ: text-embedding-3-small).

inputstring | arraybắt buộc

Văn bản cần tạo embedding: một chuỗi hoặc một mảng các chuỗi. Các model hỗ trợ đầu vào dạng token cũng chấp nhận number[] cho một chuỗi token hoặc number[][] cho nhiều chuỗi token. Số lượng mục, số token trên mỗi mục và số token trên mỗi request phụ thuộc vào model; xem chi tiết tại GET /v1/models/{model}.

encoding_formatstringmặc định: float

Định dạng cho các embedding: float hoặc base64.

dimensionsinteger

Số chiều của mỗi vector được trả về, là một số nguyên dương. Chỉ gửi tham số này khi thông tin chi tiết của model có liệt kê dimensions; giá trị tối đa phụ thuộc vào model.

userstring

Một định danh duy nhất đại diện cho người dùng cuối của bạn nhằm mục đích theo dõi lạm dụng.

Phản hồi

objectstring

Luôn là list.

dataarray

Mảng các đối tượng embedding.

Mỗi đối tượng bao gồm:

  • object (string): embedding
  • index (integer): Vị trí chỉ mục trong mảng đầu vào
  • embedding (array | string): Một vector số đối với float, hoặc một chuỗi Base64 đối với base64.
modelstring

Model được sử dụng.

usageobject

Mức sử dụng token với prompt_tokens và total_tokens.

Yêu cầu

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

Vector mẫu đã được rút gọn để dễ đọc hơn.

Phản hồi

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 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")

Lỗi

Trạng tháiMãNguyên nhân
400invalid_requestThiếu một trường hoặc trường có kiểu dữ liệu sai. param sẽ nêu rõ tên trường
400unsupported_endpointModel chưa được hỗ trợ cho endpoint này
413Request body quá lớn

Xử lý các trạng thái khác như hướng dẫn trong Xử lý lỗi API.

Giao diện liên quan

Đối với các model liệt kê multimodal-embedding, hãy sử dụng Tạo Multimodal Embedding.

Xác thực

BearerAuth
AuthorizationBearer <token>

Xác thực bằng Khóa API. Tạo hoặc quản lý khóa API trong Dashboard > API > API Keys.

Vị trí: header

Header

X-TokenLab-Delivery-Policy?string

Chính sách phân phối theo yêu cầu. Ghi đè các mặc định của API key và Workspace. Tự động thử TokenLab Verified trước và có thể chuyển đổi một lần sang Official chỉ trước khi xuất, chấp nhận yêu cầu hoặc tạo tài nguyên cố định.

Giá trị hợp lệ

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

Nội dung yêu cầu

application/json

Phản hồi

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json