OpenAI Embeddings

OpenAI Embeddings convertit une entrée ou un lot d’entrées en représentations vectorielles pour la recherche sémantique, le clustering, les recommandations et la recherche vectorielle. Les limites d’entrée, les dimensions de sortie et l’application des paramètres facultatifs dépendent du modèle d’embedding sélectionné.

POST/v1/embeddings

Crée une représentation vectorielle des entrées fournies pour la recherche sémantique, le clustering, les recommandations et d’autres usages de recherche vectorielle. L’interface accepte un texte, un lot de textes, un tableau de tokens ou un lot de tableaux de tokens.

Les limites d’entrée et les dimensions de sortie dépendent du modèle sélectionné. Par exemple, text-embedding-ada-002 produit des vecteurs de 1536 dimensions et accepte au maximum 8192 tokens en entrée ; d’autres modèles peuvent avoir des limites différentes.

Authentification

bearerAuth

AuthentificationBearer <token>

Utilisez Bearer your-api-key dans le Header Authorization.

Emplacement: header

Corps de requête

Choisissez la structure textuelle selon le nombre d’entrées ; les deux vues utilisent le même endpoint Embeddings.

application/json

Texte unique

Convertit une chaîne non vide en vecteur d’embedding, pour tester un élément ou effectuer une recherche en temps réel.

model: ID d’un modèle d’embedding visible pour la clé API actuelle.
input: Chaîne non vide unique à convertir en vecteur.
encoding_format: Format d’encodage du vecteur ; float est utilisé par défaut.

application/json

{
  "model": "MODEL_ID",
  "input": "La nourriture de ce restaurant est délicieuse et le serveur est aimable.",
  "encoding_format": "float"
}

model*string

ID du modèle à utiliser. Indiquez l’ID d’un modèle d’embedding disponible pour le compte actuel.

Longueur1 <= length

input*|array<>|array<integer>|array<array<integer>>

Entrée à convertir en vecteurs. Vous pouvez fournir un texte unique, un tableau de textes, un tableau d’entiers représentant des tokens ou un lot de tableaux de tokens. L’entrée ne doit pas être vide ; la taille du lot, le nombre total de tokens et la limite par élément dépendent du modèle sélectionné.

encoding_format?string

Format d’encodage des vecteurs d’embedding renvoyés.

Valeur par défaut"float"

Valeurs autorisées

"float"
"base64"

dimensions?integer

Dimensions souhaitées pour les vecteurs de sortie. Seuls certains modèles d’embedding récents acceptent ce paramètre.

Plage1 <= value

user?string

Identifiant unique de l’utilisateur final, utilisable pour surveiller et détecter les abus.

Longueur1 <= length

Les tableaux de tokens et les lots de tableaux de tokens restent disponibles dans la référence complète des champs ; le nombre d’entrées, leur longueur et les dimensions des vecteurs dépendent des limites du modèle sélectionné.

Corps de réponse

`application/json`

curl -X POST "https://example.com/v1/embeddings" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "input": "La nourriture était délicieuse et le serveur aimable.",    "encoding_format": "float"  }'

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        -0.0028842222
      ],
      "index": 0
    }
  ],
  "model": "MODEL_ID",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Authentification

Corps de requête

Corps de réponse

200application/json

400application/json

401application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`