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

Nachrichten in der Unterhaltung.
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. Der Zeitpunkt, zu dem 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".

State

Aufzählung der Status der Unterhaltung.

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

ConversationMessage

Definiert eine Nachricht in der Unterhaltung.

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 für die Erstellung der Nachricht.

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)

Antwort auf die Suche.

TextInput

Definiert die Texteingabe.

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

string

Texteingabe.
context

object (ConversationContext)

Unterhaltungskontext der 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. Enthält die Dokumentressourcenverweise.
activeDocument

string

Das aktuelle aktive Dokument, das der Nutzer geöffnet hat. Enthält den Dokumentressourcenverweis.

Reply

Definiert eine Antwortnachricht an den Nutzer.

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

string

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

object (Reference)

Verweise in der Antwort.
summary

object (Summary)

Zusammenfassung basierend auf den Suchergebnissen.

Reference

Definiert den Verweis in der Antwort.

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

string

URI-Linkverweis.
anchorText

string

Ankertext.
start

integer

Startindex des Ankertexts.
end

integer

Endindex des Ankertexts.

Summary

Zusammenfassung der N wichtigsten Suchergebnisse anhand der angegebenen Zusammenfassungsspezifikation.

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

string

Der Inhalt der Zusammenfassung.
summarySkippedReasons[]

enum (SummarySkippedReason)

Weitere Gründe, warum die Zusammenfassung übersprungen wurde. Damit wird der Grund für das Überspringen angegeben. Wenn nichts übersprungen wird, wird dieses Feld nicht festgelegt.
safetyAttributes

object (SafetyAttributes)

Eine Sammlung der Sicherheitsattributkategorien mit den zugehörigen Konfidenzwerten.
summaryWithMetadata

object (SummaryWithMetadata)

Zusammenfassung mit Metadaten.

SummarySkippedReason

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

Enums
SUMMARY_SKIPPED_REASON_UNSPECIFIED Standardwert. Es wurde kein Grund für das Überspringen der Zusammenfassung angegeben.
ADVERSARIAL_QUERY_IGNORED

Die feindselige Anfrage wird ignoriert.

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

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

Google überspringt die Zusammenfassung, wenn es sich bei der Anfrage um Smalltalk handelt. Wird nur verwendet, wenn SummarySpec.ignore_non_summary_seeking_query auf true festgelegt ist.
OUT_OF_DOMAIN_QUERY_IGNORED

Die Anfrage außerhalb der Domain wird 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

Potenzieller Richtlinienverstoß.

Google überspringt die Zusammenfassung, wenn ein potenzieller Richtlinienverstoß erkannt wird. Dazu gehören gewalttätige oder schädliche Inhalte.
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

Es gibt keine relevanten Inhalte.

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

Verstoß gegen Kundenrichtlinien.

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

Die Anfrage, die nicht auf eine Antwort abzielt, wird 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 festgelegt ist.
TIME_OUT

Zeitüberschreitung.

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 der mit den generierten Inhalten verknüpften Sicherheitsattributkategorien. Die Reihenfolge orientiert sich an den Konfidenzwerten.
scores[]

number

Der Konfidenzwert der einzelnen Kategorien. Ein höherer Wert bedeutet mehr Konfidenz. Die Reihenfolge orientiert sich an 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)

Metadaten der Zitatquellen für die angegebene Zusammenfassung.
references[]

object (Reference)

Dokumentverweise.
blobAttachments[]

object (BlobAttachment)

Nur Ausgabe. Speichert multimodale Daten zur Verbesserung von Antworten.

CitationMetadata

Metadaten zu Zitatquellen.

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

object (Citation)

Quellenangaben für Segmente.

Citation

Quellenangaben 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. Wird in Byte/Unicode gemessen.
endIndex

string (int64 format)

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

object (CitationSource)

Zitatquellen für das zugeordnete Segment.

CitationSource

Zitatquelle

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

string (int64 format)

Dokumentverweisindex aus SummaryWithMetadata.references. Ist null-indexiert; der Wert ist null, wenn der Verweisindex nicht explizit festgelegt wurde.

Reference

Dokumentverweis.

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 Dokuments, auf das verwiesen wird, im Format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
uri

string

Cloud Storage- oder HTTP-URI des Dokuments.
chunkContents[]

object (ChunkContent)

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

ChunkContent

Inhalt der Blöcke.

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

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. 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. Roh-Byte.

Ein base64-codierter String.

AttributionType

Definiert den Attributionstyp des Blobs.

Enums
ATTRIBUTION_TYPE_UNSPECIFIED Attributionstyp nicht angegeben.
CORPUS Die Anhangdaten stammen aus dem Korpus.
GENERATED Die Anhangdaten 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 Sitzungen nach dem übergeordneten Element DataStore auf.

patch

 Aktualisiert eine Unterhaltung.