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

Aufzählung der Status der Unterhaltung.

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

Runde

Stellt eine Runde dar. Dazu gehört eine Anfrage des Nutzers und eine 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. Sollte nicht festgelegt werden, 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 die Antwortgenerierung (API-Aufruf /answer) in dieser Runde erfolgt ist.
assistAnswer

string

Nur Ausgabe. Der Ressourcenname der Assistentenantwort auf die Nutzeranfrage.

Wird nur festgelegt, wenn in dieser Runde 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 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. Stellt Metadaten zur Anfragekonfiguration 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.

Anfrage

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 Anfrage.
Union-Feld content. Inhalt 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 Element DataStore auf.

patch

 Aktualisiert eine Sitzung.