Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Session.
External session proto definition.
Generated from protobuf message google.cloud.discoveryengine.v1.Session
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
↳ display_name
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
int
The state of the session.
↳ user_pseudo_id
string
A unique identifier for tracking users.
↳ turns
↳ start_time
↳ end_time
↳ is_pinned
bool
Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
getName
Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
string
setName
Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
var
string
$this
getDisplayName
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.
string
setDisplayName
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.
var
string
$this
getState
The state of the session.
int
setState
The state of the session.
var
int
Enum of type State .
$this
getUserPseudoId
A unique identifier for tracking users.
string
setUserPseudoId
A unique identifier for tracking users.
var
string
$this
getTurns
Turns.
setTurns
Turns.
$this
getStartTime
Output only. The time the session started.
hasStartTime
clearStartTime
setStartTime
Output only. The time the session started.
$this
getEndTime
Output only. The time the session finished.
hasEndTime
clearEndTime
setEndTime
Output only. The time the session finished.
$this
getIsPinned
Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
bool
setIsPinned
Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
var
bool
$this
