Créer une complétion de chat

Étant donné une liste de messages comprenant une conversation, le modèle fourni renvoie une réponse appropriée.

Pour plus de détails, consultez la section Créer une documentation de discussion dans la référence de l'API OpenAI et le guide de l'API Chat Completions associé.

Entrée

Champ Définition Type Obligatoire

Modèle

L'identificateur du modèle à utiliser.

Consultez le tableau de compatibilité des points de terminaison de modèle pour savoir quels modèles fonctionnent avec l'API Chat.

Liste déroulante TRUE

Messages

Une liste des messages qui constituent la conversation.

Liste d'objets TRUE

Température

La température d'échantillonnage à utiliser pour la sortie.

Les valeurs peuvent être de 0 à 2. La valeur par défaut est 1.

Des valeurs plus élevées comme 0.8 rendent la sortie plus aléatoire, tandis que des valeurs plus faibles comme 0,20.2 la rendent plus ciblée et déterministe.

Okta recommande généralement de modifier cette entrée ou Haut P, mais pas les deux.

Nombre FALSE

Haut P

Une solution de rechange à l'échantillonnage par température, appelée échantillonnage nucléaire.

Le modèle prend en compte les résultats des jetons dont la masse de probabilité correspond au Haut P.

Une valeur de 0.1 signifie que seuls les jetons comprenant les 10 % supérieurs de la masse de probabilité sont pris en compte. La valeur par défaut est 1.

Okta recommande généralement de modifier cette entrée ou la température, mais pas les deux.

Nombre FALSE

N

Nombre de choix de complétion de discussion à générer pour chaque message d'entrée.

La valeur par défaut est 1.

Nombre FALSE

Arrêter

Vous pouvez spécifier jusqu'à quatre séquences de texte qui indiquent à l'API d'arrêter de générer d'autres jetons. Consultez la section Comment utiliser les séquences d'arrêt ?

La complétion de discussion renvoyée ne contient pas la séquence stop.

Texte

FALSE

Jetons maximum

Le nombre maximal de jetons à générer dans la complétion de discussion.

Consultez la section Tokenizer.

Nombre FALSE

Pénalité de présence

Un nombre de -2.0 à 2.0.

Les valeurs positives pénalisent les nouveaux jetons selon qu'ils figurent déjà ou non dans le texte, augmentant ainsi la probabilité que le modèle aborde de nouveaux sujets.

Nombre FALSE

Pénalité de fréquence

Un nombre de -2.0 à 2.0.

Les valeurs positives pénalisent les nouveaux jetons selon qu'ils figurent déjà ou non dans le texte, diminuant ainsi la probabilité que le modèle répète la même ligne.

Nombre FALSE

Utilisateur

Un identificateur unique représentant votre utilisateur final.

OpenAI peut utiliser cet ID pour surveiller et détecter les abus. Consultez la section Bonnes pratiques en matière de sécurité.

Texte

FALSE

Sortie

Champ Définition Type

Modèle

Le modèle utilisé dans l'achèvement du chat.

Texte

ID

Un identificateur unique pour le bloc d'achèvement du chat

Texte

Objet

Le type d'objet. Il s'agit toujours de chat.completion.

Texte

Date de création

Date et heure Unix du moment où OpenAI a créé la complétion de discussion. Cette valeur s'exprime en secondes.

Nombre

Choix

Une liste des choix d'achèvement du chat :

  • index : l'index du choix dans la liste de choix.

  • message : un message d'achèvement du chat généré par le modèle.

    • role : le rôle de l'auteur du message.

    • content : le contenu du message.

  • finish reason : la raison pour laquelle le modèle a cessé de générer des jetons.

    Consultez la section API d'achèvement de chat pour obtenir une description complète de ces champs.

Ce résultat peut être multiple si N est supérieur à 1.

Liste d'objets

Utilisation

Les statistiques d'utilisation pour la requête d'achèvement :

  • prompt tokens : nombre de jetons dans l'invite.

  • completion tokens : nombre de jetons dans l'achèvement générée.

  • total tokens : nombre total de jetons utilisés dans la requête. Il s'agit de la somme des deux valeurs précédentes.

Objet

Sortie brute

La sortie brute renvoyée par la discussion.

Objet

Exemple

Voici un exemple de résultat de sortie brute renvoyé par la carte :

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-3.5-turbo-0613",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}