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

Ressource: Sitzung

Proto-Definition für externe Unterhaltungen.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
Felder
name

string

Nicht veränderbar. Voll qualifizierter Name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*.
displayName

string

Optional. Der Anzeigename der Sitzung.

Mit diesem Feld wird die Sitzung in der UI identifiziert. Der Anzeigename ist standardmäßig der Text der ersten Anfrage in der Sitzung.
state

enum (State)

Der Status der Sitzung.
userPseudoId

string

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

object (Turn)

Schritte in der Sitzung.
labels[]

string

Optional. Die Labels für die Sitzung. Kann als Filter in „ListSessionsRequest“ festgelegt werden.
startTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Sitzung begonnen 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"
endTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Sitzung 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".
isPinned

boolean

Optional. Gibt an, ob die Sitzung angepinnt wurde. Angepinnte Sitzungen werden oben in der Sitzungsliste angezeigt.

Status

Status der Sitzung

Enums
STATE_UNSPECIFIED Kein Status angegeben
IN_PROGRESS Die Sitzung ist aktuell geöffnet.

Runde

Eine Runde, bestehend aus einer Anfrage des Nutzers und einer Antwort des Dienstes

JSON-Darstellung 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  }
}
Felder
query

object (Query)

Optional. Die Nutzeranfrage. Wird möglicherweise nicht festgelegt, wenn in dieser Runde nur eine Antwort für eine andere Runde neu generiert wird.
answer

string

Optional. Der Ressourcenname der Antwort auf die Nutzeranfrage.

Wird nur festgelegt, wenn in dieser Runde die Antwort generiert (/answer API-Aufruf) wurde
assistAnswer

string

Nur Ausgabe. Der Ressourcenname der Assistentenantwort auf die Nutzeranfrage.

Wird nur festgelegt, wenn in dieser Runde ein Assistent aufgerufen (/assist API-Aufruf) wurde

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}. Wenn Sie alle „AssistAnswers“ für eine Sitzung abrufen möchten, setzen Sie GetSessionRequest.include_answer_details auf „true“. Alternativ können Sie die AssistAnswerService.GetAssistAnswer API verwenden, um eine einzelne „AssistAnswer“-Ressource abzurufen.
detailedAnswer

object (Answer)

Nur Ausgabe. Wenn in der ConversationalSearchService.GetSession API GetSessionRequest.include_answer_details auf „true“ gesetzt ist, wird dieses Feld beim Abrufen der Antwortanfragesitzung ausgefüllt.
detailedAssistAnswer

object (AssistAnswer)

Nur Ausgabe. Wenn in der ConversationalSearchService.GetSession API GetSessionRequest.include_answer_details auf „true“ gesetzt ist, wird dieses Feld beim Abrufen der Assistentensitzung ausgefüllt.
queryConfig

map (key: string, value: string)

Optional. Enthält Metadaten zur Anfragekonfiguration, z. B. das LLM-Modell und die Version sowie die Modellparameter (Temperatur, Fundierungsparameter usw.). Das Präfix „google.“ ist für von Google entwickelte Funktionen reserviert.

Anfrage

Definiert eine vom Nutzer eingegebene Anfrage

JSON-Darstellung 
{
  "queryId": string,
  "parts": [
    {
      object (QueryPart)
    }
  ],

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
Felder
queryId

string

Nur Ausgabe. Eindeutige ID für die Anfrage.
parts[]

object (QueryPart)

Inhalte der Anfrage.
Union-Feld content. Inhalt der Anfrage. Für content ist nur einer der folgenden Werte zulässig:
text

string

Nur Text.

QueryPart

Stellt einen Teil oder den gesamten Inhalt dar, der zur Darstellung einer Anfrage verwendet wird. Eine Anfrage kann aus mehreren Teilen bestehen.

JSON-Darstellung 
{
  "mimeType": string,

  // Union field payload can be only one of the following:
  "text": string,
  "uiJsonPayload": string,
  "personReference": {
    object (PersonReference)
  },
  "driveDocumentReference": {
    object (DriveDocumentReference)
  },
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field payload.
}
Felder
mimeType

string

Optional. Der IANA-Standard-MIME-Typ der Daten. Siehe https://www.iana.org/assignments/media-types/media-types.xhtml. Dieses Feld ist optional. Wenn nichts festgelegt ist, wird für das Feld „data“ standardmäßig der MIME-Typ „text/plain“ angenommen.
Union-Feld payload. Die Nutzlast des Abfrageteils. Für payload ist nur einer der folgenden Werte zulässig:
text

string

Textinhalt.
uiJsonPayload

string

Dieses Feld sollte eine UI-Meldung im JSON-Format sein. Ab dem 1. Quartal 2026 wird uiJsonPayload nur für A2UI-Nachrichten unterstützt.
personReference

object (PersonReference)

Bezug auf eine Person.
driveDocumentReference

object (DriveDocumentReference)

Verweis auf ein Google Drive-Dokument.
documentReference

object (DocumentReference)

Andere VAIS-Referenzen Document.

PersonReference

Stellt eine Personenreferenz dar.

JSON-Darstellung 
{
  "documentName": string,
  "personId": string,
  "email": string,
  "displayName": string,
  "displayPhotoUri": string,
  "destinationUri": string,
  "fileId": string
}
Felder
documentName

string

Der vollständige Ressourcenname der Person. Format: projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
personId

string

Die Personen-ID der Person.
email

string

Die E‑Mail-Adresse der Person.
displayName

string

Der Anzeigename der Person.
displayPhotoUri

string

Die URL des Profilbilds der Person.
destinationUri

string

Der Ziel-URI der Person.
fileId

string

Nur Ausgabe. Die Datei-ID der personenbezogenen Daten, die in den Kontextdateien der Sitzung gespeichert sind.

DriveDocumentReference

Stellt eine Google Drive-Dokumentreferenz dar.

JSON-Darstellung 
{
  "driveId": string,
  "documentName": string,
  "displayTitle": string,
  "destinationUri": string,
  "iconUri": string,
  "fileId": string
}
Felder
driveId

string

Die Drive-ID des Dokuments.
documentName

string

Der vollständige Ressourcenname des Dokuments. Format: projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
displayTitle

string

Der Anzeigetitel der Referenz.
destinationUri

string

Der Ziel-URI der Referenz.
iconUri

string

Die Symbol-URI der Drive-Dokumentreferenz.
fileId

string

Nur Ausgabe. Die Datei-ID der in den Sitzungskontextdateien gespeicherten Drive-Dokumentdaten.

DocumentReference

Stellt eine Dokumentreferenz dar.

JSON-Darstellung 
{
  "documentName": string,
  "displayTitle": string,
  "destinationUri": string,
  "iconUri": string,
  "fileId": string,
  "urlForConnector": string
}
Felder
documentName

string

Der vollständige Ressourcenname des Dokuments. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.
displayTitle

string

Der Anzeigetitel der Referenz.
destinationUri

string

Der Ziel-URI der Referenz.
iconUri

string

Die Symbol-URI der Referenz.
fileId

string

Nur Ausgabe. Die Datei-ID der Dokumentdaten, die in den Sitzungskontextdateien gespeichert sind.
urlForConnector

string

Nur Eingabe. Die urlForConnector des Dokuments, das von der föderierten Suche zurückgegeben wurde.

Methoden

create

 Erstellt eine Sitzung.

delete

 Löscht eine Sitzung.

get

 Ruft eine Sitzung ab.

list

 Listet alle Sitzungen nach dem übergeordneten Element DataStore auf.

patch

 Aktualisiert eine Sitzung.