Method: projects.locations.collections.engines.sessions.get
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://discoveryengine.googleapis.com/v1beta/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The resource name of the Session to get. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/sessions/{sessionId}
|
Query parameters
| Parameters |
includeAnswerDetails |
boolean
Optional. If set to true, the full session including all answer details will be returned.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Session.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name resource:
discoveryengine.sessions.get
For more information, see the IAM documentation.
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 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This endpoint retrieves a specific Session resource using a `GET` request and requires the Session's resource name, which follows a specific format including project, location, collection, data store, and session identifiers."],["The URL structure adheres to gRPC Transcoding syntax, and the `name` parameter, included as part of the URL, is mandatory."],["An optional `includeAnswerDetails` query parameter can be set to `true` to include complete session answer details in the response."],["The request body must be left empty, and a successful request returns a `Session` object in the response body."],["To successfully use this endpoint, the caller must have the `discoveryengine.sessions.get` IAM permission on the specified resource and must also use the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
