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)
    }
  ],
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "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
assistSkippedReasons[]

enum (AssistSkippedReason)

Gründe, warum der Assist-Aufruf nicht angenommen wurde
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

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

Status

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 
{

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
Felder
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 fundierter Antworttext oder Medien vom Assistenten

AssistantGroundedContent

Ein bestimmter 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 fundiert 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 Recherche-Assistenten verwendet.
Union-Feld metadata. Fundierungsmetadaten für verschiedene Modalitäten. 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)
    }
  ]
}
Felder
segments[]

object (Segment)

Fundierungsinformationen für Teile des Texts
references[]

object (Reference)

Referenzen für den fundierten Text

Segment

Fundierungsinformationen 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

Wert 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 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
Felder
document

string

Name der Dokumentressource
uri

string

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

string

Titel
pageIdentifier

string

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

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 zu den Überlegungen des Modells gehört.
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 eines ExecutableCode

Blob

Inline-Blob.

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

string

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

string (bytes format)

Pflichtfeld. Roh-Byte.

Ein base64-codierter String.

Datei

Eine Datei, z. B. eine Audiozusammenfassung

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

string

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

string

Pflichtfeld. Die Datei-ID.

ExecutableCode

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

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

string

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

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

CitationMetadata

Eine Sammlung von Quellenangaben für einen bestimmten Inhalt

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

object (Citation)

Nur Ausgabe. Liste der Quellenangaben.

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 im Inhalt.
uri

string

Nur Ausgabe. URL-Verweis der Angabe.
title

string

Nur Ausgabe. Titel der Angabe.
license

string

Nur Ausgabe. Lizenz der Angabe.
publicationDate

object (Date)

Nur Ausgabe. Veröffentlichungsdatum der Angabe.

ContentMetadata

Metadaten für die Inhalte

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

enum (ContentKind)

Art des Inhalts. Zeigt an, zu welchem Teil der Antwort des Recherche-Assistenten dieser Inhalt gehört.
contentId

string

ID des Inhalts. Sie wird verwendet, um Recherchefragen mit Antworten darauf zu verknüpfen. Die Teile der Antwort auf eine Recherchefrage 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 Recherche-Assistenten zu unterscheiden.

Enums
CONTENT_KIND_UNSPECIFIED Unbekannt
RESEARCH_PLAN Rechercheplan
RESEARCH_QUESTION Recherchefrage
RESEARCH_ANSWER Rechercheantwort
RESEARCH_REPORT Recherchebericht
RESEARCH_AUDIO_SUMMARY Recherche-Audiozusammenfassung

AssistSkippedReason

Mögliche Gründe für das Nichtbeantworten eines Assist-Aufrufs

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 so erschien, als wäre sie auf eine Antwort ausgerichtet.
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).

CustomerPolicyEnforcementResult

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

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

enum (Verdict)

Endgültiges Ergebnis der 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-Aufruf aufgrund eines Richtlinienverstoßes übersprungen wurde. Sie enthalten Ergebnisse von den Filtern, die die Verarbeitung der Anfrage blockiert haben.

Einstufung

Das Ergebnis der Durchsetzung der Kundenrichtlinie

Enums
UNSPECIFIED Der Wert ist unbekannt.
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 Richtliniendurchsetzung für die Richtlinie für verbotene Wortgruppen
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Das Ergebnis der Richtliniendurchsetzung für die Model Armor-Richtlinie

BannedPhraseEnforcementResult

Ergebnis der Richtliniendurchsetzung für die Richtlinie für verbotene Wortgruppen

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

string

Die verbotenen Wortgruppen, die in der Anfrage oder der Antwort gefunden wurden

ModelArmorEnforcementResult

Das Ergebnis der Durchsetzung der Kundenrichtlinie 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 Richtliniendurchsetzung aus irgendeinem Grund fehlgeschlagen ist

Methoden

get

 Ruft eine AssistAnswer ab