Google Cloud Ces V1 Client - Class SessionServiceClient (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class SessionServiceClient.

Service Description: Session service provides APIs for interacting with CES agents.

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 \ Ces \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array\|Google\ApiCore\Options\ClientOptions` 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`	`FetchAuthTokenInterface\|CredentialsWrapper` This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Ces\V1\SessionServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new SessionServiceClient(['credentials' => $creds]);` 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 `false`.
`↳ 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 `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ 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
`↳ universeDomain`	`string` The service domain for the client. Defaults to 'googleapis.com'.

bidiRunSession

Establishes a bidirectional streaming connection with the CES agent.

The agent processes continuous multimodal inputs (e.g., text, audio) and generates real-time multimodal output streams.

--- Client Request Stream --- The client streams requests in the following order:

Initialization: The first message must contain SessionConfig. For audio sessions, this should also include InputAudioConfig and OutputAudioConfig to define audio processing and synthesis parameters.
Interaction: Subsequent messages stream SessionInput containing real-time user input data.
Termination: The client should half-close the stream when there is no more user input. It should also half-close upon receiving EndSession or GoAway from the agent.

--- Server Response Stream --- For each interaction turn, the agent streams messages in the following sequence:

Speech Recognition (First N messages): Contains RecognitionResult representing the concatenated user speech segments captured so far. This is only populated for audio sessions.
Response (Next M messages): Contains SessionOutput delivering the agent's response in various modalities (e.g., text, audio).
Turn Completion (Final message of the turn): Contains SessionOutput with turn_completed set to true. This signals the end of the current turn and includes DiagnosticInfo with execution details.

--- Audio Best Practices ---

Streaming: Stream audio data CONTINUOUSLY, even during silence. Recommended chunk size: 40-120ms (balances latency vs. efficiency).
Playback & Interruption: Play audio responses upon receipt. Stop playback immediately if an InterruptionSignal is received (e.g., user barge-in or new agent response).

Parameters
Name	Description
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\BidiStream`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Ces\V1\BidiSessionClientMessage;
use Google\Cloud\Ces\V1\BidiSessionServerMessage;
use Google\Cloud\Ces\V1\Client\SessionServiceClient;

/**
 * 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 bidi_run_session_sample(): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $request = new BidiSessionClientMessage();

    // Call the API and handle any network failures.
    try {
        /** @var BidiStream $stream */
        $stream = $sessionServiceClient->bidiRunSession();
        $stream->writeAll([$request,]);

        /** @var BidiSessionServerMessage $element */
        foreach ($stream->closeWriteAndReadAll() as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

runSession

Initiates a single turn interaction with the CES agent within a session.

The async variant is SessionServiceClient::runSessionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Ces\V1\RunSessionRequest` 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\Ces\V1\RunSessionResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Ces\V1\Client\SessionServiceClient;
use Google\Cloud\Ces\V1\RunSessionRequest;
use Google\Cloud\Ces\V1\RunSessionResponse;
use Google\Cloud\Ces\V1\SessionConfig;
use Google\Cloud\Ces\V1\SessionInput;

/**
 * @param string $formattedConfigSession The unique identifier of the session.
 *                                       Format:
 *                                       `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`
 *                                       Please see {@see SessionServiceClient::sessionName()} for help formatting this field.
 */
function run_session_sample(string $formattedConfigSession): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $config = (new SessionConfig())
        ->setSession($formattedConfigSession);
    $inputs = [new SessionInput()];
    $request = (new RunSessionRequest())
        ->setConfig($config)
        ->setInputs($inputs);

    // Call the API and handle any network failures.
    try {
        /** @var RunSessionResponse $response */
        $response = $sessionServiceClient->runSession($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
{
    $formattedConfigSession = SessionServiceClient::sessionName(
        '[PROJECT]',
        '[LOCATION]',
        '[APP]',
        '[SESSION]'
    );

    run_session_sample($formattedConfigSession);
}

getLocation

Gets information about a location.

The async variant is SessionServiceClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` 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\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Ces\V1\Client\SessionServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $sessionServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

This method can be called in two ways:

List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

The async variant is SessionServiceClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Ces\V1\Client\SessionServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $sessionServiceClient->listLocations($request);

        /** @var Location $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());
    }
}

runSessionAsync

Parameters
Name	Description
`request`	`Google\Cloud\Ces\V1\RunSessionRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Ces\V1\RunSessionResponse>`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

static::agentName

Formats a string containing the fully-qualified path to represent a agent resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`app`	`string`
`agent`	`string`

Returns
Type	Description
`string`	The formatted agent resource.

static::sessionName

Formats a string containing the fully-qualified path to represent a session resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`app`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted session resource.

static::toolName

Formats a string containing the fully-qualified path to represent a tool resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`app`	`string`
`tool`	`string`

Returns
Type	Description
`string`	The formatted tool resource.

static::toolsetName

Formats a string containing the fully-qualified path to represent a toolset resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`app`	`string`
`toolset`	`string`

Returns
Type	Description
`string`	The formatted toolset 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

agent: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
session: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
tool: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

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.

Google Cloud Ces V1 Client - Class SessionServiceClient (0.1.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

bidiRunSession

runSession

getLocation

listLocations

runSessionAsync

getLocationAsync

listLocationsAsync

static::agentName

static::sessionName

static::toolName

static::toolsetName

static::parseName

Google Cloud Ces V1 Client - Class SessionServiceClient (0.1.0)