Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SessionServiceClient.
Service Description: Service for managing Sessions and Session-related resources.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
createSession
Creates a Session.
If the Session to create already exists, an ALREADY_EXISTS error is returned.
The async variant is SessionServiceClient::createSessionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\CreateSessionRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\Session |
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\SessionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\CreateSessionRequest;
use Google\Cloud\DiscoveryEngine\V1\Session;
/**
* @param string $formattedParent Full resource name of parent data store. Format:
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
* Please see {@see SessionServiceClient::dataStoreName()} for help formatting this field.
*/
function create_session_sample(string $formattedParent): void
{
// Create a client.
$sessionServiceClient = new SessionServiceClient();
// Prepare the request message.
$session = new Session();
$request = (new CreateSessionRequest())
->setParent($formattedParent)
->setSession($session);
// Call the API and handle any network failures.
try {
/** @var Session $response */
$response = $sessionServiceClient->createSession($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = SessionServiceClient::dataStoreName('[PROJECT]', '[LOCATION]', '[DATA_STORE]');
create_session_sample($formattedParent);
}
deleteSession
Deletes a Session.
If the Session to delete does not exist, a NOT_FOUND error is returned.
The async variant is SessionServiceClient::deleteSessionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\DeleteSessionRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\SessionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DeleteSessionRequest;
/**
* @param string $formattedName The resource name of the Session to delete. Format:
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
* Please see {@see SessionServiceClient::sessionName()} for help formatting this field.
*/
function delete_session_sample(string $formattedName): void
{
// Create a client.
$sessionServiceClient = new SessionServiceClient();
// Prepare the request message.
$request = (new DeleteSessionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$sessionServiceClient->deleteSession($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = SessionServiceClient::sessionName(
'[PROJECT]',
'[LOCATION]',
'[DATA_STORE]',
'[SESSION]'
);
delete_session_sample($formattedName);
}
getSession
Gets a Session.
The async variant is SessionServiceClient::getSessionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\GetSessionRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\Session |
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\SessionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\GetSessionRequest;
use Google\Cloud\DiscoveryEngine\V1\Session;
/**
* @param string $formattedName The resource name of the Session to get. Format:
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
* Please see {@see SessionServiceClient::sessionName()} for help formatting this field.
*/
function get_session_sample(string $formattedName): void
{
// Create a client.
$sessionServiceClient = new SessionServiceClient();
// Prepare the request message.
$request = (new GetSessionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Session $response */
$response = $sessionServiceClient->getSession($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = SessionServiceClient::sessionName(
'[PROJECT]',
'[LOCATION]',
'[DATA_STORE]',
'[SESSION]'
);
get_session_sample($formattedName);
}
listSessions
Lists all Sessions by their parent DataStore.
The async variant is SessionServiceClient::listSessionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\ListSessionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\SessionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\ListSessionsRequest;
use Google\Cloud\DiscoveryEngine\V1\Session;
/**
* @param string $formattedParent The data store resource name. Format:
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
* Please see {@see SessionServiceClient::dataStoreName()} for help formatting this field.
*/
function list_sessions_sample(string $formattedParent): void
{
// Create a client.
$sessionServiceClient = new SessionServiceClient();
// Prepare the request message.
$request = (new ListSessionsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $sessionServiceClient->listSessions($request);
/** @var Session $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = SessionServiceClient::dataStoreName('[PROJECT]', '[LOCATION]', '[DATA_STORE]');
list_sessions_sample($formattedParent);
}
updateSession
Updates a Session.
Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
The async variant is SessionServiceClient::updateSessionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\UpdateSessionRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\Session |
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\SessionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\Session;
use Google\Cloud\DiscoveryEngine\V1\UpdateSessionRequest;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_session_sample(): void
{
// Create a client.
$sessionServiceClient = new SessionServiceClient();
// Prepare the request message.
$session = new Session();
$request = (new UpdateSessionRequest())
->setSession($session);
// Call the API and handle any network failures.
try {
/** @var Session $response */
$response = $sessionServiceClient->updateSession($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
createSessionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\CreateSessionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\Session> |
deleteSessionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\DeleteSessionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
getSessionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\GetSessionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\Session> |
listSessionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\ListSessionsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
updateSessionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\UpdateSessionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\Session> |
static::answerName
Formats a string containing the fully-qualified path to represent a answer resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
session |
string
|
answer |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted answer resource. |
static::chunkName
Formats a string containing the fully-qualified path to represent a chunk resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
branch |
string
|
document |
string
|
chunk |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted chunk resource. |
static::dataStoreName
Formats a string containing the fully-qualified path to represent a data_store resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted data_store resource. |
static::documentName
Formats a string containing the fully-qualified path to represent a document resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
branch |
string
|
document |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted document resource. |
static::projectLocationCollectionDataStoreName
Formats a string containing the fully-qualified path to represent a project_location_collection_data_store resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
collection |
string
|
dataStore |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_collection_data_store resource. |
static::projectLocationCollectionDataStoreBranchDocumentName
Formats a string containing the fully-qualified path to represent a project_location_collection_data_store_branch_document resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
collection |
string
|
dataStore |
string
|
branch |
string
|
document |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_collection_data_store_branch_document resource. |
static::projectLocationCollectionDataStoreBranchDocumentChunkName
Formats a string containing the fully-qualified path to represent a project_location_collection_data_store_branch_document_chunk resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
collection |
string
|
dataStore |
string
|
branch |
string
|
document |
string
|
chunk |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_collection_data_store_branch_document_chunk resource. |
static::projectLocationCollectionDataStoreSessionName
Formats a string containing the fully-qualified path to represent a project_location_collection_data_store_session resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
collection |
string
|
dataStore |
string
|
session |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_collection_data_store_session resource. |
static::projectLocationCollectionDataStoreSessionAnswerName
Formats a string containing the fully-qualified path to represent a project_location_collection_data_store_session_answer resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
collection |
string
|
dataStore |
string
|
session |
string
|
answer |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_collection_data_store_session_answer resource. |
static::projectLocationCollectionEngineSessionName
Formats a string containing the fully-qualified path to represent a project_location_collection_engine_session resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
collection |
string
|
engine |
string
|
session |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_collection_engine_session resource. |
static::projectLocationCollectionEngineSessionAnswerName
Formats a string containing the fully-qualified path to represent a project_location_collection_engine_session_answer resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
collection |
string
|
engine |
string
|
session |
string
|
answer |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_collection_engine_session_answer resource. |
static::projectLocationDataStoreName
Formats a string containing the fully-qualified path to represent a project_location_data_store resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_data_store resource. |
static::projectLocationDataStoreBranchDocumentName
Formats a string containing the fully-qualified path to represent a project_location_data_store_branch_document resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
branch |
string
|
document |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_data_store_branch_document resource. |
static::projectLocationDataStoreBranchDocumentChunkName
Formats a string containing the fully-qualified path to represent a project_location_data_store_branch_document_chunk resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
branch |
string
|
document |
string
|
chunk |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_data_store_branch_document_chunk resource. |
static::projectLocationDataStoreSessionName
Formats a string containing the fully-qualified path to represent a project_location_data_store_session resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
session |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_data_store_session resource. |
static::projectLocationDataStoreSessionAnswerName
Formats a string containing the fully-qualified path to represent a project_location_data_store_session_answer resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
session |
string
|
answer |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_data_store_session_answer resource. |
static::sessionName
Formats a string containing the fully-qualified path to represent a session resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
session |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted session resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- answer: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}
- chunk: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
- dataStore: projects/{project}/locations/{location}/dataStores/{data_store}
- document: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
- projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
- projectLocationCollectionDataStoreBranchDocument: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
- projectLocationCollectionDataStoreBranchDocumentChunk: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
- projectLocationCollectionDataStoreSession: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}
- projectLocationCollectionDataStoreSessionAnswer: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}
- projectLocationCollectionEngineSession: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
- projectLocationCollectionEngineSessionAnswer: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}
- projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}
- projectLocationDataStoreBranchDocument: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
- projectLocationDataStoreBranchDocumentChunk: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
- projectLocationDataStoreSession: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}
- projectLocationDataStoreSessionAnswer: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}
- session: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
?string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array |
An associative array from name component IDs to component values. |