GenerateContentResponse

Réponse du modèle acceptant plusieurs candidats.

Remarque sur les niveaux de sécurité et le filtrage du contenu Ils sont signalés à la fois pour la requête dans GenerateContentResponse.prompt_feedback et pour chaque candidat dans finishReason et dans safetyRatings. Le contrat d'API est le suivant: - soit tous les candidats demandés sont renvoyés ou aucun candidat - aucun candidat n'est renvoyé uniquement en cas de problème avec l'invite (voir promptFeedback) - les commentaires sur chaque candidat sont signalés sur finishReason et safetyRatings.

Représentation JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "promptFeedback": {
    object (PromptFeedback)
  },
  "usageMetadata": {
    object (UsageMetadata)
  }
}
Champs
candidates[]

object (Candidate)

Réponses candidates du modèle.
promptFeedback

object (PromptFeedback)

Affiche le commentaire de l'invite concernant les filtres de contenu.
usageMetadata

object (UsageMetadata)

Uniquement en sortie. Métadonnées sur l'utilisation des jetons dans les requêtes de génération.

Candidat

Réponse candidate générée à partir du modèle.

Représentation JSON 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "index": integer
}
Champs
content

object (Content)

Uniquement en sortie. Contenu généré renvoyé par le modèle.
finishReason

enum (FinishReason)

Facultatif. Uniquement en sortie. Raison pour laquelle le modèle a cessé de générer des jetons.

Si ce champ est vide, le modèle n'a pas cessé de générer les jetons.
safetyRatings[]

object (SafetyRating)

Liste des notes de sécurité d'une réponse candidate.

Il n'y a pas plus d'une note par catégorie.
citationMetadata

object (CitationMetadata)

Uniquement en sortie. Informations sur la citation du candidat généré par le modèle.

Ce champ peut être renseigné avec des informations de récital pour tout texte inclus dans l'content. Il s'agit de passages "racontés" à partir de contenus protégés par des droits d'auteur figurant dans les données d'entraînement du LLM de base.
tokenCount

integer

Uniquement en sortie. Nombre de jetons pour ce candidat.
index

integer

Uniquement en sortie. Index du candidat dans la liste des candidats.

FinishReason

Définit la raison pour laquelle le modèle a cessé de générer des jetons.

Enums
FINISH_REASON_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
STOP Point d'arrêt naturel du modèle ou de la séquence d'arrêt fournie.
MAX_TOKENS Le nombre maximal de jetons spécifié dans la requête a été atteint.
SAFETY Le contenu proposé a été signalé pour des raisons de sécurité.
RECITATION Le contenu du candidat a été signalé pour des raisons de récitation.
OTHER Raison inconnue.

SafetyRating

Évaluation de sécurité d'un contenu.

La cote de sécurité indique la catégorie de préjudice et le niveau de probabilité de préjudice dans cette catégorie pour un contenu. Les contenus sont classés pour des raisons de sécurité dans un certain nombre de catégories de préjudices, et la probabilité de classification des préjudices est indiquée ici.

Représentation JSON 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "blocked": boolean
}
Champs
category

enum (HarmCategory)

Obligatoire. Catégorie de cette note.
probability

enum (HarmProbability)

Obligatoire. Probabilité de préjudice pour ce contenu.
blocked

boolean

Ce contenu a-t-il été bloqué en raison de cet avis ?

HarmProbability

Probabilité qu'un contenu soit nuisible.

Le système de classification donne la probabilité que le contenu soit dangereux. Cet indicateur n'indique pas la gravité des préjudices subis par un contenu.

Enums
HARM_PROBABILITY_UNSPECIFIED La probabilité n'est pas spécifiée.
NEGLIGIBLE Un contenu présente un risque négligeable d'être dangereux.
LOW Ce contenu a peu de chances d'être dangereux.
MEDIUM Le contenu a une probabilité moyenne d'être dangereux.
HIGH Un contenu est très susceptible d'être dangereux.

CitationMetadata

Ensemble des attributions de sources pour un élément de contenu.

Représentation JSON 
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}
Champs
citationSources[]

object (CitationSource)

Citations vers des sources pour une réponse spécifique.

CitationSource

Citation d'une source pour une partie d'une réponse spécifique.

Représentation JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}
Champs
startIndex

integer

Facultatif. Début du segment de la réponse attribuée à cette source.

L'index indique le début du segment, mesuré en octets.
endIndex

integer

Facultatif. Fin du segment attribué (exclus).
uri

string

Facultatif. URI attribué en tant que source pour une partie du texte.
license

string

Facultatif. Licence pour le projet GitHub attribuée en tant que source pour le segment.

Les informations sur la licence sont requises pour les citations de code.

PromptFeedback

Ensemble des métadonnées de commentaire associées à l'invite spécifiée dans GenerateContentRequest.content.

Représentation JSON 
{
  "blockReason": enum (BlockReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ]
}
Champs
blockReason

enum (BlockReason)

Facultatif. Si cette règle est définie, l'invite a été bloquée et aucun candidat n'est renvoyé. Reformulez votre requête.
safetyRatings[]

object (SafetyRating)

Évaluations de la sécurité de l'invite. Il n'y a pas plus d'une note par catégorie.

BlockReason

Indique la raison pour laquelle l'invite a été bloquée.

Enums
BLOCK_REASON_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
SAFETY L'invite a été bloquée pour des raisons de sécurité. Vous pouvez inspecter safetyRatings pour identifier la catégorie de sécurité qui l'a bloquée.
OTHER L'invite a été bloquée pour des raisons inconnues.

UsageMetadata

Métadonnées sur l'utilisation des jetons de la requête de génération.

Représentation JSON 
{
  "promptTokenCount": integer,
  "candidatesTokenCount": integer,
  "totalTokenCount": integer
}
Champs
promptTokenCount

integer

Nombre de jetons dans l'invite.
candidatesTokenCount

integer

Nombre total de jetons parmi les candidats générés.
totalTokenCount

integer

Nombre total de jetons pour la requête de génération (invite + candidats).