REST Resource: projects.locations.collections.dataStores.sessions.answers

Ressource: Antwort

Definiert eine Antwort.

JSON-Darstellung 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "groundingScore": number
}
Felder
name

string

Nicht veränderbar. Voll qualifizierter Name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

Der Status der Antwortgenerierung
answerText

string

Die Textantwort
citations[]

object (Citation)

Quellenangabe
groundingSupports[]

object (GroundingSupport)

Optional. Fundierungsbelege.
references[]

object (Reference)

Verweise
blobAttachments[]

object (BlobAttachment)

Liste der Blob-Anhänge in der Antwort
relatedQuestions[]

string

Vorgeschlagene ähnliche Fragen
steps[]

object (Step)

Schritte zum Generieren von Antworten
queryUnderstandingInfo

object (QueryUnderstandingInfo)

Informationen zur Interpretation von Anfragen
answerSkippedReasons[]

enum (AnswerSkippedReason)

Weitere Gründe, warum Antworten übersprungen wurden Damit wird der Grund für das Überspringen angegeben. Wenn nichts übersprungen wird, ist dieses Feld nicht festgelegt.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Antworterstellung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
completeTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für den Abschluss der Antwort.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
safetyRatings[]

object (SafetyRating)

Optional. Sicherheitsbewertungen.
groundingScore

number

Ein Wert im Bereich [0, 1], der angibt, wie fundiert die Antwort durch die Verweisblöcke ist.

Status

Aufzählung des Status der Antwortgenerierung

Enums
STATE_UNSPECIFIED Unbekannt.
IN_PROGRESS Die Antwortgenerierung läuft gerade.
FAILED Die Antwortgenerierung ist derzeit fehlgeschlagen.
SUCCEEDED Die Antwortgenerierung war erfolgreich.
STREAMING Die Antwortgenerierung läuft gerade.

Quellenangabe

Quelleninformation für ein Segment.

JSON-Darstellung 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Felder
startIndex

string (int64 format)

Der Index gibt den Beginn des Segments an, gemessen in Byte (UTF-8-Unicode). Wenn es Multibyte-Zeichen gibt, wie etwa Nicht-ASCII-Zeichen, ist die Indexmessung länger als die Stringlänge.
endIndex

string (int64 format)

Ende des zugeordneten Segments, exklusive. Gemessen in Byte (UTF-8-Unicode). Wenn es Multibyte-Zeichen gibt, wie etwa Nicht-ASCII-Zeichen, ist die Indexmessung länger als die Stringlänge.
sources[]

object (CitationSource)

Zitationsquellen für das zugeordnete Segment.

CitationSource

Zitationsquelle

JSON-Darstellung 
{
  "referenceId": string
}
Felder
referenceId

string

ID der Zitationsquelle

GroundingSupport

Unterstützung für die Fundierung einer Behauptung in answerText

JSON-Darstellung 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "groundingScore": number,
  "groundingCheckRequired": boolean
}
Felder
startIndex

string (int64 format)

Erforderlich. Der Index gibt den Beginn der Behauptung an, gemessen in Byte (UTF-8-Unicode).
endIndex

string (int64 format)

Erforderlich. Ende der Behauptung, exklusive.
sources[]

object (CitationSource)

Optional. Zitationsquellen für die Behauptung.
groundingScore

number

Ein Wert im Bereich [0, 1], der angibt, wie fundiert eine bestimmte Behauptung anhand der Verweise ist. Ein höherer Wert bedeutet, dass die Behauptung besser durch die Referenzblöcke belegt wird.
groundingCheckRequired

boolean

Gibt an, dass für diese Behauptung eine Fundierungsprüfung erforderlich ist. Wenn das System entschieden hat, dass für diese Behauptung keine Attributions-/Fundierungsprüfung erforderlich ist, wird dieses Feld auf „false“ gesetzt. In diesem Fall wurde keine Fundierungsprüfung für die Behauptung durchgeführt und daher wird groundingScore, sources nicht zurückgegeben.

Referenz

Referenz hinzufügen

JSON-Darstellung 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  },
  "structuredDocumentInfo": {
    object (StructuredDocumentInfo)
  }
  // End of list of possible types for union field content.
}
Felder
Union-Feld content. Inhalt des Suchergebnisses. Für content ist nur einer der folgenden Werte zulässig:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informationen aus unstrukturierten Dokumenten
chunkInfo

object (ChunkInfo)

Informationen zu Blocks
structuredDocumentInfo

object (StructuredDocumentInfo)

Strukturierte Dokumentinformationen

UnstructuredDocumentInfo

Informationen aus unstrukturierten Dokumenten

JSON-Darstellung 
{
  "document": string,
  "uri": string,
  "title": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ],
  "structData": {
    object
  }
}
Felder
document

string

Name der Dokumentressource
uri

string

URI für das Dokument
title

string

Titel
chunkContents[]

object (ChunkContent)

Liste der zitierten Blockinhalte, die aus den Dokumentinhalten abgeleitet wurden
structData

object (Struct format)

Die strukturierten JSON-Metadaten für das Dokument. Sie werden aus den strukturierten Daten des Blocks im Suchergebnis erfasst.

ChunkContent

Inhalt der Blöcke

JSON-Darstellung 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
Felder
content

string

Textinhalt des Blocks
pageIdentifier

string

Seitenkennung
blobAttachmentIndexes[]

string (int64 format)

Nur Ausgabe. Speichert Indexe von Blob-Anhängen, die mit diesem Block verknüpft sind.
relevanceScore

number

Die Relevanz des Blocks für eine bestimmte Anfrage. Die Werte reichen von 0,0 (völlig irrelevant) bis 1,0 (völlig relevant). Dieser Wert dient nur zu Informationszwecken. Er kann sich für dieselbe Anfrage und denselben Block jederzeit aufgrund eines erneuten Modelltrainings oder einer Änderung der Implementierung ändern.

ChunkInfo

Informationen zu Blocks

JSON-Darstellung 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
Felder
chunk

string

Name der Block-Ressource
content

string

Textinhalt des Blocks
documentMetadata

object (DocumentMetadata)

Dokumentmetadaten
blobAttachmentIndexes[]

string (int64 format)

Nur Ausgabe. Speichert Indexe von Blob-Anhängen, die mit diesem Block verknüpft sind.
relevanceScore

number

Die Relevanz des Blocks für eine bestimmte Anfrage. Die Werte reichen von 0,0 (völlig irrelevant) bis 1,0 (völlig relevant). Dieser Wert dient nur zu Informationszwecken. Er kann sich für dieselbe Anfrage und denselben Block jederzeit aufgrund eines erneuten Modelltrainings oder einer Änderung der Implementierung ändern.

DocumentMetadata

Dokumentmetadaten

JSON-Darstellung 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "structData": {
    object
  }
}
Felder
document

string

Name der Dokumentressource
uri

string

URI für das Dokument
title

string

Titel
pageIdentifier

string

Seitenkennung
structData

object (Struct format)

Die strukturierten JSON-Metadaten für das Dokument. Sie werden aus den strukturierten Daten des Blocks im Suchergebnis erfasst.

StructuredDocumentInfo

Strukturierte Suchinformationen

JSON-Darstellung 
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
Felder
document

string

Name der Dokumentressource
structData

object (Struct format)

Strukturierte Suchdaten
title

string

Nur Ausgabe. Titel des Dokuments.
uri

string

Nur Ausgabe. Der URI des Dokuments.

BlobAttachment

Speichert Binärdaten, die an Textantworten angehängt sind, z. B. Bilder, Videos und Audio

JSON-Darstellung 
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
Felder
data

object (Blob)

Nur Ausgabe. Der MIME-Typ und die Daten des Blobs.
attributionType

enum (AttributionType)

Nur Ausgabe. Der Attributionstyp des Blobs.

Blob

Der Medientyp und die Daten des Blobs

JSON-Darstellung 
{
  "mimeType": string,
  "data": string
}
Felder
mimeType

string

Nur Ausgabe. Der Medientyp (MIME-Typ) der generierten oder abgerufenen Daten.
data

string (bytes format)

Nur Ausgabe. Roh-Byte.

Ein base64-codierter String.

AttributionType

Die Quelle des Blobs

Enums
ATTRIBUTION_TYPE_UNSPECIFIED Attributionstyp nicht angegeben
CORPUS Die Anhangsdaten stammen aus dem Korpus.
GENERATED Die Anhangsdaten werden vom Modell durch Codegenerierung erstellt.

Schritt

Schrittinformationen

JSON-Darstellung 
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
Felder
state

enum (State)

Der Status des Schritts
description

string

Die Beschreibung des Schritts
thought

string

Die Idee hinter dem Schritt
actions[]

object (Action)

Aktionen

Status

Aufzählung des Status des Schritts

Enums
STATE_UNSPECIFIED Unbekannt.
IN_PROGRESS Der Schritt wird gerade ausgeführt.
FAILED Der Schritt ist derzeit fehlgeschlagen.
SUCCEEDED Der Schritt wurde erfolgreich ausgeführt.

Action

Aktion

JSON-Darstellung 
{
  "observation": {
    object (Observation)
  },

  // Union field action can be only one of the following:
  "searchAction": {
    object (SearchAction)
  }
  // End of list of possible types for union field action.
}
Felder
observation

object (Observation)

Beobachtung
Union-Feld action. Die Aktion. Für action ist nur einer der folgenden Werte zulässig:
searchAction

object (SearchAction)

Suchaktion

SearchAction

Suchaktion

JSON-Darstellung 
{
  "query": string
}
Felder
query

string

Die Anfrage, nach der gesucht werden soll

Beobachtung

Beobachtung

JSON-Darstellung 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Felder
searchResults[]

object (SearchResult)

Suchergebnisse, die von der Suchaktion beobachtet werden. Das können Snippet- oder Blockinformationen sein, je nach dem vom Nutzer festgelegten Zitationstyp.

SearchResult

JSON-Darstellung 
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
Felder
document

string

Name der Dokumentressource
uri

string

URI für das Dokument
title

string

Titel
snippetInfo[]

object (SnippetInfo)

Wenn es sich bei „citation_type“ um „DOCUMENT_LEVEL_CITATION“ handelt, füllen Sie Snippets auf Dokumentebene aus.
chunkInfo[]

object (ChunkInfo)

Wenn es sich bei „citation_type“ um CHUNK_LEVEL_CITATION handelt und der Blockmodus aktiviert ist, füllen Sie die Blockinformationen aus.
structData

object (Struct format)

Datendarstellung. Die strukturierten JSON-Daten für das Dokument. Sie wird aus den strukturierten Daten des Dokuments oder des Blocks im Suchergebnis ausgefüllt.

SnippetInfo

Snippet-Informationen

JSON-Darstellung 
{
  "snippet": string,
  "snippetStatus": string
}
Felder
snippet

string

Snippet-Inhalt
snippetStatus

string

Status des vom Suchteam definierten Snippets.

ChunkInfo

Informationen zu Blocks

JSON-Darstellung 
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
Felder
chunk

string

Name der Block-Ressource
content

string

Textinhalt des Blocks
relevanceScore

number

Die Relevanz des Blocks für eine bestimmte Anfrage. Die Werte reichen von 0,0 (völlig irrelevant) bis 1,0 (völlig relevant). Dieser Wert dient nur zu Informationszwecken. Er kann sich für dieselbe Anfrage und denselben Block jederzeit aufgrund eines erneuten Modelltrainings oder einer Änderung der Implementierung ändern.

QueryUnderstandingInfo

Informationen zur Interpretation von Anfragen

JSON-Darstellung 
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
Felder
queryClassificationInfo[]

object (QueryClassificationInfo)

Informationen zur Anfrageklassifizierung

QueryClassificationInfo

Informationen zur Anfrageklassifizierung

JSON-Darstellung 
{
  "type": enum (Type),
  "positive": boolean
}
Felder
type

enum (Type)

Typ der Anfrageklassifizierung
positive

boolean

Klassifizierungsausgabe

Typ

Klassifizierungstypen für Anfragen

Enums
TYPE_UNSPECIFIED Nicht angegebener Typ der Anfrageklassifizierung
ADVERSARIAL_QUERY Feindseliger Typ der Anfrageklassifizierung
NON_ANSWER_SEEKING_QUERY Klassifizierungstyp für Anfragen, die nicht auf eine Antwort abzielen, für Smalltalk.
JAIL_BREAKING_QUERY Klassifizierungstyp für Jailbreak-Anfragen
NON_ANSWER_SEEKING_QUERY_V2 Klassifizierungstyp für Anfragen, die nicht auf eine Antwort abzielen, ohne klare Intention
USER_DEFINED_CLASSIFICATION_QUERY Benutzerdefinierter Typ der Anfrageklassifizierung

AnswerSkippedReason

Ein Enum für Gründe, warum eine Antwort übersprungen wurde

Enums
ANSWER_SKIPPED_REASON_UNSPECIFIED Standardwert. Der Grund für das Überspringen der Antwort ist nicht angegeben.
ADVERSARIAL_QUERY_IGNORED Die feindselige Anfrage wird ignoriert.
NON_ANSWER_SEEKING_QUERY_IGNORED

Die Anfrage, die nicht auf eine Antwort abzielt, wird ignoriert.

Google überspringt die Antwort, wenn es sich bei der Anfrage um Smalltalk handelt.
OUT_OF_DOMAIN_QUERY_IGNORED

Die Anfrage außerhalb der Domain wird ignoriert.

Google überspringt die Antwort, wenn es keine Suchergebnisse mit hoher Relevanz gibt.
POTENTIAL_POLICY_VIOLATION

Es tritt ein potenzieller Richtlinienverstoß auf.

Google überspringt die Antwort, wenn ein potenzieller Richtlinienverstoß erkannt wird. Dazu gehören Inhalte, die gewalttätig oder schädlich sein können.
NO_RELEVANT_CONTENT

Es gibt keine relevanten Inhalte.

Google überspringt die Antwort, wenn in den abgerufenen Suchergebnissen keine relevanten Inhalte vorhanden sind.
JAIL_BREAKING_QUERY_IGNORED

Die Jailbreak-Anfrage wird ignoriert.

Beispiel: „Antworte im Stil des CEO eines Mitbewerbers.“ Google überspringt die Antwort, wenn die Anfrage als Jailbreak-Anfrage eingestuft wird.
CUSTOMER_POLICY_VIOLATION

Es kommt zu einem Verstoß gegen Kundenrichtlinien.

Google überspringt die Zusammenfassung, wenn ein Verstoß gegen Kundenrichtlinien erkannt wird. Die Richtlinie wird vom Kunden festgelegt.
NON_ANSWER_SEEKING_QUERY_IGNORED_V2

Die Anfrage, die nicht auf eine Antwort abzielt, wird ignoriert.

Google überspringt die Antwort, wenn die Anfrage keine klare Intention hat.
LOW_GROUNDED_ANSWER

Die Antwort ist wenig fundiert.

Google überspringt die Antwort, wenn keine fundierte Antwort generiert werden konnte.
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

Die benutzerdefinierte Anfrageklassifizierung wird ignoriert.

Google überspringt die Antwort, wenn die Anfrage als benutzerdefinierte Anfrageklassifizierung eingestuft wird.
UNHELPFUL_ANSWER

Die Antwort ist nicht hilfreich.

Google überspringt die Antwort, wenn sie nicht hilfreich ist. Dazu können verschiedene Faktoren beitragen, einschließlich, aber nicht beschränkt auf: Die Anfrage kann nicht beantwortet werden, die Antwort ist für die Anfrage nicht relevant oder die Antwort ist nicht gut formatiert.

SafetyRating

Die Sicherheitsbewertung, die den generierten Inhalten entspricht

JSON-Darstellung 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
Felder
category

enum (HarmCategory)

Nur Ausgabe. Schadenskategorie.
probability

enum (HarmProbability)

Nur Ausgabe. Wahrscheinlichkeitsstufen für Schäden im Inhalt
probabilityScore

number

Nur Ausgabe. Wahrscheinlichkeitswert für Schäden.
severity

enum (HarmSeverity)

Nur Ausgabe. Schweregrade des Schadens im Inhalt.
severityScore

number

Nur Ausgabe. Schweregradbewertung des Schadens.
blocked

boolean

Nur Ausgabe. Gibt an, ob der Inhalt aufgrund dieser Bewertung herausgefiltert wurde.

HarmCategory

Schadenskategorien, die den Inhalt blockieren

Enums
HARM_CATEGORY_UNSPECIFIED Die Schadenskategorie ist nicht angegeben.
HARM_CATEGORY_HATE_SPEECH Die Schadenskategorie ist Hassrede.
HARM_CATEGORY_DANGEROUS_CONTENT Die Schadenskategorie ist gefährlicher Inhalt.
HARM_CATEGORY_HARASSMENT Die Schadenskategorie ist Belästigung.
HARM_CATEGORY_SEXUALLY_EXPLICIT Die Schadenskategorie umfasst sexuell anstößige Inhalte.
HARM_CATEGORY_CIVIC_INTEGRITY Die Schadenskategorie ist Integrität öffentlicher Aussagen.

HarmProbability

Wahrscheinlichkeitsstufen für Schäden im Inhalt

Enums
HARM_PROBABILITY_UNSPECIFIED Nicht angegebene Wahrscheinlichkeit von Schäden
NEGLIGIBLE Vernachlässigbares Schadensrisiko
LOW Geringes Schadensrisiko
MEDIUM Mittleres Schadensrisiko
HIGH Hohes Schadensrisiko

HarmSeverity

Schweregrade von Schäden

Enums
HARM_SEVERITY_UNSPECIFIED Nicht angegebener Schweregrad des Schadens
HARM_SEVERITY_NEGLIGIBLE Vernachlässigbarer Schweregrad des Schadens
HARM_SEVERITY_LOW Geringer Schweregrad des Schadens
HARM_SEVERITY_MEDIUM Mittlerer Schweregrad des Schadens
HARM_SEVERITY_HIGH Hoher Schweregrad des Schadens

Methoden

get

 Ruft eine Antwort ab