REST Resource: projects.locations.collections.engines.sessions.assistAnswers

Ressource: AssistAnswer

AssistAnswer-Ressource, Hauptteil von AssistResponse.

JSON-Darstellung 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "diagnosticInfo": {
    object
  },
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "requiredAuthorizations": [
    {
      object (RequiredAuthorization)
    }
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
Felder
name

string

Nicht veränderbar. ID. Ressourcenname von AssistAnswer. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
state

enum (State)

Status der Antwortgenerierung.
replies[]

object (Reply)

Antworten des Assistenten
diagnosticInfo

object (Struct format)

Optional. Diagnoseinformationen, die während der Verarbeitung der Anfrage erfasst wurden. Diese Informationen sind nur für menschliche Leser gedacht, hauptsächlich zur Unterstützung bei der Fehlerbehebung. Die Struktur der Daten kann ohne Vorankündigung geändert werden.
assistSkippedReasons[]

enum (AssistSkippedReason)

Gründe, warum der Supportanruf nicht angenommen wurde.
requiredAuthorizations[]

object (RequiredAuthorization)

Nur Ausgabe. Die Liste der erforderlichen Autorisierungen. Wird nur ausgefüllt, wenn der Nutzer nicht für eine bestimmte Authorization autorisiert ist, der aufgerufene Agent sie aber benötigt.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

Optional. Das Feld enthält Informationen zu den Ergebnissen der verschiedenen Richtlinienprüfungen, z. B. zu verbotenen Begriffen oder Model Armor-Prüfungen. Dieses Feld wird nur ausgefüllt, wenn der Assist-Anruf aufgrund eines Richtlinienverstoßes übersprungen wurde.

Bundesland

Status der Antwortgenerierung.

Enums
STATE_UNSPECIFIED Unbekannt.
IN_PROGRESS Der Assist-Vorgang wird gerade ausgeführt.
FAILED Der Assist-Vorgang ist fehlgeschlagen.
SUCCEEDED Der Assist-Vorgang war erfolgreich.
SKIPPED Der Assist-Vorgang wurde übersprungen.

Antworten

Ein Teil der mehrteiligen Antwort des Assist-Aufrufs.

JSON-Darstellung 
{
  "replyId": string,

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
Felder
replyId

string

Nur Ausgabe. Wenn festgelegt, wird eine Antwort in der AssistAnswer-Ressource eindeutig identifiziert. Während eines AssistantService.StreamAssist-Aufrufs können im Antwortstream (über mehrere [AssistantService.StreamAssistResponse]-Nachrichten hinweg) mehrere Reply-Nachrichten mit derselben ID auftreten. Sie stellen Teile einer einzelnen Reply-Nachricht in der endgültigen AssistAnswer-Ressource dar.
Union-Feld reply. Alternativen für die Antwort des Assistenten. Für reply ist nur einer der folgenden Werte zulässig:
groundedContent

object (AssistantGroundedContent)

Möglicherweise auf Fakten basierender Antworttext oder Medien vom Assistenten.

AssistantGroundedContent

Ein Inhalt und möglicherweise die zugehörigen Fundierungsinformationen.

Nicht für alle Inhalte ist eine Fundierung erforderlich. Formulierungen wie „Natürlich suche ich gerne für Sie danach“ müssen nicht belegt werden.

JSON-Darstellung 
{
  "content": {
    object (AssistantContent)
  },
  "citationMetadata": {
    object (CitationMetadata)
  },
  "contentMetadata": {
    object (ContentMetadata)
  },

  // Union field metadata can be only one of the following:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of list of possible types for union field metadata.
}
Felder
content

object (AssistantContent)

Der Inhalt.
citationMetadata

object (CitationMetadata)

Quellenangabe für die generierten Inhalte. Siehe auch https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check.
contentMetadata

object (ContentMetadata)

Optional: Metadaten für den Inhalt. Wird derzeit nur für Antworten von Forschungsassistenten verwendet.
Union-Feld metadata. Fundierungsmetadaten für verschiedene Modale. Derzeit wird nur Text unterstützt. Für metadata ist nur einer der folgenden Werte zulässig:
textGroundingMetadata

object (TextGroundingMetadata)

Metadaten für die Fundierung auf Grundlage von Textquellen.

TextGroundingMetadata

Details zur Fundierung für Textquellen.

JSON-Darstellung 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "searchEntryPoints": [
    {
      object (SearchEntryPoint)
    }
  ]
}
Felder
segments[]

object (Segment)

Grundlageninformationen für Teile des Texts.
references[]

object (Reference)

Referenzen für den fundierten Text.
searchEntryPoints[]

object (SearchEntryPoint)

Optional. Einstiegspunkte für die Google Suche für die Websuchen, die für die Fundierung verwendet werden.

Segment

Grundlageninformationen für ein Textsegment.

JSON-Darstellung 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
Felder
startIndex

string (int64 format)

Nullbasierter Index, der den Beginn des Segments angibt, gemessen in Byte eines UTF-8-Strings (d.h. Zeichen, die in mehreren Byte codiert sind, haben eine Länge von mehr als eins).
endIndex

string (int64 format)

Ende des Segments, exklusiv.
referenceIndices[]

integer

Referenzen für das Segment.
groundingScore

number

Punktzahl für das Segment.
text

string

Das Textsegment selbst.

Referenz

Referenzierte Inhalte und zugehörige Dokumentmetadaten.

JSON-Darstellung 
{
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
Felder
content

string

Referenzierter Textinhalt.
documentMetadata

object (DocumentMetadata)

Dokumentmetadaten

DocumentMetadata

Dokumentmetadaten

JSON-Darstellung 
{
  "boundingBoxes": [
    {
      object (BoundingBox)
    }
  ],
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
Felder
boundingBoxes[]

object (BoundingBox)

Optional. Begrenzungsrahmen für diese Referenz. Wird wiederholt, um Referenzen zu unterstützen, die sich über mehrere Seiten erstrecken.
document

string

Name der Dokumentressource.
uri

string

URI für das Dokument. Sie kann eine URL enthalten, die zur eigentlichen Website weiterleitet.
title

string

Titel:
pageIdentifier

string

Seiten-ID.
domain

string

Domainname aus dem Dokument-URI. Das Feld uri kann eine URL enthalten, die zur eigentlichen Website weiterleitet. In diesem Fall enthält es den Domainnamen der Zielwebsite.
mimeType

string

Der MIME-Typ des Dokuments. https://www.iana.org/assignments/media-types/media-types.xhtml.

BoundingBox

Ein Begrenzungsrahmen, der eine einzelne Seite umfasst.

JSON-Darstellung 
{
  "pageNumber": string,
  "boundingPoly": {
    object (BoundingPoly)
  }
}
Felder
pageNumber

string
boundingPoly

object (BoundingPoly)

Begrenzungspolygon für den Textinhalt im Dokument.

BoundingPoly

Begrenzungspolygon für den Textinhalt im Dokument.

JSON-Darstellung 
{
  "normalizedVertices": [
    {
      object (NormalizedVertex)
    }
  ]
}
Felder
normalizedVertices[]

object (NormalizedVertex)

NormalizedVertex

Ein Scheitelpunkt repräsentiert einen 2D-Punkt im Bild.

HINWEIS: Die normalisierten Eckpunktkoordinaten sind relativ zum Originalbild und reichen von 0 bis 1.

JSON-Darstellung 
{
  "x": number,
  "y": number
}
Felder
x

number

X-Koordinate
y

number

Y-Koordinate (beginnt oben im Bild).

SearchEntryPoint

Einstiegspunkt in der Google Suche.

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

string

Webinhalts-Snippet, das in eine Webseite oder eine App-Webview eingebettet werden kann.

AssistantContent

Multimodale Inhalte.

JSON-Darstellung 
{
  "role": string,
  "thought": boolean,

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of list of possible types for union field data.
}
Felder
role

string

Der Produzent des Inhalts. Kann „model“ oder „user“ sein.
thought

boolean

Optional. Gibt an, ob der Teil vom Modell generiert wurde.
Union-Feld data. Enthaltene Daten. Für data ist nur einer der folgenden Werte zulässig:
text

string

Inline-Text
inlineData

object (Blob)

Inline-Binärdaten.
file

object (File)

Eine Datei, z.B. eine Audiozusammenfassung.
executableCode

object (ExecutableCode)

Vom Modell generierter Code, der ausgeführt werden soll.
codeExecutionResult

object (CodeExecutionResult)

Ergebnis der Ausführung von ExecutableCode.

Blob

Inline-Blob

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

string

Erforderlich. Der Medientyp (MIME-Typ) der generierten Daten.
data

string (bytes format)

Erforderlich. Rohbyte.

Ein base64-codierter String.

Datei

Eine Datei, z.B. eine Audiozusammenfassung.

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

string

Erforderlich. Der Medientyp (MIME-Typ) der Datei.
fileId

string

Erforderlich. Die Datei-ID.

ExecutableCode

Code, der vom Modell generiert wird und vom Modell ausgeführt werden soll.

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

string

Erforderlich. Der Code-Inhalt. Derzeit wird nur Python unterstützt.

CodeExecutionResult

Ergebnis der Ausführung von ExecutableCode.

JSON-Darstellung 
{
  "outcome": enum (Outcome),
  "output": string
}
Felder
outcome

enum (Outcome)

Erforderlich. Ergebnis der Codeausführung.
output

string

Optional. Enthält stdout, wenn die Codeausführung erfolgreich ist, andernfalls stderr oder eine andere Beschreibung.

Ergebnis

Auflistung der möglichen Ergebnisse der Codeausführung.

Enums
OUTCOME_UNSPECIFIED Nicht angegebener Status. Dieser Wert sollte nicht verwendet werden.
OUTCOME_OK Die Codeausführung wurde erfolgreich abgeschlossen.
OUTCOME_FAILED Die Codeausführung wurde abgeschlossen, aber mit einem Fehler. stderr sollte den Grund enthalten.
OUTCOME_DEADLINE_EXCEEDED Die Codeausführung dauerte zu lange und wurde abgebrochen. Möglicherweise ist eine Teilausgabe vorhanden.

Zitat-MetadatenS

Eine Sammlung von Quellenangaben für einen Inhalt.

JSON-Darstellung 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
Felder
citations[]

object (Citation)

Nur Ausgabe. Liste der Zitationen.

Quellenangabe

Quellenangaben für Inhalte.

JSON-Darstellung 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
Felder
startIndex

integer

Nur Ausgabe. Startindex im Inhalt.
endIndex

integer

Nur Ausgabe. Endindex für den Inhalt.
uri

string

Nur Ausgabe. URL-Referenz der Quellenangabe.
title

string

Nur Ausgabe. Der Titel des Attributs.
license

string

Nur Ausgabe. Lizenz der Namensnennung.
publicationDate

object (Date)

Nur Ausgabe. Das Veröffentlichungsdatum der Quellenangabe.

ContentMetadata

Metadaten für die Inhalte.

JSON-Darstellung 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
Felder
contentKind

enum (ContentKind)

Art des Inhalts. Hier sehen Sie, zu welchem Teil der Antwort des Rechercheassistenten dieser Inhalt gehört.
contentId

string

ID des Inhalts. Sie wird verwendet, um Forschungsfragen mit Antworten darauf zu verknüpfen. Die Teile der Antwort auf eine Forschungsfrage haben beispielsweise dieselbe contentId wie die Frage.

ContentKind

Mögliche Arten von Inhalten. Wird derzeit nur verwendet, um Abschnitte in der vollständigen Antwort eines Research-Assistenten zu unterscheiden.

Enums
CONTENT_KIND_UNSPECIFIED Unbekannt.
RESEARCH_PLAN Forschungsplan.
RESEARCH_QUESTION Forschungsfrage.
RESEARCH_ANSWER Antwort auf die Frage.
RESEARCH_REPORT Forschungsbericht.
RESEARCH_AUDIO_SUMMARY Audiozusammenfassung durchsuchen

AssistSkippedReason

Mögliche Gründe für das Nichtbeantworten eines Supportanrufs.

Enums
ASSIST_SKIPPED_REASON_UNSPECIFIED Standardwert. Der Grund für das Überspringen wird nicht angegeben.
NON_ASSIST_SEEKING_QUERY_IGNORED Der Assistent hat die Anfrage ignoriert, da sie nicht auf eine Antwort ausgerichtet war.
CUSTOMER_POLICY_VIOLATION Der Assistent hat die Anfrage ignoriert oder die Antwort verweigert, weil gegen eine Kundenrichtlinie verstoßen wurde (z.B. weil die Anfrage oder die Antwort eine verbotene Wortgruppe enthielt).

RequiredAuthorization

Stellt eine Autorisierung dar, die für die Funktion des Agents erforderlich ist.

JSON-Darstellung 
{
  "authorization": string,
  "displayName": string,
  "authorizationUri": string
}
Felder
authorization

string

Nur Ausgabe. Der Name der Authorization.
displayName

string

Nur Ausgabe. Der Anzeigename der Autorisierung.
authorizationUri

string

Nur Ausgabe. Die URI, die der Nutzer zum Autorisieren öffnen sollte.

CustomerPolicyEnforcementResult

Ergebnisse der Durchsetzung von Kundenrichtlinien. Enthält die Ergebnisse der verschiedenen Richtlinienprüfungen, z. B. der Prüfungen auf verbotene Begriffe oder der Model Armor-Prüfungen.

JSON-Darstellung 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ]
}
Felder
verdict

enum (Verdict)

Endgültiges Urteil zur Durchsetzung der Kundenrichtlinie. Wenn die Verarbeitung nur durch eine Richtlinie blockiert wurde, lautet das Ergebnis BLOCK.
policyResults[]

object (PolicyEnforcementResult)

Ergebnisse der Durchsetzung von Kundenrichtlinien. Wird nur ausgefüllt, wenn der Assist-Anruf aufgrund eines Richtlinienverstoßes übersprungen wurde. Sie enthält Ergebnisse von Filtern, die die Verarbeitung der Abfrage blockiert haben.

Urteil

Das Ergebnis der Durchsetzung der Kundenrichtlinie.

Enums
UNSPECIFIED Unbekannter Wert.
ALLOW Es lag kein Richtlinienverstoß vor.
BLOCK Die Verarbeitung wurde durch die Kundenrichtlinie blockiert.

PolicyEnforcementResult

Ergebnis der Durchsetzung der Kundenrichtlinie für einen einzelnen Richtlinientyp.

JSON-Darstellung 
{

  // Union field enforcement_result can be only one of the following:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of list of possible types for union field enforcement_result.
}
Felder
Union-Feld enforcement_result. Das spezifische Ergebnis des Richtlinientyps. Es kann sich entweder um einen Fehler oder um detaillierte Informationen zum Ergebnis der Richtliniendurchsetzung handeln. Für enforcement_result ist nur einer der folgenden Werte zulässig:
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

Das Ergebnis der Richtlinienerzwingung für die Richtlinie für verbotene Begriffe.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Das Ergebnis der Richtlinienerzwingung für die Model Armor-Richtlinie.

BannedPhraseEnforcementResult

Ergebnis der Richtliniendurchsetzung für die Richtlinie zu verbotenen Begriffen.

JSON-Darstellung 
{
  "bannedPhrases": [
    string
  ]
}
Felder
bannedPhrases[]

string

Die verbotenen Begriffe, die in der Anfrage oder der Antwort gefunden wurden.

ModelArmorEnforcementResult

Ergebnis der Richtliniendurchsetzung für Kunden für die Model Armor-Richtlinie.

JSON-Darstellung 
{

  // Union field result can be only one of the following:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Felder
Union-Feld result. Das Ergebnis der Model Armor-Richtlinie. Für result ist nur einer der folgenden Werte zulässig:
modelArmorViolation

string

Der gefundene Model Armor-Verstoß.
error

object (Status)

Der von Model Armor zurückgegebene Fehler, wenn die Richtlinienerzwingung aus irgendeinem Grund fehlgeschlagen ist.

Methoden

get

 Ruft ein AssistAnswer ab.