Method: models.generateText

Génère une réponse du modèle à partir d'un message d'entrée.

Requête HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateText

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
model

string

Obligatoire. Nom de Model ou TunedModel à utiliser pour générer la saisie semi-automatique. Exemples: model/text-bison-001 tunModels/sentence-translation-u3b7m

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "prompt": {
    object (TextPrompt)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "stopSequences": [
    string
  ],
  "temperature": number,
  "candidateCount": integer,
  "maxOutputTokens": integer,
  "topP": number,
  "topK": integer
}
Champs
prompt

object (TextPrompt)

Obligatoire. Texte d'entrée de forme libre transmis au modèle sous forme de requête.

À partir d'une requête, le modèle génère une réponse TextComplete prédit comme achèvement du texte d'entrée.

safetySettings[]

object (SafetySetting)

Facultatif. Liste d'instances SafetySetting uniques pour bloquer le contenu à risque.

qui sera appliqué à GenerateTextRequest.prompt et GenerateTextResponse.candidates. Il ne doit y avoir qu'un seul paramètre par type de SafetyCategory. L'API bloque toutes les invites et réponses qui n'atteignent pas les seuils définis par ces paramètres. Cette liste remplace les paramètres par défaut pour chaque SafetyCategory spécifié dans les safetySettings. Si aucun SafetySetting n'est indiqué dans la liste pour un SafetyCategory donné, l'API utilise le paramètre de sécurité par défaut de cette catégorie. Les catégories de préjudice HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL et HARM_CATEGORY_DANGEROUS sont compatibles avec le service de texte.

stopSequences[]

string

Ensemble de séquences de caractères (jusqu'à cinq) qui arrêteront la génération de sortie. Si cette valeur est spécifiée, l'API s'arrête à la première apparition d'une séquence d'arrêt. La séquence d'arrêt ne sera pas incluse dans la réponse.

temperature

number

Facultatif. Permet de contrôler le caractère aléatoire de la sortie. Remarque: La valeur par défaut varie selon le modèle. Consultez l'attribut Model.temperature de Model a renvoyé la fonction getModel.

Les valeurs peuvent être comprises entre [0.0,1.0] inclus. Une valeur proche de 1,0 produira des réponses plus variées et créatives, tandis qu'une valeur plus proche de 0,0 produira généralement des réponses plus simples du modèle.

candidateCount

integer

Facultatif. Nombre de réponses générées à renvoyer.

Cette valeur doit être comprise entre [1 et 8] inclus. Si cette règle n'est pas configurée, la valeur par défaut est 1.

maxOutputTokens

integer

Facultatif. Nombre maximal de jetons à inclure dans un candidat.

Si cette règle n'est pas configurée, la valeur "outputTokenLimit" est définie par défaut dans la spécification Model.

topP

number

Facultatif. Probabilité cumulée maximale des jetons à prendre en compte lors de l'échantillonnage.

Le modèle utilise un échantillonnage combiné de top-k et de noyau.

Les jetons sont triés en fonction des probabilités qui leur sont attribuées, afin que seuls les jetons les plus probables soient pris en compte. L'échantillonnage top-k limite directement le nombre maximal de jetons à prendre en compte, tandis que l'échantillonnage de Nucleus limite le nombre de jetons en fonction de la probabilité cumulée.

Remarque: La valeur par défaut varie selon le modèle. Consultez l'attribut Model.top_p de Model a renvoyé la fonction getModel.

topK

integer

Facultatif. Nombre maximal de jetons à prendre en compte lors de l'échantillonnage.

Le modèle utilise un échantillonnage combiné de top-k et de noyau.

L'échantillonnage top-k prend en compte l'ensemble des topK jetons les plus probables. La valeur par défaut est 40.

Remarque: La valeur par défaut varie selon le modèle. Consultez l'attribut Model.top_k de Model a renvoyé la fonction getModel.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de GenerateTextResponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Pour en savoir plus, consultez la page Présentation de l'authentification.