Google Cloud Dialogflow V2 Client - Class ContextsClient (2.1.2)

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\Context;
use Google\Cloud\Dialogflow\V2\CreateContextRequest;

/**
 * @param string $formattedParent The session to create a context for.
 *                                Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
 *                                `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 *                                ID>/sessions/<Session ID>`.
 *                                If `Environment ID` is not specified, we assume default 'draft'
 *                                environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                                {@see ContextsClient::sessionName()} for help formatting this field.
 * @param string $contextName     The unique identifier of the context. Format:
 *                                `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
 *                                or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 *                                ID>/sessions/<Session ID>/contexts/<Context ID>`.
 *
 *                                The `Context ID` is always converted to lowercase, may only contain
 *                                characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long.
 *
 *                                If `Environment ID` is not specified, we assume default 'draft'
 *                                environment. If `User ID` is not specified, we assume default '-' user.
 *
 *                                The following context names are reserved for internal use by Dialogflow.
 *                                You should not use these contexts or create contexts with these names:
 *
 *                                * `__system_counters__`
 *                                * `*_id_dialog_context`
 *                                * `*_dialog_params_size`
 */
function create_context_sample(string $formattedParent, string $contextName): void
{
    // Create a client.
    $contextsClient = new ContextsClient();

    // Prepare the request message.
    $context = (new Context())
        ->setName($contextName);
    $request = (new CreateContextRequest())
        ->setParent($formattedParent)
        ->setContext($context);

    // Call the API and handle any network failures.
    try {
        /** @var Context $response */
        $response = $contextsClient->createContext($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 = ContextsClient::sessionName('[PROJECT]', '[SESSION]');
    $contextName = '[NAME]';

    create_context_sample($formattedParent, $contextName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\DeleteAllContextsRequest;

/**
 * @param string $formattedParent The name of the session to delete all contexts from. Format:
 *                                `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project
 *                                ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session
 *                                ID>`.
 *                                If `Environment ID` is not specified we assume default 'draft' environment.
 *                                If `User ID` is not specified, we assume default '-' user. Please see
 *                                {@see ContextsClient::sessionName()} for help formatting this field.
 */
function delete_all_contexts_sample(string $formattedParent): void
{
    // Create a client.
    $contextsClient = new ContextsClient();

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

    // Call the API and handle any network failures.
    try {
        $contextsClient->deleteAllContexts($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
{
    $formattedParent = ContextsClient::sessionName('[PROJECT]', '[SESSION]');

    delete_all_contexts_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\DeleteContextRequest;

/**
 * @param string $formattedName The name of the context to delete. Format:
 *                              `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
 *                              or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 *                              ID>/sessions/<Session ID>/contexts/<Context ID>`.
 *                              If `Environment ID` is not specified, we assume default 'draft'
 *                              environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                              {@see ContextsClient::contextName()} for help formatting this field.
 */
function delete_context_sample(string $formattedName): void
{
    // Create a client.
    $contextsClient = new ContextsClient();

    // Prepare the request message.
    $request = (new DeleteContextRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $contextsClient->deleteContext($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 = ContextsClient::contextName('[PROJECT]', '[SESSION]', '[CONTEXT]');

    delete_context_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\Context;
use Google\Cloud\Dialogflow\V2\GetContextRequest;

/**
 * @param string $formattedName The name of the context. Format:
 *                              `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
 *                              or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 *                              ID>/sessions/<Session ID>/contexts/<Context ID>`.
 *                              If `Environment ID` is not specified, we assume default 'draft'
 *                              environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                              {@see ContextsClient::contextName()} for help formatting this field.
 */
function get_context_sample(string $formattedName): void
{
    // Create a client.
    $contextsClient = new ContextsClient();

    // Prepare the request message.
    $request = (new GetContextRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Context $response */
        $response = $contextsClient->getContext($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 = ContextsClient::contextName('[PROJECT]', '[SESSION]', '[CONTEXT]');

    get_context_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\Context;
use Google\Cloud\Dialogflow\V2\ListContextsRequest;

/**
 * @param string $formattedParent The session to list all contexts from.
 *                                Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
 *                                `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 *                                ID>/sessions/<Session ID>`.
 *                                If `Environment ID` is not specified, we assume default 'draft'
 *                                environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                                {@see ContextsClient::sessionName()} for help formatting this field.
 */
function list_contexts_sample(string $formattedParent): void
{
    // Create a client.
    $contextsClient = new ContextsClient();

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

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

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

    list_contexts_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\Context;
use Google\Cloud\Dialogflow\V2\UpdateContextRequest;

/**
 * @param string $contextName The unique identifier of the context. Format:
 *                            `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
 *                            or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 *                            ID>/sessions/<Session ID>/contexts/<Context ID>`.
 *
 *                            The `Context ID` is always converted to lowercase, may only contain
 *                            characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long.
 *
 *                            If `Environment ID` is not specified, we assume default 'draft'
 *                            environment. If `User ID` is not specified, we assume default '-' user.
 *
 *                            The following context names are reserved for internal use by Dialogflow.
 *                            You should not use these contexts or create contexts with these names:
 *
 *                            * `__system_counters__`
 *                            * `*_id_dialog_context`
 *                            * `*_dialog_params_size`
 */
function update_context_sample(string $contextName): void
{
    // Create a client.
    $contextsClient = new ContextsClient();

    // Prepare the request message.
    $context = (new Context())
        ->setName($contextName);
    $request = (new UpdateContextRequest())
        ->setContext($context);

    // Call the API and handle any network failures.
    try {
        /** @var Context $response */
        $response = $contextsClient->updateContext($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
{
    $contextName = '[NAME]';

    update_context_sample($contextName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
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.
    $contextsClient = new ContextsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $contextsClient->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\Dialogflow\V2\Client\ContextsClient;
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.
    $contextsClient = new ContextsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $contextsClient->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());
    }
}