<?php
/*
 * Copyright 2026 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * GENERATED CODE WARNING
 * Generated by gapic-generator-php from the file
 * https://github.com/googleapis/googleapis/blob/master/google/cloud/ces/v1/session_service.proto
 * Updates to the above are reflected here through a refresh process.
 */

namespace Google\Cloud\Ces\V1\Client;

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\ApiCore\CredentialsWrapper;
use Google\ApiCore\GapicClientTrait;
use Google\ApiCore\Options\ClientOptions;
use Google\ApiCore\PagedListResponse;
use Google\ApiCore\ResourceHelperTrait;
use Google\ApiCore\RetrySettings;
use Google\ApiCore\ServerStream;
use Google\ApiCore\Transport\TransportInterface;
use Google\ApiCore\ValidationException;
use Google\Auth\FetchAuthTokenInterface;
use Google\Cloud\Ces\V1\BidiSessionClientMessage;
use Google\Cloud\Ces\V1\RunSessionRequest;
use Google\Cloud\Ces\V1\RunSessionResponse;
use Google\Cloud\Ces\V1\SessionInput;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use GuzzleHttp\Promise\PromiseInterface;
use Psr\Log\LoggerInterface;

/**
 * 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.
 *
 * @method PromiseInterface<RunSessionResponse> runSessionAsync(RunSessionRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<Location> getLocationAsync(GetLocationRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<PagedListResponse> listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = [])
 */
final class SessionServiceClient
{
    use GapicClientTrait;
    use ResourceHelperTrait;

    /** The name of the service. */
    private const SERVICE_NAME = 'google.cloud.ces.v1.SessionService';

    /**
     * The default address of the service.
     *
     * @deprecated SERVICE_ADDRESS_TEMPLATE should be used instead.
     */
    private const SERVICE_ADDRESS = 'ces.googleapis.com';

    /** The address template of the service. */
    private const SERVICE_ADDRESS_TEMPLATE = 'ces.UNIVERSE_DOMAIN';

    /** The default port of the service. */
    private const DEFAULT_SERVICE_PORT = 443;

    /** The name of the code generator, to be included in the agent header. */
    private const CODEGEN_NAME = 'gapic';

    /** The default scopes required by the service. */
    public static $serviceScopes = [
        'https://www.googleapis.com/auth/ces',
        'https://www.googleapis.com/auth/cloud-platform',
    ];

    private static function getClientDefaults()
    {
        return [
            'serviceName' => self::SERVICE_NAME,
            'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT,
            'clientConfig' => __DIR__ . '/../resources/session_service_client_config.json',
            'descriptorsConfigPath' => __DIR__ . '/../resources/session_service_descriptor_config.php',
            'gcpApiConfigPath' => __DIR__ . '/../resources/session_service_grpc_config.json',
            'credentialsConfig' => [
                'defaultScopes' => self::$serviceScopes,
            ],
            'transportConfig' => [
                'rest' => [
                    'restClientConfigPath' => __DIR__ . '/../resources/session_service_rest_client_config.php',
                ],
            ],
        ];
    }

    /**
     * Formats a string containing the fully-qualified path to represent a agent
     * resource.
     *
     * @param string $project
     * @param string $location
     * @param string $app
     * @param string $agent
     *
     * @return string The formatted agent resource.
     */
    public static function agentName(string $project, string $location, string $app, string $agent): string
    {
        return self::getPathTemplate('agent')->render([
            'project' => $project,
            'location' => $location,
            'app' => $app,
            'agent' => $agent,
        ]);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a session
     * resource.
     *
     * @param string $project
     * @param string $location
     * @param string $app
     * @param string $session
     *
     * @return string The formatted session resource.
     */
    public static function sessionName(string $project, string $location, string $app, string $session): string
    {
        return self::getPathTemplate('session')->render([
            'project' => $project,
            'location' => $location,
            'app' => $app,
            'session' => $session,
        ]);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a tool
     * resource.
     *
     * @param string $project
     * @param string $location
     * @param string $app
     * @param string $tool
     *
     * @return string The formatted tool resource.
     */
    public static function toolName(string $project, string $location, string $app, string $tool): string
    {
        return self::getPathTemplate('tool')->render([
            'project' => $project,
            'location' => $location,
            'app' => $app,
            'tool' => $tool,
        ]);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a toolset
     * resource.
     *
     * @param string $project
     * @param string $location
     * @param string $app
     * @param string $toolset
     *
     * @return string The formatted toolset resource.
     */
    public static function toolsetName(string $project, string $location, string $app, string $toolset): string
    {
        return self::getPathTemplate('toolset')->render([
            'project' => $project,
            'location' => $location,
            'app' => $app,
            'toolset' => $toolset,
        ]);
    }

    /**
     * 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.
     *
     * @param string  $formattedName The formatted name string
     * @param ?string $template      Optional name of template to match
     *
     * @return array An associative array from name component IDs to component values.
     *
     * @throws ValidationException If $formattedName could not be matched.
     */
    public static function parseName(string $formattedName, ?string $template = null): array
    {
        return self::parseFormattedName($formattedName, $template);
    }

    /**
     * Constructor.
     *
     * @param array|ClientOptions $options {
     *     Optional. Options for configuring the service API wrapper.
     *
     *     @type string $apiEndpoint
     *           The address of the API remote host. May optionally include the port, formatted
     *           as "<uri>:<port>". Default 'ces.googleapis.com:443'.
     *     @type FetchAuthTokenInterface|CredentialsWrapper $credentials
     *           This option should only be used with a pre-constructed
     *           {@see FetchAuthTokenInterface} or {@see 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]);
     *           ```
     *           {@see
     *           https://cloud.google.com/docs/authentication/external/externally-sourced-credentials}
     *     @type array $credentialsConfig
     *           Options used to configure credentials, including auth token caching, for the
     *           client. For a full list of supporting configuration options, see
     *           {@see \Google\ApiCore\CredentialsWrapper::build()} .
     *     @type bool $disableRetries
     *           Determines whether or not retries defined by the client configuration should be
     *           disabled. Defaults to `false`.
     *     @type string|array $clientConfig
     *           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.
     *     @type string|TransportInterface $transport
     *           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 {@see \Google\ApiCore\Transport\TransportInterface} object. Note
     *           that when this object is provided, any settings in $transportConfig, and any
     *           $apiEndpoint setting, will be ignored.
     *     @type array $transportConfig
     *           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 {@see \Google\ApiCore\Transport\GrpcTransport::build()} and
     *           {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the
     *           supported options.
     *     @type callable $clientCertSource
     *           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.
     *     @type false|LoggerInterface $logger
     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
     *     @type string $universeDomain
     *           The service domain for the client. Defaults to 'googleapis.com'.
     * }
     *
     * @throws ValidationException
     */
    public function __construct(array|ClientOptions $options = [])
    {
        $clientOptions = $this->buildClientOptions($options);
        $this->setClientOptions($clientOptions);
    }

    /** Handles execution of the async variants for each documented method. */
    public function __call($method, $args)
    {
        if (substr($method, -5) !== 'Async') {
            trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR);
        }

        array_unshift($args, substr($method, 0, -5));
        return call_user_func_array([$this, 'startAsyncCall'], $args);
    }

    /**
     * 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:
     *
     * 1.  Initialization:
     * The first message must contain
     * [SessionConfig][google.cloud.ces.v1.BidiSessionClientMessage.config].
     * For audio sessions, this should also include
     * [InputAudioConfig][google.cloud.ces.v1.SessionConfig.input_audio_config]
     * and
     * [OutputAudioConfig][google.cloud.ces.v1.SessionConfig.output_audio_config]
     * to define audio processing and synthesis parameters.
     *
     * 2.  Interaction:
     * Subsequent messages stream
     * [SessionInput][google.cloud.ces.v1.BidiSessionClientMessage.realtime_input]
     * containing real-time user input data.
     *
     * 3.  Termination:
     * The client should half-close the stream when there is no more user
     * input. It should also half-close upon receiving
     * [EndSession][google.cloud.ces.v1.BidiSessionServerMessage.end_session]
     * or [GoAway][google.cloud.ces.v1.BidiSessionServerMessage.go_away] from
     * the agent.
     *
     * --- Server Response Stream ---
     * For each interaction turn, the agent streams messages in the following
     * sequence:
     *
     * 1.  Speech Recognition (First N messages):
     * Contains
     * [RecognitionResult][google.cloud.ces.v1.BidiSessionServerMessage.recognition_result]
     * representing the concatenated user speech segments captured so far.
     * This is only populated for audio sessions.
     *
     * 2.  Response (Next M messages):
     * Contains
     * [SessionOutput][google.cloud.ces.v1.BidiSessionServerMessage.session_output]
     * delivering the agent's response in various modalities (e.g., text,
     * audio).
     *
     * 3.  Turn Completion (Final message of the turn):
     * Contains
     * [SessionOutput][google.cloud.ces.v1.BidiSessionServerMessage.session_output]
     * with [turn_completed][google.cloud.ces.v1.SessionOutput.turn_completed]
     * set to true. This signals the end of the current turn and includes
     * [DiagnosticInfo][google.cloud.ces.v1.SessionOutput.diagnostic_info]
     * with execution details.
     *
     * --- Audio Best Practices ---
     * 1.  Streaming:
     * Stream [audio data][google.cloud.ces.v1.SessionInput.audio]
     * **CONTINUOUSLY**, even during silence. Recommended chunk size: 40-120ms
     * (balances latency vs. efficiency).
     *
     * 2.  Playback & Interruption:
     * Play [audio responses][google.cloud.ces.v1.SessionOutput.audio] upon
     * receipt. Stop playback immediately if an
     * [InterruptionSignal][google.cloud.ces.v1.BidiSessionServerMessage.interruption_signal]
     * is received (e.g., user barge-in or new agent response).
     *
     * @example samples/V1/SessionServiceClient/bidi_run_session.php
     *
     * @param array $callOptions {
     *     Optional.
     *
     *     @type int $timeoutMillis
     *           Timeout to use for this call.
     * }
     *
     * @return BidiStream
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function bidiRunSession(array $callOptions = []): BidiStream
    {
        return $this->startApiCall('BidiRunSession', null, $callOptions);
    }

    /**
     * Initiates a single-turn interaction with the CES agent within a session.
     *
     * The async variant is {@see SessionServiceClient::runSessionAsync()} .
     *
     * @example samples/V1/SessionServiceClient/run_session.php
     *
     * @param RunSessionRequest $request     A request to house fields associated with the call.
     * @param array             $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return RunSessionResponse
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function runSession(RunSessionRequest $request, array $callOptions = []): RunSessionResponse
    {
        return $this->startApiCall('RunSession', $request, $callOptions)->wait();
    }

    /**
     * Initiates a single-turn interaction with the CES agent. Uses server-side
     * streaming to deliver incremental results and partial responses as they are
     * generated.
     *
     * By default, complete responses (e.g., messages from callbacks or full LLM
     * responses) are sent to the client as soon as they are available. To enable
     * streaming individual text chunks directly from the model, set
     * [enable_text_streaming][google.cloud.ces.v1.SessionConfig.enable_text_streaming]
     * to true.
     *
     * @example samples/V1/SessionServiceClient/stream_run_session.php
     *
     * @param RunSessionRequest $request     A request to house fields associated with the call.
     * @param array             $callOptions {
     *     Optional.
     *
     *     @type int $timeoutMillis
     *           Timeout to use for this call.
     * }
     *
     * @return ServerStream<RunSessionResponse>
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function streamRunSession(RunSessionRequest $request, array $callOptions = []): ServerStream
    {
        return $this->startApiCall('StreamRunSession', $request, $callOptions);
    }

    /**
     * Gets information about a location.
     *
     * The async variant is {@see SessionServiceClient::getLocationAsync()} .
     *
     * @example samples/V1/SessionServiceClient/get_location.php
     *
     * @param GetLocationRequest $request     A request to house fields associated with the call.
     * @param array              $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return Location
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function getLocation(GetLocationRequest $request, array $callOptions = []): Location
    {
        return $this->startApiCall('GetLocation', $request, $callOptions)->wait();
    }

    /**
     * Lists information about the supported locations for this service.

    This method lists locations based on the resource scope provided in
    the [ListLocationsRequest.name] field:

    * **Global locations**: If `name` is empty, the method lists the
    public locations available to all projects. * **Project-specific
    locations**: If `name` follows the format
    `projects/{project}`, the method lists locations visible to that
    specific project. This includes public, private, or other
    project-specific locations enabled for the project.

    For gRPC and client library implementations, the resource name is
    passed as the `name` field. For direct service calls, the resource
    name is
    incorporated into the request path based on the specific service
    implementation and version.
     *
     * The async variant is {@see SessionServiceClient::listLocationsAsync()} .
     *
     * @example samples/V1/SessionServiceClient/list_locations.php
     *
     * @param ListLocationsRequest $request     A request to house fields associated with the call.
     * @param array                $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return PagedListResponse
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function listLocations(ListLocationsRequest $request, array $callOptions = []): PagedListResponse
    {
        return $this->startApiCall('ListLocations', $request, $callOptions);
    }
}
