Vertex AI Search and Conversation has been renamed to Vertex AI Agent Builder. We are in the process of updating content to reflect the new branding.
Send feedback
REST Resource: projects.locations.collections.dataStores.sessions
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Session
External session proto definition.
JSON representation
{
"name" : string ,
"state" : enum (State
) ,
"userPseudoId" : string ,
"turns" : [
{
object (Turn
)
}
] ,
"startTime" : string ,
"endTime" : string
}
Fields
name
string
Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
state
enum (State
)
The state of the session.
userPseudoId
string
A unique identifier for tracking users.
turns[]
object (Turn
)
Turns.
startTime
string (Timestamp
format)
Output only. The time the session started.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
endTime
string (Timestamp
format)
Output only. The time the session finished.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
State
Enumeration of the state of the session.
Enums
STATE_UNSPECIFIED
State is unspecified.
IN_PROGRESS
The session is currently open.
Turn
Represents a turn, including a query from the user and a answer from service.
JSON representation
{
"query" : {
object (Query
)
} ,
"answer" : string
}
Fields
query
object (Query
)
The user query.
answer
string
The resource name of the answer to the user query.
Query
Defines a user inputed query.
JSON representation
{
"queryId" : string ,
// Union field content
can be only one of the following:
"text" : string
// End of list of possible types for union field content
.
}
Fields
queryId
string
Unique Id for the query.
Union field content
. Query content. content
can be only one of the following:
text
string
Plain text.
Methods
Creates a Session.
Deletes a Session.
Gets a Session.
Lists all Sessions by their parent DataStore
.
Updates a Session.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-26 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?