Session(mapping=None, *, ignore_unknown_fields=False, **kwargs)External session proto definition.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
|
display_name |
str
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 |
google.cloud.discoveryengine_v1.types.Session.State
The state of the session. |
user_pseudo_id |
str
A unique identifier for tracking users. |
turns |
MutableSequence[google.cloud.discoveryengine_v1.types.Session.Turn]
Turns. |
start_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time the session started. |
end_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time the session finished. |
is_pinned |
bool
Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. |
Classes
State
State(value)Enumeration of the state of the session.
Turn
Turn(mapping=None, *, ignore_unknown_fields=False, **kwargs)Represents a turn, including a query from the user and a answer from service.