Method: projects.locations.collections.engines.sessions.get

Gets a Session.

HTTP request

GET https://discoveryengine.googleapis.com/v1/{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.