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. Vollständig 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)

Zitate.
groundingSupports[]

object (GroundingSupport)

Optional. Unterstützung für Grounding
references[]

object (Reference)

Referenzen.
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)

Zusätzliche Gründe, warum Antworten übersprungen wurden. Hier wird der Grund für ignorierte Fälle angegeben. Wenn nichts übersprungen wird, ist dieses Feld nicht festgelegt.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel 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".
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

Eine Punktzahl im Bereich von [0, 1], die beschreibt, wie fundiert die Antwort durch die Referenz-Chunks ist.

Bundesland

Aufzählung des Status der Antwortgenerierung.

Enums
STATE_UNSPECIFIED Unbekannt.
IN_PROGRESS Die Antwort wird gerade generiert.
FAILED Die Antwort konnte derzeit nicht generiert werden.
SUCCEEDED Die Antwort wurde erfolgreich generiert.
STREAMING Die Antwort wird gerade generiert.

Quellenangabe

Zitierinformationen 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 in Byte (UTF-8-Unicode) an. Wenn es Multibyte-Zeichen wie Nicht-ASCII-Zeichen gibt, ist die Indexmessung länger als die Stringlänge.
endIndex

string (int64 format)

Ende des zugeordneten Segments (ausschließlich). Gemessen in Byte (UTF-8-Unicode). Wenn es Multibyte-Zeichen wie Nicht-ASCII-Zeichen gibt, 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

Die ID der Zitationsquelle.

GroundingSupport

Fundierung für eine 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 des Anspruchs in Byte (UTF-8-Unicode) an.
endIndex

string (int64 format)

Erforderlich. Ende des Anspruchs, exklusiv.
sources[]

object (CitationSource)

Optional. Zitationsquellen für die Behauptung.
groundingScore

number

Ein Wert im Bereich [0, 1], der beschreibt, wie gut eine bestimmte Behauptung durch die Referenzen belegt wird. Ein höherer Wert bedeutet, dass die Behauptung besser durch die Referenz-Chunks belegt wird.
groundingCheckRequired

boolean

Gibt an, dass für diesen Anspruch eine Fundierungsprüfung erforderlich war. 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

Reference 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. Inhalte der Suchergebnisse. Für content ist nur einer der folgenden Werte zulässig:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informationen aus unstrukturierten Dokumenten.
chunkInfo

object (ChunkInfo)

Informationen zu Chunks.
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 Chunks, die aus Dokumentinhalten abgeleitet wurden.
structData

object (Struct format)

Die strukturierten JSON-Metadaten für das Dokument. Sie wird aus den strukturierten Daten des Chunks im Suchergebnis generiert.

ChunkContent

Inhalte in Chunks aufteilen

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

string

Textinhalte in Abschnitte unterteilen
pageIdentifier

string

Seiten-ID.
blobAttachmentIndexes[]

string (int64 format)

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

number

Die Relevanz des Chunks 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 Chunk jederzeit aufgrund eines erneuten Modelltrainings oder einer Änderung der Implementierung ändern.

ChunkInfo

Informationen zu Chunks.

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

string

Name der Chunk-Ressource.
content

string

Textinhalte in Abschnitte unterteilen
documentMetadata

object (DocumentMetadata)

Dokumentmetadaten
blobAttachmentIndexes[]

string (int64 format)

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

number

Die Relevanz des Chunks 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 Chunk 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

Seiten-ID.
structData

object (Struct format)

Die strukturierten JSON-Metadaten für das Dokument. Sie wird aus den strukturierten Daten des Chunks im Suchergebnis generiert.

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. Der Titel des Dokuments.
uri

string

Nur Ausgabe. Der URI des Dokuments.

BlobAttachment

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

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. Rohbyte.

Ein base64-codierter String.

AttributionType

Die Quelle des Blobs.

Enums
ATTRIBUTION_TYPE_UNSPECIFIED Nicht angegebener Attributionstyp.
CORPUS Die Attachment-Daten stammen aus dem Korpus.
GENERATED Die Anhänge 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

Bundesland

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.

Aktion

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 Suchanfrage.

Beobachtung

Beobachtung.

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

object (SearchResult)

Suchergebnisse, die von der Suchaktion beobachtet werden. Das können Snippet-Informationen oder Chunk-Informationen 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 „citation_type“ „DOCUMENT_LEVEL_CITATION“ ist, füllen Sie Snippets auf Dokumentebene aus.
chunkInfo[]

object (ChunkInfo)

Wenn „citation_type“ CHUNK_LEVEL_CITATION ist und der Chunk-Modus aktiviert ist, füllen Sie die Chunk-Informationen ein.
structData

object (Struct format)

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

SnippetInfo

Snippet-Informationen

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

string

Snippet-Inhalte.
snippetStatus

string

Status des Snippets, der vom Suchteam definiert wird.

ChunkInfo

Informationen zu Chunks.

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

string

Name der Chunk-Ressource.
content

string

Textinhalte in Abschnitte unterteilen
relevanceScore

number

Die Relevanz des Chunks 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 Chunk 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 Abfrageklassifizierung.

QueryClassificationInfo

Informationen zur Abfrageklassifizierung.

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

enum (Type)

Typ der Abfrageklassifizierung.
positive

boolean

Klassifizierungsausgabe.

Typ

Klassifizierungstypen für Anfragen.

Enums
TYPE_UNSPECIFIED Nicht angegebener Typ der Anfragenklassifizierung.
ADVERSARIAL_QUERY Typ der Klassifizierung von feindseligen Anfragen.
NON_ANSWER_SEEKING_QUERY Klassifizierungstyp für Anfragen, die keine Antwort erfordern, für Smalltalk.
JAIL_BREAKING_QUERY Klassifizierungstyp für Jailbreak-Abfragen.
NON_ANSWER_SEEKING_QUERY_V2 Anfrageklassifizierungstyp für Anfragen, die nicht auf eine Antwort abzielen, ohne klare Intention.
USER_DEFINED_CLASSIFICATION_QUERY Benutzerdefinierter Typ der Suchanfrageklassifizierung.

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 Bei der feindseligen Anfrage wurde die Groß-/Kleinschreibung ignoriert.
NON_ANSWER_SEEKING_QUERY_IGNORED

Die Anfrage, die keine Antwort sucht, ignoriert die Groß- und Kleinschreibung.

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

Bei der Anfrage außerhalb der Domain wurde die Groß-/Kleinschreibung ignoriert.

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

Der Fall des potenziellen Richtlinienverstoßes.

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

Der Fall „Keine relevanten Inhalte“.

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

Bei der Jailbreak-Anfrage wurde die Groß-/Kleinschreibung ignoriert.

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

Der Fall des Kundenrichtlinienverstoßes.

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

Bei der Frage, die keine Antwort sucht, wurde die Groß-/Kleinschreibung ignoriert.

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

Der Fall der Antwort mit geringer Fundierung.

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

Die benutzerdefinierte Abfrageklassifizierung hat die Groß-/Kleinschreibung ignoriert.

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

Der Fall einer nicht hilfreichen Antwort.

Google überspringt die Antwort, wenn sie nicht hilfreich ist. Das kann verschiedene Gründe haben, z. B. dass die Frage nicht beantwortet werden kann, die Antwort nicht relevant ist oder die Antwort nicht gut formatiert ist.

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. Schweregrad des Schadens in den Inhalten.
severityScore

number

Nur Ausgabe. Schweregradbewertung für Schäden.
blocked

boolean

Nur Ausgabe. Gibt an, ob die Inhalte aufgrund dieser Altersfreigabe herausgefiltert wurden.

HarmCategory

Schadenskategorien, die Inhalte 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 explizite Inhalte.
HARM_CATEGORY_CIVIC_INTEGRITY Die Schadenskategorie ist bürgerliche Integrität.

HarmProbability

Wahrscheinlichkeitsstufen für Schäden im Inhalt.

Enums
HARM_PROBABILITY_UNSPECIFIED Die Wahrscheinlichkeit von Schäden ist nicht angegeben.
NEGLIGIBLE Geringfügiges Schadensrisiko.
LOW Geringes Schadensrisiko.
MEDIUM Mittleres Schadensrisiko.
HIGH Hohes Maß an Schaden.

HarmSeverity

Schweregrade von Schäden.

Enums
HARM_SEVERITY_UNSPECIFIED Der Schweregrad des Schadens ist nicht angegeben.
HARM_SEVERITY_NEGLIGIBLE Geringfügiger 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.