Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Session.
A session contains a set of actions between users and Vertex agents.
Generated from protobuf message google.cloud.aiplatform.v1.Session
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ expire_time
Google\Protobuf\Timestamp
Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.
↳ ttl
Google\Protobuf\Duration
Optional. Input only. The TTL for this session. The minimum value is 24 hours.
↳ name
string
Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
↳ create_time
↳ update_time
↳ display_name
string
Optional. The display name of the session.
↳ labels
array| Google\Protobuf\Internal\MapField
The labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
↳ session_state
↳ user_id
string
Required. Immutable. String id provided by the user
getExpireTime
Optional. Timestamp of when this session is considered expired.
This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.
hasExpireTime
setExpireTime
Optional. Timestamp of when this session is considered expired.
This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.
$this
getTtl
Optional. Input only. The TTL for this session.
The minimum value is 24 hours.
hasTtl
setTtl
Optional. Input only. The TTL for this session.
The minimum value is 24 hours.
$this
getName
Identifier. The resource name of the session.
Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
string
setName
Identifier. The resource name of the session.
Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
var
string
$this
getCreateTime
Output only. Timestamp when the session was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when the session was created.
$this
getUpdateTime
Output only. Timestamp when the session was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when the session was updated.
$this
getDisplayName
Optional. The display name of the session.
string
setDisplayName
Optional. The display name of the session.
var
string
$this
getLabels
The labels with user-defined metadata to organize your Sessions.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
setLabels
The labels with user-defined metadata to organize your Sessions.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
$this
getSessionState
Optional. Session specific memory which stores key conversation points.
hasSessionState
clearSessionState
setSessionState
Optional. Session specific memory which stores key conversation points.
$this
getUserId
Required. Immutable. String id provided by the user
string
setUserId
Required. Immutable. String id provided by the user
var
string
$this
getExpiration
string
