GenerateContentResponse

Réponse du modèle acceptant plusieurs candidats.

Remarque sur la classification en matière de sécurité et le filtrage du contenu. Elles sont rapportées à la fois pour l'invite dans GenerateContentResponse.prompt_feedback et pour chaque candidat dans finishReason et dans safetyRatings. Le contrat d'API indique que: - soit tous les candidats demandés sont renvoyés, soit aucun candidat n'est renvoyé - aucun candidat n'est renvoyé que s'il y a un problème avec l'invite (voir promptFeedback) - les commentaires sur chaque candidat sont indiqués sur finishReason et safetyRatings.

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

object (Candidate)

Réponses du modèle
promptFeedback

object (PromptFeedback)

Renvoie les commentaires de la requête concernant les filtres de contenu.
usageMetadata

object (UsageMetadata)

Uniquement en sortie. Métadonnées sur l'utilisation des jetons des 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 évaluations de la sécurité d'une réponse candidate.

Il y a au maximum une note par catégorie.
citationMetadata

object (CitationMetadata)

Uniquement en sortie. Informations sur les citations pour le candidat généré par le modèle.

Ce champ peut être renseigné avec des informations sur la récitation du texte inclus dans le content. Il s'agit de passages "racontés" à partir de contenus protégés par des droits d'auteur 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 arrêté 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 séquence d'arrêt fournie.
MAX_TOKENS Le nombre maximal de jetons spécifié dans la demande 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 la sécurité d'un contenu.

La classification de sécurité indique la catégorie de préjudice ainsi que le niveau de probabilité de préjudice pour un contenu donné. La sécurité d'un contenu est classée dans plusieurs catégories de préjudices. La probabilité de leur classification 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 indique la probabilité que le contenu soit dangereux. Cela n'indique pas la gravité du préjudice subi pour 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 Le contenu présente peu de risques d'être dangereux.
MEDIUM Le contenu présente un risque moyen d'être dangereux.
HIGH Le contenu a de grandes chances d'être dangereux.

CitationMetadata

Ensemble d'attributions de sources pour un contenu.

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

object (CitationSource)

Citations de sources pour une réponse spécifique.

CitationSource

Citation à 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é à 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é en tant que source au segment.

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

PromptFeedback

Ensemble des métadonnées de commentaires que la requête a spécifiées dans GenerateContentRequest.content.

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

enum (BlockReason)

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

object (SafetyRating)

Évaluations pour la sécurité de l'invite. Il y a au maximum une note par catégorie.

BlockReason

Indique la raison pour laquelle la requête a été bloquée.

Enums
BLOCK_REASON_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
SAFETY La requête a été bloquée pour des raisons de sécurité. Vous pouvez examiner safetyRatings pour identifier la catégorie de sécurité qui l'a bloqué.
OTHER La requête 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 la requête. Lorsque la valeur "cacheContent" est définie, il s'agit toujours de la taille totale effective de la requête. Cela inclut le nombre de jetons dans le contenu mis en cache.
candidatesTokenCount

integer

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

integer

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