Google Cloud Ai Platform V1 Client - Class SessionServiceClient (1.52.0)

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\AppendEventRequest;
use Google\Cloud\AIPlatform\V1\AppendEventResponse;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\AIPlatform\V1\SessionEvent;
use Google\Protobuf\Timestamp;

/**
 * @param string $formattedName     The resource name of the session to append event to.
 *                                  Format:
 *                                  `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
 *                                  Please see {@see SessionServiceClient::sessionName()} for help formatting this field.
 * @param string $eventAuthor       The name of the agent that sent the event, or user.
 * @param string $eventInvocationId The invocation id of the event, multiple events can have the same
 *                                  invocation id.
 */
function append_event_sample(
    string $formattedName,
    string $eventAuthor,
    string $eventInvocationId
): void {
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $eventTimestamp = new Timestamp();
    $event = (new SessionEvent())
        ->setAuthor($eventAuthor)
        ->setInvocationId($eventInvocationId)
        ->setTimestamp($eventTimestamp);
    $request = (new AppendEventRequest())
        ->setName($formattedName)
        ->setEvent($event);

    // Call the API and handle any network failures.
    try {
        /** @var AppendEventResponse $response */
        $response = $sessionServiceClient->appendEvent($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]',
        '[REASONING_ENGINE]',
        '[SESSION]'
    );
    $eventAuthor = '[AUTHOR]';
    $eventInvocationId = '[INVOCATION_ID]';

    append_event_sample($formattedName, $eventAuthor, $eventInvocationId);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\AIPlatform\V1\CreateSessionRequest;
use Google\Cloud\AIPlatform\V1\Session;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The resource name of the location to create the session in.
 *                                Format:
 *                                `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
 *                                Please see {@see SessionServiceClient::reasoningEngineName()} for help formatting this field.
 * @param string $sessionUserId   Immutable. String id provided by the user
 */
function create_session_sample(string $formattedParent, string $sessionUserId): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $session = (new Session())
        ->setUserId($sessionUserId);
    $request = (new CreateSessionRequest())
        ->setParent($formattedParent)
        ->setSession($session);

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

        if ($response->operationSucceeded()) {
            /** @var Session $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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::reasoningEngineName(
        '[PROJECT]',
        '[LOCATION]',
        '[REASONING_ENGINE]'
    );
    $sessionUserId = '[USER_ID]';

    create_session_sample($formattedParent, $sessionUserId);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteSessionRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the session.
 *                              Format:
 *                              `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
 *                              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 {
        /** @var OperationResponse $response */
        $response = $sessionServiceClient->deleteSession($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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]',
        '[REASONING_ENGINE]',
        '[SESSION]'
    );

    delete_session_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\AIPlatform\V1\GetSessionRequest;
use Google\Cloud\AIPlatform\V1\Session;

/**
 * @param string $formattedName The resource name of the session.
 *                              Format:
 *                              `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
 *                              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]',
        '[REASONING_ENGINE]',
        '[SESSION]'
    );

    get_session_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\AIPlatform\V1\ListEventsRequest;
use Google\Cloud\AIPlatform\V1\SessionEvent;

/**
 * @param string $formattedParent The resource name of the session to list events from.
 *                                Format:
 *                                `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
 *                                Please see {@see SessionServiceClient::sessionName()} for help formatting this field.
 */
function list_events_sample(string $formattedParent): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $request = (new ListEventsRequest())
        ->setParent($formattedParent);

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

        /** @var SessionEvent $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::sessionName(
        '[PROJECT]',
        '[LOCATION]',
        '[REASONING_ENGINE]',
        '[SESSION]'
    );

    list_events_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\AIPlatform\V1\ListSessionsRequest;
use Google\Cloud\AIPlatform\V1\Session;

/**
 * @param string $formattedParent The resource name of the location to list sessions from.
 *                                Format:
 *                                `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
 *                                Please see {@see SessionServiceClient::reasoningEngineName()} 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::reasoningEngineName(
        '[PROJECT]',
        '[LOCATION]',
        '[REASONING_ENGINE]'
    );

    list_sessions_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\AIPlatform\V1\Session;
use Google\Cloud\AIPlatform\V1\UpdateSessionRequest;

/**
 * @param string $sessionUserId Immutable. String id provided by the user
 */
function update_session_sample(string $sessionUserId): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $session = (new Session())
        ->setUserId($sessionUserId);
    $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());
    }
}

/**
 * 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
{
    $sessionUserId = '[USER_ID]';

    update_session_sample($sessionUserId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\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());
    }
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\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());
    }
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $sessionServiceClient->getIamPolicy($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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $sessionServiceClient->setIamPolicy($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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\SessionServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $sessionServiceClient = new SessionServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $sessionServiceClient->testIamPermissions($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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}