Texte
Créer un embedding
Crée un vecteur d'embedding représentant le texte d'entrée
Utilisez GET /v1/models?recommended_for=embedding pour lister les modèles d'embedding actuels. Utilisez un modèle dont les détails mentionnent l'opération embedding ou text-embedding. Un modèle qui indique multimodal-embedding renvoie 400 unsupported_endpoint ici ; envoyez-le à Créer des embeddings multimodaux.
Corps de la requête
Ce point de terminaison renvoie une réponse lorsque les vecteurs sont prêts. Pour les lots volumineux, définissez le délai d'expiration (timeout) de votre client HTTP sur au moins 120s.
ID du modèle d'embedding à utiliser (par ex., text-embedding-3-small).
Texte à vectoriser : une chaîne ou un tableau de chaînes. Les modèles prenant en charge les tokens en entrée acceptent également number[] pour une séquence de tokens ou number[][] pour plusieurs séquences. Le nombre d'éléments, de tokens par élément et de tokens par requête dépendent du modèle ; consultez-les dans GET /v1/models/{model}.
floatFormat des embeddings : float ou base64.
Nombre de dimensions de chaque vecteur retourné, un entier positif. Envoyez-le uniquement lorsque les détails du modèle mentionnent dimensions ; le maximum dépend du modèle.
Un identifiant unique représentant votre utilisateur final pour la surveillance des abus.
Réponse
Toujours list.
Tableau d'objets d'embedding.
Chaque objet contient :
object(string) :embeddingindex(integer) : Index dans le tableau d'entréeembedding(array | string) : Un vecteur numérique pourfloat, ou une chaîne Base64 pourbase64.
Modèle utilisé.
Utilisation des tokens avec prompt_tokens et total_tokens.
Requête
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"
}'Le vecteur d'exemple est raccourci pour des raisons de lisibilité.
Réponse
{
"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 par lot
# 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")Erreurs
| Statut | Code | Cause |
|---|---|---|
400 | invalid_request | Un champ est manquant ou a un type incorrect. param le spécifie |
400 | unsupported_endpoint | Le modèle n'est pas publié pour ce point de terminaison |
413 | Le corps de la requête est trop volumineux |
Gérez les autres statuts comme indiqué dans Gérer les erreurs d'API.
Interfaces associées
Pour les modèles qui mentionnent multimodal-embedding, utilisez Créer des embeddings multimodaux.
Autorisation
BearerAuth Authentification par clé API. Créez ou gérez vos clés API dans Dashboard > API > API Keys.
Emplacement: header
En-têtes
Politique de livraison par requête. Remplace les valeurs par défaut de la clé API et de l'espace de travail. Tente automatiquement TokenLab Verified en premier et peut basculer une fois vers Official uniquement avant la sortie, l'acceptation de la requête ou la création de ressource persistante.
Valeurs possibles
- "auto"
- "verified"
- "official"
Corps de la requête
application/json
Réponse
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json