Vertex AI v1 API - Class Session (3.66.0) 

public sealed class Session : IMessage<Session>, IEquatable<Session>, IDeepCloneable<Session>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1 API class Session.

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

Inheritance

object > Session

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Session()

public Session()

Session(Session)

public Session(Session other)
Parameter
Name Description
other Session

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when the session was created.

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

Optional. The display name of the session.

Property Value
Type Description
string

ExpirationCase

public Session.ExpirationOneofCase ExpirationCase { get; }
Property Value
Type Description
SessionExpirationOneofCase

ExpireTime

public Timestamp ExpireTime { get; set; }

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.

Property Value
Type Description
Timestamp

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

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

Property Value
Type Description
string

SessionName

public SessionName SessionName { get; set; }

SessionName-typed view over the Name resource name property.

Property Value
Type Description
SessionName

SessionState

public Struct SessionState { get; set; }

Optional. Session specific memory which stores key conversation points.

Property Value
Type Description
Struct

Ttl

public Duration Ttl { get; set; }

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

Property Value
Type Description
Duration

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when the session was updated.

Property Value
Type Description
Timestamp

UserId

public string UserId { get; set; }

Required. Immutable. String id provided by the user

Property Value
Type Description
string