Google Cloud Ai Platform V1 Client - Class CreateSessionRequest (1.56.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class CreateSessionRequest.

Request message for SessionService.CreateSession .

Generated from protobuf message google.cloud.aiplatform.v1.CreateSessionRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

↳ session
Session

Required. The session to create.

↳ session_id
string

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are [a-z0-9-] . The first character must be a letter, and the last character must be a letter or number.

getParent

Required. The resource name of the location to create the session in.

Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

Returns
Type
Description
string

setParent

Required. The resource name of the location to create the session in.

Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSession

Required. The session to create.

Returns
Type
Description
Session |null

hasSession

clearSession

setSession

Required. The session to create.

Parameter
Name
Description
var
Returns
Type
Description
$this

getSessionId

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID.

This value may be up to 63 characters, and valid characters are [a-z0-9-] . The first character must be a letter, and the last character must be a letter or number.

Returns
Type
Description
string

setSessionId

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID.

This value may be up to 63 characters, and valid characters are [a-z0-9-] . The first character must be a letter, and the last character must be a letter or number.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameters
Name
Description
parent
string

Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} Please see SessionServiceClient::reasoningEngineName() for help formatting this field.

session
Session

Required. The session to create.

Returns
Type
Description

static::buildFromParentSessionSessionId

Parameters
Name
Description
parent
string

Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} Please see SessionServiceClient::reasoningEngineName() for help formatting this field.

session
Session

Required. The session to create.

sessionId
string

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID.

This value may be up to 63 characters, and valid characters are [a-z0-9-] . The first character must be a letter, and the last character must be a letter or number.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: