REST Resource: projects.locations.dataStores.sessions

Resource: Session

External session proto definition.

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

string

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Optional. The display name of the session.

This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
state

enum (State)

The state of the session.
userPseudoId

string

A unique identifier for tracking users.
turns[]

object (Turn)

Turns.
labels[]

string

Optional. The labels for the session. This field is used to identify the session in the UI, for example, research assist sessions can set the label to "research assist" to display different icon in the session list.
startTime

string (Timestamp format)

Output only. The time the session started.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Output only. The time the session finished.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
isPinned

boolean

Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.

Methods

create

 Creates a Session.

delete

 Deletes a Session.

get

 Gets a Session.

list

 Lists all Sessions by their parent DataStore.

patch

 Updates a Session.