Format d'intégration OpenAI

📝Présentation

Obtenez des représentations vectorielles d'un texte d'entrée donné qui peuvent être facilement utilisées par les modèles et algorithmes d'apprentissage automatique. Pour les guides associés, voir [Guide des intégrations] (https://platform.openai.com/docs/guides/embeddings).

Remarques importantes:

• Certains modèles peuvent avoir des limites sur le nombre total de jetons en entrée

• Vous pouvez utiliser exemple de code Python pour calculer le nombre de jetons

• Par exemple: le modèle text-embedding-ada-002 génère des vecteurs avec 1536 dimensions

💡 Exemples de requêtes

Créer des intégrations de texte ✅

curl https://88api.ai/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "input": "The food was delicious and the waiter...",
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

Response Example:

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255, -0.009327292,
        // ... (1536 floating point numbers for ada-002)
        -0.0028842222
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Créer des intégrations par lots ✅

curl https://88api.ai/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "input": ["The food was delicious", "The waiter was friendly"],
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

Response Example:

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255
        // ... (1536 floating point numbers)
      ],
      "index": 0
    },
    {
      "object": "embedding",
      "embedding": [
        -0.008815289
        // ... (1536 floating point numbers)
      ],
      "index": 1
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 12,
    "total_tokens": 12
  }
}

📮 Demande

Point de terminaison

POST /v1/embeddings

Créez des vecteurs d'intégration qui représentent le texte saisi.

Méthode d'authentification

Incluez les éléments suivants dans l'en-tête de la demande pour l'authentification par clé API:

Authorization: Bearer $API_KEY

Où $API_KEY est votre clé API.

Paramètres du corps de la requête

input

• Type : Chaîne ou tableau
• Obligatoire : Oui

Le texte d’entrée à intégrer, codé sous forme de chaîne ou de tableau de jetons. Pour intégrer plusieurs entrées dans une seule requête, transmettez un tableau de chaînes ou un tableau de tableaux de jetons. L'entrée ne doit pas dépasser le nombre maximum de jetons d'entrée du modèle (8 192 jetons pour text-embedding-ada-002), ne peut pas être une chaîne vide et tout tableau doit avoir des dimensions inférieures ou égales à 2 048.

model

• Type : Chaîne
• Obligatoire : Oui

L'ID du modèle à utiliser. Vous pouvez utiliser l'API List models pour voir tous les modèles disponibles ou consulter la présentation des modèles pour leurs descriptions.

encoding_format

• Type : Chaîne
• Obligatoire: Non
• Par défaut: flottant

Le format dans lequel renvoyer les intégrations. Peut être float ou base64.

dimensions

• Type : Entier
• Obligatoire: Non

Le nombre de dimensions que les intégrations de sortie générées doivent avoir. Uniquement pris en charge dans les modèles text-embedding-3 et plus récents.

user

• Type : Chaîne
• Obligatoire: Non

Un identifiant unique représentant votre utilisateur final, qui peut aider OpenAI à surveiller et détecter les abus. En savoir plus.

📥 Réponse

Réponse réussie

Renvoie une liste d'objets incorporés.

object

• Type : Chaîne
• Description: Type d'objet, la valeur est "liste"

data

• Type : Tableau
• Description: Tableau contenant des objets intégrés
• Propriétés:
• object: Type d'objet, la valeur est "embedding"
• embedding : Vecteur d'intégration, liste de nombres à virgule flottante. La longueur du vecteur dépend du modèle
• index : Index de l'intégration dans la liste

model

• Type : Chaîne
• Description : Nom du modèle utilisé

usage

• Type : Objet
• Description: statistiques d'utilisation des jetons
• Propriétés:
• prompt_tokens: Nombre de jetons utilisés pour l'invite
• total_tokens : Nombre total de jetons

Incorporation d'un objet

Représente un vecteur d'intégration renvoyé par le point de terminaison d'intégration.

{
  "object": "embedding",
  "embedding": [
    0.0023064255, -0.009327292,
    // ... (1536 floating point numbers total for ada-002)
    -0.0028842222
  ],
  "index": 0
}

index

• Type : Entier
• Description : Index de l'intégration dans la liste

embedding

• Type : Tableau
• Description : Vecteur d'intégration, liste de nombres à virgule flottante. La longueur du vecteur dépend du modèle, voir le guide des intégrations pour plus de détails

object

• Type : Chaîne
• Description: Type d'objet, toujours "incorporant"

Réponse d'erreur

En cas de problèmes avec la requête, l'API renvoie un objet de réponse d'erreur avec des codes d'état HTTP compris entre 4XX et 5XX.

Codes d'état d'erreur courants

• 401 Unauthorized: Clé API invalide ou manquante
• 400 Bad Request: paramètres de requête non valides, tels qu'une entrée vide ou un dépassement des limites de jetons
• 429 Too Many Requests: limite d'appels API dépassée
• 500 Internal Server Error: Erreur interne du serveur

Exemple de réponse d'erreur:

{
  "error": {
    "message": "The input exceeds the maximum length. Please reduce the length of your input.",
    "type": "invalid_request_error",
    "param": "input",
    "code": "context_length_exceeded"
  }
}