Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::CreateSessionRequest (v1.40.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::CreateSessionRequest.

Request message for SessionService.CreateSession.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
Returns
  • (::String) — Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

#session

def session() -> ::Google::Cloud::AIPlatform::V1::Session
Returns

#session=

def session=(value) -> ::Google::Cloud::AIPlatform::V1::Session
Parameter
Returns

#session_id

def session_id() -> ::String
Returns
  • (::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.

#session_id=

def session_id=(value) -> ::String
Parameter
  • value (::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
  • (::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.