Google Cloud Dialogflow V2 Client - Class IntentsClient (1.14.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchDeleteIntentsRequest;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\Intent;
use Google\Rpc\Status;

/**
 * @param string $formattedParent    The name of the agent to delete all entities types for. Format:
 *                                   `projects/<Project ID>/agent`. Please see
 *                                   {@see IntentsClient::agentName()} for help formatting this field.
 * @param string $intentsDisplayName The name of this intent.
 */
function batch_delete_intents_sample(string $formattedParent, string $intentsDisplayName): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

    // Prepare the request message.
    $intent = (new Intent())
        ->setDisplayName($intentsDisplayName);
    $intents = [$intent,];
    $request = (new BatchDeleteIntentsRequest())
        ->setParent($formattedParent)
        ->setIntents($intents);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $intentsClient->batchDeleteIntents($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
{
    $formattedParent = IntentsClient::agentName('[PROJECT]');
    $intentsDisplayName = '[DISPLAY_NAME]';

    batch_delete_intents_sample($formattedParent, $intentsDisplayName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchUpdateIntentsRequest;
use Google\Cloud\Dialogflow\V2\BatchUpdateIntentsResponse;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The name of the agent to update or create intents in.
 *                                Format: `projects/<Project ID>/agent`. Please see
 *                                {@see IntentsClient::agentName()} for help formatting this field.
 */
function batch_update_intents_sample(string $formattedParent): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var BatchUpdateIntentsResponse $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 = IntentsClient::agentName('[PROJECT]');

    batch_update_intents_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\CreateIntentRequest;
use Google\Cloud\Dialogflow\V2\Intent;

/**
 * @param string $formattedParent   The agent to create a intent for.
 *                                  Format: `projects/<Project ID>/agent`. Please see
 *                                  {@see IntentsClient::agentName()} for help formatting this field.
 * @param string $intentDisplayName The name of this intent.
 */
function create_intent_sample(string $formattedParent, string $intentDisplayName): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

    // Prepare the request message.
    $intent = (new Intent())
        ->setDisplayName($intentDisplayName);
    $request = (new CreateIntentRequest())
        ->setParent($formattedParent)
        ->setIntent($intent);

    // Call the API and handle any network failures.
    try {
        /** @var Intent $response */
        $response = $intentsClient->createIntent($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 = IntentsClient::agentName('[PROJECT]');
    $intentDisplayName = '[DISPLAY_NAME]';

    create_intent_sample($formattedParent, $intentDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\DeleteIntentRequest;

/**
 * @param string $formattedName The name of the intent to delete. If this intent has direct or
 *                              indirect followup intents, we also delete them.
 *                              Format: `projects/<Project ID>/agent/intents/<Intent ID>`. Please see
 *                              {@see IntentsClient::intentName()} for help formatting this field.
 */
function delete_intent_sample(string $formattedName): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

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

    // Call the API and handle any network failures.
    try {
        $intentsClient->deleteIntent($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 = IntentsClient::intentName('[PROJECT]', '[INTENT]');

    delete_intent_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\GetIntentRequest;
use Google\Cloud\Dialogflow\V2\Intent;

/**
 * @param string $formattedName The name of the intent.
 *                              Format: `projects/<Project ID>/agent/intents/<Intent ID>`. Please see
 *                              {@see IntentsClient::intentName()} for help formatting this field.
 */
function get_intent_sample(string $formattedName): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Intent $response */
        $response = $intentsClient->getIntent($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 = IntentsClient::intentName('[PROJECT]', '[INTENT]');

    get_intent_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\Intent;
use Google\Cloud\Dialogflow\V2\ListIntentsRequest;

/**
 * @param string $formattedParent The agent to list all intents from.
 *                                Format: `projects/<Project ID>/agent` or `projects/<Project
 *                                ID>/locations/<Location ID>/agent`.
 *
 *                                Alternatively, you can specify the environment to list intents for.
 *                                Format: `projects/<Project ID>/agent/environments/<Environment ID>`
 *                                or `projects/<Project ID>/locations/<Location
 *                                ID>/agent/environments/<Environment ID>`.
 *                                Note: training phrases of the intents will not be returned for non-draft
 *                                environment. Please see
 *                                {@see IntentsClient::agentName()} for help formatting this field.
 */
function list_intents_sample(string $formattedParent): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

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

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

        /** @var Intent $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 = IntentsClient::agentName('[PROJECT]');

    list_intents_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\Intent;
use Google\Cloud\Dialogflow\V2\UpdateIntentRequest;

/**
 * @param string $intentDisplayName The name of this intent.
 */
function update_intent_sample(string $intentDisplayName): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

    // Prepare the request message.
    $intent = (new Intent())
        ->setDisplayName($intentDisplayName);
    $request = (new UpdateIntentRequest())
        ->setIntent($intent);

    // Call the API and handle any network failures.
    try {
        /** @var Intent $response */
        $response = $intentsClient->updateIntent($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
{
    $intentDisplayName = '[DISPLAY_NAME]';

    update_intent_sample($intentDisplayName);
}

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

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

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

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

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