Question answering

Méthode: Models.generateAnswer

Génère une réponse ancrée à partir du modèle en fonction d'une GenerateAnswerRequest d'entrée.

Point de terminaison

<ph type="x-smartling-placeholder"></ph> publier https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateAnswer .

Paramètres de chemin d'accès

model string

Obligatoire. Nom du Model à utiliser pour générer la réponse ancrée.

Format : model=models/{model}. Il se présente sous la forme models/{model}.

Corps de la requête

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

<ph type="x-smartling-placeholder">
</ph> Champs
contents[] object (Content)

Obligatoire. Contenu de la conversation en cours avec le modèle. Pour les requêtes à un seul tour, il s'agit d'une seule question à laquelle il faut répondre. Pour les requêtes multitours, il s'agit d'un champ répété contenant l'historique de la conversation et le dernier Content de la liste contenant la question.

Remarque: Models.generateAnswer prend actuellement en charge les requêtes en anglais uniquement.

answerStyle enum (AnswerStyle)

Obligatoire. Style dans lequel les réponses doivent être affichées.

safetySettings[] object (SafetySetting)

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

Cette modification sera appliquée à GenerateAnswerRequest.contents et à GenerateAnswerResponse.candidate. Il ne doit pas y avoir plus d'un paramètre par type de SafetyCategory. L'API bloquera tous les contenus et toutes les réponses qui ne respectent 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 paramètres de sécurité. Si aucun SafetySetting ne figure dans la liste pour un SafetyCategory donné, l'API utilise le paramètre de sécurité par défaut pour cette catégorie. Les catégories de préjudices HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT et HARM_CATEGORY_HARASSMENT sont prises en charge.

Champ d'union grounding_source. Sources sur lesquelles baser la réponse. grounding_source ne peut être qu'un des éléments suivants :
inlinePassages object (GroundingPassages)

Passages fournis en ligne avec la requête.

semanticRetriever object (SemanticRetrieverConfig)

Contenu récupéré à partir de ressources créées avec l'API Semantic Retriever.

temperature number

Facultatif. Contrôle le caractère aléatoire de la sortie.

Les valeurs peuvent être comprises entre [0,0 et 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 donnera généralement des réponses plus simples du modèle. Une température basse (~0,2) est généralement recommandée pour les cas d'utilisation des réponses aux questions attribuées.

Corps de la réponse

Réponse du modèle pour une réponse fondée sur le terrain.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
answer object (Candidate)

Réponse du candidat du modèle.

Remarque: Le modèle tente toujours de fournir une réponse fondée sur le terrain, même lorsqu'il est peu probable qu'il y ait une réponse à partir des passages donnés. Dans ce cas, une réponse incomplète ou de mauvaise qualité peut être fournie, avec un answerableProbability faible.

answerableProbability number

Uniquement en sortie. Estimation de la probabilité que sa réponse soit correcte et ancrée dans les passages d'entrée.

Une probabilité de réponse faible indique que la réponse n'est peut-être pas fondée sur les sources.

Lorsque la valeur de answerableProbability est faible, certains clients peuvent souhaiter:

  • Afficher le message "Impossible de répondre à cette question" pour l'utilisateur.
  • Reposez-vous sur un LLM à usage général qui répond à la question à partir de la connaissance du monde. Le seuil et la nature de ces alternatives dépendent des cas d'utilisation de chaque client. 0,5 est un bon seuil de départ.
inputFeedback object (InputFeedback)

Uniquement en sortie. Retour d'information lié aux données d'entrée utilisées pour répondre à la question, par opposition à la réponse générée par le modèle.

"Données d'entrée" peut correspondre à un ou plusieurs des éléments suivants:

  • Question spécifiée par la dernière entrée de GenerateAnswerRequest.content
  • Historique de la conversation spécifié par les autres entrées de GenerateAnswerRequest.content
  • Sources d'ancrage (GenerateAnswerRequest.semantic_retriever ou GenerateAnswerRequest.inline_passages)
Représentation JSON 
{
  "answer": {
    object (Candidate)
  },
  "answerableProbability": number,
  "inputFeedback": {
    object (InputFeedback)
  }
}

GroundingPassages

Liste de passages répétée.

Représentation JSON 
{
  "passages": [
    {
      object (GroundingPassage)
    }
  ]
}
Champs
passages[] object (GroundingPassage)

Liste de passages.

GroundingPassage

Passage inclus dans la configuration d'ancrage.

Représentation JSON 
{
  "id": string,
  "content": {
    object (Content)
  }
}
Champs
id string

Identifiant du passage permettant d'attribuer ce passage dans des réponses fondées.

content object (Content)

Contenu du passage.

SemanticRetrieverConfig

Configuration permettant de récupérer le contenu d'ancrage à partir d'un Corpus ou d'un Document créé à l'aide de l'API Semantic Retriever.

Représentation JSON 
{
  "source": string,
  "query": {
    object (Content)
  },
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "maxChunksCount": integer,
  "minimumRelevanceScore": number
}
Champs
source string

Obligatoire. Nom de la ressource à récupérer, par exemple corpora/123 ou corpora/123/documents/abc.

query object (Content)

Obligatoire. Requête à utiliser pour la mise en correspondance de similarités Chunk dans la ressource donnée.

metadataFilters[] object (MetadataFilter)

Facultatif. Filtres pour sélectionner des Document et/ou des Chunk à partir de la ressource.

maxChunksCount integer

Facultatif. Nombre maximal de Chunk pertinents à récupérer.

minimumRelevanceScore number

Facultatif. Score de pertinence minimal pour les Chunk pertinents récupérés.

AnswerStyle

Donnez du style à des réponses réalistes.

Enums
ANSWER_STYLE_UNSPECIFIED Style de réponse non spécifié.
ABSTRACTIVE Un style succinct, mais abstrait.
EXTRACTIVE Style très bref et extractif.
VERBOSE Style détaillé avec détails supplémentaires. La réponse peut prendre la forme d'une phrase, d'un paragraphe, de plusieurs paragraphes, d'une liste à puces, etc.

InputFeedback

Retour d'information lié aux données d'entrée utilisées pour répondre à la question, par opposition à la réponse générée par le modèle.

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

Évaluations pour la sécurité des entrées. Il y a au maximum une note par catégorie.

blockReason enum (BlockReason)

Facultatif. Si ce champ est défini, l'entrée a été bloquée et aucun candidat n'est renvoyé. Reformulez votre saisie.

BlockReason

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

Enums
BLOCK_REASON_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
SAFETY L'entrée 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 L'entrée a été bloquée pour d'autres raisons.