Text & Chat

Embedding erstellen

Erstellt einen Embedding-Vektor, der den Eingabetext repräsentiert

POST
/v1/embeddings

Verwenden Sie GET /v1/models?recommended_for=embedding, um aktuelle Embedding-Modelle aufzulisten. Verwenden Sie ein Modell, in dessen Details die Operation embedding oder text-embedding aufgeführt ist. Ein Modell, das multimodal-embedding auflistet, gibt hier 400 unsupported_endpoint zurück; senden Sie dieses an Multimodale Embeddings erstellen.

Request-Body

Dieser Endpunkt gibt die Antwort zurück, sobald die Vektoren bereit sind. Setzen Sie bei großen Batches das Timeout Ihres HTTP-Clients auf mindestens 120s.

modelstringerforderlich

ID des zu verwendenden Embedding-Modells (z. B. text-embedding-3-small).

inputstring | arrayerforderlich

Einzubettender Text: ein String oder ein Array von Strings. Modelle, die Token-Eingaben unterstützen, akzeptieren auch number[] für eine einzelne Token-Sequenz oder number[][] für mehrere Sequenzen. Die Anzahl der Elemente, Tokens pro Element und Tokens pro Anfrage hängen vom Modell ab; lesen Sie diese über GET /v1/models/{model} aus.

encoding_formatstringStandard: float

Format für die Embeddings: float oder base64.

dimensionsinteger

Anzahl der Dimensionen jedes zurückgegebenen Vektors, eine positive Ganzzahl. Übergeben Sie diesen Parameter nur, wenn in den Modelldetails dimensions aufgeführt ist; das Maximum hängt vom Modell ab.

userstring

Eine eindeutige Kennung, die Ihren Endnutzer für das Missbrauchs-Monitoring repräsentiert.

Antwort

objectstring

Immer list.

dataarray

Array von Embedding-Objekten.

Jedes Objekt enthält:

  • object (string): embedding
  • index (integer): Index im Eingabe-Array
  • embedding (array | string): Ein numerischer Vektor für float oder ein Base64-String für base64.
modelstring

Verwendetes Modell.

usageobject

Token-Nutzung mit prompt_tokens und total_tokens.

Anfrage

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

Der Beispielvektor wurde aus Gründen der Lesbarkeit gekürzt.

Antwort

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

Fehler

StatusCodeUrsache
400invalid_requestEin Feld fehlt oder hat den falschen Typ. param gibt dieses an
400unsupported_endpointDas Modell ist für diesen Endpunkt nicht freigegeben
413Der Request-Body ist zu groß

Behandeln Sie andere Statuscodes wie in API-Fehler behandeln beschrieben.

Verwandte Schnittstellen

Verwenden Sie für Modelle, die multimodal-embedding auflisten, Multimodale Embeddings erstellen.

Autorisierung

BearerAuth
AuthorizationBearer <token>

API-Key-Authentifizierung. Erstellen oder verwalten Sie API-Keys unter Dashboard > API > API Keys.

Ort: header

Header

X-TokenLab-Delivery-Policy?string

Zustellungsrichtlinie pro Anfrage. Überschreibt die API-Key- und Workspace-Standardeinstellungen. Versucht automatisch zuerst TokenLab Verified und kann vor der Ausgabe, der Annahme der Anfrage oder der Erstellung persistenter Ressourcen einmalig auf Official umstellen.

Zulässige Werte

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

Anfragekörper

application/json

Antwort

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json