Discovery Engine v1 API - Class Session (1.7.0)

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

Reference documentation and code samples for the Discovery Engine v1 API class Session.

External session proto definition.

Inheritance

object > Session

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

Session()

public Session()

Session(Session)

public Session(Session other)
Parameter
Name Description
other Session

Properties

DisplayName

public string DisplayName { get; set; }

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.

Property Value
Type Description
string

EndTime

public Timestamp EndTime { get; set; }

Output only. The time the session finished.

Property Value
Type Description
Timestamp

IsPinned

public bool IsPinned { get; set; }

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

Property Value
Type Description
bool

Name

public string Name { get; set; }

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

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

StartTime

public Timestamp StartTime { get; set; }

Output only. The time the session started.

Property Value
Type Description
Timestamp

State

public Session.Types.State State { get; set; }

The state of the session.

Property Value
Type Description
SessionTypesState

Turns

public RepeatedField<Session.Types.Turn> Turns { get; }

Turns.

Property Value
Type Description
RepeatedFieldSessionTypesTurn

UserPseudoId

public string UserPseudoId { get; set; }

A unique identifier for tracking users.

Property Value
Type Description
string