Texto

Crear Embedding

Crea un vector de embedding que representa el texto de entrada

POST
/v1/embeddings

Utilice GET /v1/models?recommended_for=embedding para listar los modelos de embedding actuales. Utilice un modelo en cuyos detalles figure la operación embedding o text-embedding. Un modelo que indique multimodal-embedding devolverá 400 unsupported_endpoint aquí; envíelo a Crear embeddings multimodales.

Cuerpo de la solicitud

Este endpoint responde una vez que los vectores están listos. Para lotes grandes, configure el tiempo de espera de su cliente HTTP en al menos 120s.

modelstringobligatorio

ID del modelo de embedding a utilizar (por ejemplo, text-embedding-3-small).

inputstring | arrayobligatorio

Texto para generar el embedding: una cadena o un array de cadenas. Los modelos que admiten entrada de tokens también aceptan number[] para una secuencia de tokens o number[][] para múltiples secuencias. La cantidad de elementos, tokens por elemento y tokens por solicitud dependen del modelo; consúltelos en GET /v1/models/{model}.

encoding_formatstringpredeterminado: float

Formato de los embeddings: float o base64.

dimensionsinteger

Número de dimensiones de cada vector devuelto, un número entero positivo. Envíelo únicamente cuando los detalles del modelo listen dimensions; el máximo depende del modelo.

userstring

Un identificador único que representa a su usuario final para el monitoreo de abusos.

Respuesta

objectstring

Siempre list.

dataarray

Array de objetos de embedding.

Cada objeto contiene:

  • object (string): embedding
  • index (integer): Índice en el array de entrada
  • embedding (array | string): Un vector numérico para float, o una cadena Base64 para base64.
modelstring

Modelo utilizado.

usageobject

Uso de tokens con prompt_tokens y total_tokens.

Solicitud

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

El vector de ejemplo se ha acortado para facilitar la lectura.

Respuesta

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 por lotes

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

Errores

EstadoCódigoCausa
400invalid_requestFalta un campo o tiene un tipo incorrecto. param indica cuál
400unsupported_endpointEl modelo no está publicado para este endpoint
413El cuerpo de la solicitud es demasiado grande

Gestione otros estados como se describe en Gestionar errores de la API.

Interfaces relacionadas

Para los modelos que listen multimodal-embedding, utilice Crear embeddings multimodales.

Autorización

BearerAuth
AuthorizationBearer <token>

Autenticación con API Key. Cree o gestione API keys en Dashboard > API > API Keys.

Ubicación: header

Encabezados

X-TokenLab-Delivery-Policy?string

Política de entrega por solicitud. Sustituye los valores predeterminados de la API key y del Workspace. Auto intenta primero con TokenLab Verified y puede cambiar una vez a Official solo antes de la salida, la aceptación de la solicitud o la creación de recursos persistentes.

Valores permitidos

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

Cuerpo de la solicitud

application/json

Respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json