Question answering

Methode: models.generateAnswer

Generiert eine fundierte Antwort aus dem Modell anhand einer GenerateAnswerRequest-Eingabe.

Endpunkt

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

Pfadparameter

model string

Erforderlich. Der Name des Model, der zum Generieren der fundierten Antwort verwendet werden soll.

Format: model=models/{model}. Sie hat das Format models/{model}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

Erforderlich. Der Inhalt der aktuellen Unterhaltung mit dem Modell. Bei Abfragen mit einer einzigen Antwort muss diese Frage nur in einer einzigen Antwort beantwortet werden. Bei Abfragen mit mehreren Antworten ist dies ein wiederkehrendes Feld, das den Unterhaltungsverlauf und das letzte Content in der Liste mit der Frage enthält.

Hinweis: „models.generateAnswer“ unterstützt derzeit nur Suchanfragen auf Englisch.

answerStyle enum (AnswerStyle)

Erforderlich. Stil, in dem Antworten zurückgegeben werden sollen.

safetySettings[] object (SafetySetting)

Optional. Eine Liste einzelner SafetySetting-Instanzen zum Blockieren unsicherer Inhalte.

Dies wird am GenerateAnswerRequest.contents und GenerateAnswerResponse.candidate erzwungen. Es darf nicht mehr als eine Einstellung für jeden SafetyCategory-Typ vorhanden sein. Die API blockiert alle Inhalte und Antworten, die die in diesen Einstellungen festgelegten Grenzwerte nicht erreichen. Diese Liste überschreibt die Standardeinstellungen für jeden in „safetySettings“ festgelegten SafetyCategory. Wenn für eine bestimmte SafetyCategory in der Liste keine SafetySetting angegeben ist, verwendet die API die standardmäßige Sicherheitseinstellung für diese Kategorie. Die schädlichen Kategorien HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT und HARM_CATEGORY_HARASSMENT werden unterstützt.

Union-Feld grounding_source. Die Quellen, auf denen die Antwort begründet werden soll. Für grounding_source ist nur einer der folgenden Werte zulässig:
inlinePassages object (GroundingPassages)

Inline in der Anfrage angegebene Durchgänge.

semanticRetriever object (SemanticRetrieverConfig)

Inhalte, die aus Ressourcen abgerufen wurden, die über die Semantic Retriever API erstellt wurden.

temperature number

Optional. Steuert die Zufälligkeit der Ausgabe.

Die Werte können im Bereich von [0.0,1.0] (einschließlich) liegen. Ein Wert näher an 1,0 führt zu Antworten, die vielfältiger und kreativer sind, während ein Wert näher an 0,0 in der Regel zu direkteren Antworten vom Modell führt. Für Anwendungsfälle der Zuordnung von Fragen wird in der Regel eine niedrige Temperatur (ca.0,2) empfohlen.

Antworttext

Antwort des Modells für eine fundierte Antwort.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Felder
answer object (Candidate)

Mögliche Antwort aus dem Modell.

Hinweis: Das Modell versucht immer, eine fundierte Antwort zu liefern, auch wenn sich die Antwort anhand der gegebenen Abschnitte wahrscheinlich nicht beantworten lässt. In diesem Fall wird möglicherweise eine qualitativ minderwertige oder unbegründete Antwort zusammen mit einem niedrigen answerableProbability bereitgestellt.

answerableProbability number

Nur Ausgabe. Die Schätzung des Modells für die Wahrscheinlichkeit, dass seine Antwort richtig ist und auf den Eingabeabschnitten basiert.

Eine niedrige answerableProbability deutet darauf hin, dass die Antwort möglicherweise nicht auf Quellen basiert.

Wenn answerableProbability niedrig ist, möchten einige Kunden möglicherweise Folgendes tun:

  • Nachricht mit dem Hinweis „Wir konnten diese Frage nicht beantworten“ anzeigen für den Nutzer.
  • Nutzen Sie ein allgemeines LLM, das die Frage nach dem Weltwissen beantwortet. Der Grenzwert und die Art dieser Fallbacks hängen von den Anwendungsfällen des jeweiligen Kunden ab. 0,5 ist ein guter Schwellenwert für den Einstieg.
inputFeedback object (InputFeedback)

Nur Ausgabe. Feedback, das sich auf die Eingabedaten bezieht, die zur Beantwortung der Frage verwendet wurden, und nicht auf die modellgenerierte Antwort auf die Frage.

„Eingabedaten“ kann eines oder mehrere der folgenden sein:

  • Die im letzten Eintrag in GenerateAnswerRequest.content angegebene Frage
  • Der durch die anderen Einträge in „GenerateAnswerRequest.content“ angegebene Unterhaltungsverlauf
  • Fundierungsquellen (GenerateAnswerRequest.semantic_retriever oder GenerateAnswerRequest.inline_passages)
JSON-Darstellung 
{
  "answer": {
    object (Candidate)
  },
  "answerableProbability": number,
  "inputFeedback": {
    object (InputFeedback)
  }
}

GroundingPassages

Eine wiederholte Liste von Abschnitten.

JSON-Darstellung 
{
  "passages": [
    {
      object (GroundingPassage)
    }
  ]
}
Felder
passages[] object (GroundingPassage)

Liste der Abschnitte.

GroundingPassage

Durchgang inline in eine Fundierungskonfiguration.

JSON-Darstellung 
{
  "id": string,
  "content": {
    object (Content)
  }
}
Felder
id string

Kennung für die Passage, in der diese Passage in fundierte Antworten zugeschrieben wird.

content object (Content)

Inhalt der Passage.

SemanticRetrieverConfig

Konfiguration zum Abrufen von Fundierungsinhalten von Corpus oder Document, die mit der Semantic Retriever API erstellt wurden.

JSON-Darstellung 
{
  "source": string,
  "query": {
    object (Content)
  },
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "maxChunksCount": integer,
  "minimumRelevanceScore": number
}
Felder
source string

Erforderlich. Name der abzurufenden Ressource, z.B. corpora/123 oder corpora/123/documents/abc haben.

query object (Content)

Erforderlich. Abfrage, die für den Ähnlichkeitsabgleich von Chunks in der angegebenen Ressource verwendet werden soll.

metadataFilters[] object (MetadataFilter)

Optional. Filter zur Auswahl von Document- und/oder Chunk-Elementen aus der Ressource.

maxChunksCount integer

Optional. Maximale Anzahl relevanter Chunks, die abgerufen werden sollen.

minimumRelevanceScore number

Optional. Minimaler Relevanzwert für abgerufene relevante Chunks.

AnswerStyle

Stile für fundierte Antworten.

Enums
ANSWER_STYLE_UNSPECIFIED Unbekannter Antwortstil
ABSTRACTIVE Erfolgreicher, aber abstrakter Stil.
EXTRACTIVE Sehr kurz und extravagant.
VERBOSE Ausführlicher Stil mit zusätzlichen Details. Die Antwort kann als Satz, Absatz, mehrere Absätze, Aufzählungspunkte usw. formatiert sein.

InputFeedback

Feedback, das sich auf die Eingabedaten bezieht, die zur Beantwortung der Frage verwendet wurden, und nicht auf die modellgenerierte Antwort auf die Frage.

JSON-Darstellung 
{
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "blockReason": enum (BlockReason)
}
Felder
safetyRatings[] object (SafetyRating)

Bewertungen zur Sicherheit der Eingabe Es gibt maximal eine Bewertung pro Kategorie.

blockReason enum (BlockReason)

Optional. Wenn dieser Wert festgelegt ist, wurde die Eingabe blockiert und es werden keine Kandidaten zurückgegeben. Formulieren Sie Ihre Eingabe um.

BlockReason

Gibt an, warum die Eingabe blockiert wurde.

Enums
BLOCK_REASON_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
SAFETY Die Eingabe wurde aus Sicherheitsgründen blockiert. Du kannst safetyRatings prüfen, um herauszufinden, welche Sicherheitskategorie es blockiert hat.
OTHER Die Eingabe wurde aus anderen Gründen blockiert.