REST Resource: projects.locations.collections.dataStores.conversations

Ressource: Unterhaltung

Proto-Definition für externe Unterhaltungen.

JSON-Darstellung 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
Felder
name

string

Nicht veränderbar. Vollständig qualifizierter Name projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* oder projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
state

enum (State)

Der Status der Unterhaltung.
userPseudoId

string

Eine eindeutige Kennung für das Tracking von Nutzern.
messages[]

object (ConversationMessage)

Unterhaltungsnachrichten.
startTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Unterhaltung begonnen hat.

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".
endTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Unterhaltung beendet wurde.

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

Bundesland

Aufzählung des Status der Unterhaltung.

Enums
STATE_UNSPECIFIED Unbekannt.
IN_PROGRESS Die Unterhaltung ist derzeit geöffnet.
COMPLETED Die Unterhaltung ist beendet.

ConversationMessage

Definiert eine Unterhaltungsnachricht.

JSON-Darstellung 
{
  "createTime": string,

  // Union field message can be only one of the following:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of list of possible types for union field message.
}
Felder
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Nachrichtenerstellung.

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

Union-Feld message.

Für message ist nur einer der folgenden Werte zulässig:
userInput

object (TextInput)

Texteingabe durch Nutzer.
reply

object (Reply)

Suchantwort.

TextInput

Definiert die Texteingabe.

JSON-Darstellung 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
Felder
input

string

Texteingabe
context

object (ConversationContext)

Kontext der Unterhaltung für die Eingabe.

ConversationContext

Definiert den Kontext der Unterhaltung

JSON-Darstellung 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
Felder
contextDocuments[]

string

Die aktuelle Liste der Dokumente, die der Nutzer sieht. Sie enthält die Dokumentressourcenreferenzen.
activeDocument

string

Das aktuelle aktive Dokument, das der Nutzer geöffnet hat. Sie enthält die Dokumentressourcenreferenz.

Antworten

Definiert eine Antwortnachricht für den Nutzer.

JSON-Darstellung 
{
  "reply": string,
  "references": [
    {
      object (Reference)
    }
  ],
  "summary": {
    object (Summary)
  }
}
Felder
reply
(deprecated)

string

VERWORFEN: Verwenden Sie stattdessen summary. Textantwort.
references[]
(deprecated)

object (Reference)

Referenzen in der Antwort.
summary

object (Summary)

Zusammenfassung basierend auf Suchergebnissen.

Referenz

Definiert die Referenz in der Antwort.

JSON-Darstellung 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
Felder
uri

string

URI-Link-Referenz.
anchorText

string

Ankertext.
start

integer

Startindex des Ankertexts.
end

integer

Endindex des Ankertexts.

Zusammenfassung

Zusammenfassung der N Top-Suchergebnisse, die in der Zusammenfassungsspezifikation angegeben sind.

JSON-Darstellung 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
Felder
summaryText

string

Der Inhalt der Zusammenfassung.
summarySkippedReasons[]

enum (SummarySkippedReason)

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

object (SafetyAttributes)

Eine Sammlung von Sicherheitsattributkategorien und den zugehörigen Konfidenzwerten.
summaryWithMetadata

object (SummaryWithMetadata)

Zusammenfassung mit Metadaten.

SummarySkippedReason

Ein Enum für Gründe, warum Zusammenfassungen übersprungen wurden.

Enums
SUMMARY_SKIPPED_REASON_UNSPECIFIED Standardwert. Der Grund für das Überspringen der Zusammenfassung ist nicht angegeben.
ADVERSARIAL_QUERY_IGNORED

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

Wird nur verwendet, wenn SummarySpec.ignore_adversarial_query auf true festgelegt ist.
NON_SUMMARY_SEEKING_QUERY_IGNORED

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

Google überspringt die Zusammenfassung, wenn die Anfrage Smalltalk ist. Wird nur verwendet, wenn SummarySpec.ignore_non_summary_seeking_query auf true festgelegt ist.
OUT_OF_DOMAIN_QUERY_IGNORED

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

Google überspringt die Zusammenfassung, wenn es keine Suchergebnisse mit hoher Relevanz gibt. Der Datenspeicher enthält beispielsweise Fakten zu Unternehmen A, in der Nutzeranfrage werden jedoch Fragen zu Unternehmen B gestellt.
POTENTIAL_POLICY_VIOLATION

Der Fall des potenziellen Richtlinienverstoßes.

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

Das LLM-Add-on ist nicht aktiviert.

Google überspringt die Zusammenfassung, wenn das LLM-Add-on nicht aktiviert ist.
NO_RELEVANT_CONTENT

Der Fall „Keine relevanten Inhalte“.

Google überspringt die Zusammenfassung, 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.“ Wird nur verwendet, wenn [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] auf true gesetzt ist.
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_SUMMARY_SEEKING_QUERY_IGNORED_V2

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

Google überspringt die Zusammenfassung, wenn die Anfrage keine klare Intention hat. Wird nur verwendet, wenn [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] auf true gesetzt ist.
TIME_OUT

Das Case für alle Fälle.

Google überspringt die Zusammenfassung, wenn die Zeit abgelaufen ist.

SafetyAttributes

Sicherheitsattributkategorien und die zugehörigen Konfidenzwerte.

JSON-Darstellung 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
Felder
categories[]

string

Die Anzeigenamen von mit den generierten Inhalten verknüpften Sicherheitsattributkategorien. Die Reihenfolge entspricht den Scores.
scores[]

number

Ein Konfidenzwert für die einzelnen Kategorien; ein höherer Wert bedeutet mehr Vertrauen. Die Reihenfolge entspricht den Kategorien.

SummaryWithMetadata

Zusammenfassung mit Metadaten.

JSON-Darstellung 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ]
}
Felder
summary

string

Zusammenfassungstext ohne Quellenangaben.
citationMetadata

object (CitationMetadata)

Zitier-Metadaten für die angegebene Zusammenfassung.
references[]

object (Reference)

Dokumentreferenzen
blobAttachments[]

object (BlobAttachment)

Nur Ausgabe. Multimodale Daten zur Verbesserung von Antworten speichern.

Zitat-MetadatenS

Zitat-Metadaten.

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

object (Citation)

Zitationen für Segmente.

Quellenangabe

Zitierinformationen für ein Segment.

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

string (int64 format)

Der Index gibt den Anfang des Segments an, gemessen in Byte/Unicode.
endIndex

string (int64 format)

Ende des zugeordneten Segments (ausschließlich).
sources[]

object (CitationSource)

Zitationsquellen für das zugeordnete Segment.

CitationSource

Zitationsquelle.

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

string (int64 format)

Dokumentreferenzindex aus SummaryWithMetadata.references. Er ist nullbasiert und der Wert ist null, wenn „referenceIndex“ nicht explizit festgelegt ist.

Referenz

Dokumentreferenz.

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

string

Titel des Dokuments.
document

string

Erforderlich. Document.name des Dokuments. Vollständiger Ressourcenname des referenzierten Dokuments im Format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
uri

string

Cloud Storage- oder HTTP-URI für das Dokument.
chunkContents[]

object (ChunkContent)

Liste der zitierten Chunks, die aus Dokumentinhalten abgeleitet wurden.

ChunkContent

Inhalte in Chunks aufteilen

JSON-Darstellung 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ]
}
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.

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. Die Blob-Daten.
attributionType

enum (AttributionType)

Nur Ausgabe. Der Attributionstyp des Blobs.

Blob

Speichert Typ und Daten des Blobs.

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

string

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

string (bytes format)

Nur Ausgabe. Rohbyte.

Ein base64-codierter String.

AttributionType

Definiert den Attributionstyp 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.

Methoden

converse

 Führt eine Unterhaltung.

create

 Erstellt eine Unterhaltung.

delete

 Löscht eine Unterhaltung.

get

 Ruft eine Unterhaltung ab.

list

 Listet alle Unterhaltungen nach ihrem übergeordneten Element DataStore auf.

patch

 Aktualisiert eine Unterhaltung.