Texto

Criar Embedding

Cria um vetor de embedding representando o texto de entrada

POST
/v1/embeddings

Use GET /v1/models?recommended_for=embedding para listar os modelos de embedding atuais. Use um modelo cujos detalhes listem a operação embedding ou text-embedding. Um modelo que lista multimodal-embedding retorna 400 unsupported_endpoint aqui; envie-o para Criar Embeddings Multimodais.

Corpo da requisição

Este endpoint retorna após os vetores estarem prontos. Para lotes grandes, defina o timeout do seu cliente HTTP para pelo menos 120s.

modelstringobrigatório

ID do modelo de embedding a ser usado (por exemplo, text-embedding-3-small).

inputstring | arrayobrigatório

Texto a ser convertido em embedding: uma string ou um array de strings. Modelos que suportam entrada de tokens também aceitam number[] para uma sequência de tokens ou number[][] para múltiplas sequências. O número de itens, tokens por item e tokens por requisição dependem do modelo; consulte-os em GET /v1/models/{model}.

encoding_formatstringpadrão: float

Formato para os embeddings: float ou base64.

dimensionsinteger

Número de dimensões de cada vetor retornado, um número inteiro positivo. Envie-o apenas quando os detalhes do modelo listarem dimensions; o máximo depende do modelo.

userstring

Um identificador exclusivo que representa seu usuário final para monitoramento de abusos.

Resposta

objectstring

Sempre list.

dataarray

Array de objetos de embedding.

Cada objeto contém:

  • object (string): embedding
  • index (integer): Índice no array de entrada
  • embedding (array | string): Um vetor numérico para float, ou uma string Base64 para base64.
modelstring

Modelo utilizado.

usageobject

Uso de tokens com prompt_tokens e total_tokens.

Requisição

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

O vetor de exemplo foi encurtado para facilitar a leitura.

Resposta

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

Embeddings em lote

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

Erros

StatusCódigoCausa
400invalid_requestUm campo está ausente ou tem o tipo incorreto. param o identifica
400unsupported_endpointO modelo não está publicado para este endpoint
413O corpo da requisição é grande demais

Trate outros status conforme descrito em Tratar erros da API.

Interfaces relacionadas

Para modelos que listam multimodal-embedding, use Criar Embeddings Multimodais.

Autorização

BearerAuth
AuthorizationBearer <token>

Autenticação por Chave de API. Crie ou gerencie chaves de API em Dashboard > API > API Keys.

Local: header

Cabeçalhos

X-TokenLab-Delivery-Policy?string

Política de entrega por solicitação. Substitui os padrões da API key e do Workspace. Tenta automaticamente o TokenLab Verified primeiro e pode alternar uma vez para Official apenas antes da saída, aceitação da solicitação ou criação de recurso persistente.

Valores permitidos

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

Corpo da requisição

application/json

Resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json