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

Ressource: Sitzung

Externe Sitzung – Proto-Definition.

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. Vollständig 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 Benutzeroberfläche identifiziert. Standardmäßig ist der Anzeigename 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)

Runden.
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 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 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. Ob die Sitzung angepinnt ist. Angepinnte Sitzungen werden oben in der Sitzungsliste angezeigt.

Bundesland

Aufzählung des Status der Sitzung.

Enums
STATE_UNSPECIFIED Zustand unbekannt.
IN_PROGRESS Die Sitzung ist derzeit geöffnet.

Runde

Stellt einen Turn dar, einschließlich 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. Darf nicht festgelegt werden, wenn bei diesem Zug lediglich eine Antwort auf einen anderen Zug neu generiert wird.
answer

string

Optional. Der Ressourcenname der Antwort auf die Nutzeranfrage.

Wird nur festgelegt, wenn die Antwortgenerierung (API-Aufruf /answer) in diesem Zug erfolgt ist.
assistAnswer

string

Nur Ausgabe. Der Ressourcenname der Assistant-Antwort auf die Nutzeranfrage.

Wird nur festgelegt, wenn in diesem Zug ein Assist-Aufruf (/assist API-Aufruf) erfolgt ist.

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 API „AssistAnswerService.GetAssistAnswer“ 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 Antwortabfragesitzung 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 Assistenten-Sitzung ausgefüllt.
queryConfig

map (key: string, value: string)

Optional. Stellt Metadaten zur Abfragekonfiguration dar, z. B. das verwendete LLM-Modell und die Version sowie Modellparameter (Temperatur, Grounding-Parameter usw.). Das Präfix „google.“ ist für von Google entwickelte Funktionen reserviert.

Abfrage

Definiert eine vom Nutzer eingegebene Anfrage.

JSON-Darstellung 
{
  "queryId": string,

  // 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 Abfrage.
Union-Feld content. Inhalte der Anfrage. Für content ist nur einer der folgenden Werte zulässig:
text

string

Nur Text

Methoden

create

 Erstellt eine Sitzung.

delete

 Löscht eine Sitzung.

get

 Ruft eine Sitzung ab.

list

 Listet alle Sitzungen nach dem übergeordneten DataStore auf.

patch

 Aktualisiert eine Sitzung.