REST Resource: projects.locations.reasoningEngines.sessions

Resource: Session

A session contains a set of actions between users and Vertex agents.

Fields
name string

Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}/sessions/{session}'.

createTime string (Timestamp format)

Output only. timestamp when the session was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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".

updateTime string (Timestamp format)

Output only. timestamp when the session was updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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".

displayName string

Optional. The display name of the session.

sessionState object (Struct format)

Optional. Session specific memory which stores key conversation points.

userId string

Required. Immutable. String id provided by the user

expiration Union type
The expiration of the session. expiration can be only one of the following:
expireTime string (Timestamp format)

Optional. timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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".

ttl string (Duration format)

Optional. Input only. The TTL for this session.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "displayName": string,
  "sessionState": {
    object
  },
  "userId": string,

  // expiration
  "expireTime": string,
  "ttl": string
  // Union type
}

Methods

appendEvent

 Appends an event to a given session.

create

 Creates a new Session.

delete

 Deletes details of the specific Session.

get

 Gets details of the specific Session.

list

 Lists Sessions in a given reasoning engine.

patch

 Updates the specific Session.