Google Cloud Dialogflow V2 Client - Class EntityTypesClient (1.12.1)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class EntityTypesClient.

Service Description: Service for managing EntityTypes.

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 \ Dialogflow \ V2 \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array

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 string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ 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.

batchCreateEntities

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::batchCreateEntitiesAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchCreateEntitiesRequest

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\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchCreateEntitiesRequest;
use Google\Cloud\Dialogflow\V2\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\V2\EntityType\Entity;
use Google\Rpc\Status;

/**
 * @param string $formattedParent         The name of the entity type to create entities in. Format:
 *                                        `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. Please see
 *                                        {@see EntityTypesClient::entityTypeName()} for help formatting this field.
 * @param string $entitiesValue           The primary value associated with this entity entry.
 *                                        For example, if the entity type is *vegetable*, the value could be
 *                                        *scallions*.
 *
 *                                        For `KIND_MAP` entity types:
 *
 *                                        *   A reference value to be used in place of synonyms.
 *
 *                                        For `KIND_LIST` entity types:
 *
 *                                        *   A string that can contain references to other entity types (with or
 *                                        without aliases).
 * @param string $entitiesSynonymsElement A collection of value synonyms. For example, if the entity type
 *                                        is *vegetable*, and `value` is *scallions*, a synonym could be *green
 *                                        onions*.
 *
 *                                        For `KIND_LIST` entity types:
 *
 *                                        *   This collection must contain exactly one synonym equal to `value`.
 */
function batch_create_entities_sample(
    string $formattedParent,
    string $entitiesValue,
    string $entitiesSynonymsElement
): void {
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

    // Prepare the request message.
    $entitiesSynonyms = [$entitiesSynonymsElement,];
    $entity = (new Entity())
        ->setValue($entitiesValue)
        ->setSynonyms($entitiesSynonyms);
    $entities = [$entity,];
    $request = (new BatchCreateEntitiesRequest())
        ->setParent($formattedParent)
        ->setEntities($entities);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $entityTypesClient->batchCreateEntities($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 = EntityTypesClient::entityTypeName('[PROJECT]', '[ENTITY_TYPE]');
    $entitiesValue = '[VALUE]';
    $entitiesSynonymsElement = '[SYNONYMS]';

    batch_create_entities_sample($formattedParent, $entitiesValue, $entitiesSynonymsElement);
}

batchDeleteEntities

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::batchDeleteEntitiesAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchDeleteEntitiesRequest

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\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchDeleteEntitiesRequest;
use Google\Cloud\Dialogflow\V2\Client\EntityTypesClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent     The name of the entity type to delete entries for. Format:
 *                                    `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. Please see
 *                                    {@see EntityTypesClient::entityTypeName()} for help formatting this field.
 * @param string $entityValuesElement The reference `values` of the entities to delete. Note that
 *                                    these are not fully-qualified names, i.e. they don't start with
 *                                    `projects/<Project ID>`.
 */
function batch_delete_entities_sample(string $formattedParent, string $entityValuesElement): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

    // Prepare the request message.
    $entityValues = [$entityValuesElement,];
    $request = (new BatchDeleteEntitiesRequest())
        ->setParent($formattedParent)
        ->setEntityValues($entityValues);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $entityTypesClient->batchDeleteEntities($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 = EntityTypesClient::entityTypeName('[PROJECT]', '[ENTITY_TYPE]');
    $entityValuesElement = '[ENTITY_VALUES]';

    batch_delete_entities_sample($formattedParent, $entityValuesElement);
}

batchDeleteEntityTypes

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::batchDeleteEntityTypesAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchDeleteEntityTypesRequest

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\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchDeleteEntityTypesRequest;
use Google\Cloud\Dialogflow\V2\Client\EntityTypesClient;
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 EntityTypesClient::agentName()} for help formatting this field.
 * @param string $entityTypeNamesElement The names entity types to delete. All names must point to the
 *                                       same agent as `parent`.
 */
function batch_delete_entity_types_sample(
    string $formattedParent,
    string $entityTypeNamesElement
): void {
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

    // Prepare the request message.
    $entityTypeNames = [$entityTypeNamesElement,];
    $request = (new BatchDeleteEntityTypesRequest())
        ->setParent($formattedParent)
        ->setEntityTypeNames($entityTypeNames);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $entityTypesClient->batchDeleteEntityTypes($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 = EntityTypesClient::agentName('[PROJECT]');
    $entityTypeNamesElement = '[ENTITY_TYPE_NAMES]';

    batch_delete_entity_types_sample($formattedParent, $entityTypeNamesElement);
}

batchUpdateEntities

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::batchUpdateEntitiesAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchUpdateEntitiesRequest

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\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchUpdateEntitiesRequest;
use Google\Cloud\Dialogflow\V2\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\V2\EntityType\Entity;
use Google\Rpc\Status;

/**
 * @param string $formattedParent         The name of the entity type to update or create entities in.
 *                                        Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. Please see
 *                                        {@see EntityTypesClient::entityTypeName()} for help formatting this field.
 * @param string $entitiesValue           The primary value associated with this entity entry.
 *                                        For example, if the entity type is *vegetable*, the value could be
 *                                        *scallions*.
 *
 *                                        For `KIND_MAP` entity types:
 *
 *                                        *   A reference value to be used in place of synonyms.
 *
 *                                        For `KIND_LIST` entity types:
 *
 *                                        *   A string that can contain references to other entity types (with or
 *                                        without aliases).
 * @param string $entitiesSynonymsElement A collection of value synonyms. For example, if the entity type
 *                                        is *vegetable*, and `value` is *scallions*, a synonym could be *green
 *                                        onions*.
 *
 *                                        For `KIND_LIST` entity types:
 *
 *                                        *   This collection must contain exactly one synonym equal to `value`.
 */
function batch_update_entities_sample(
    string $formattedParent,
    string $entitiesValue,
    string $entitiesSynonymsElement
): void {
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

    // Prepare the request message.
    $entitiesSynonyms = [$entitiesSynonymsElement,];
    $entity = (new Entity())
        ->setValue($entitiesValue)
        ->setSynonyms($entitiesSynonyms);
    $entities = [$entity,];
    $request = (new BatchUpdateEntitiesRequest())
        ->setParent($formattedParent)
        ->setEntities($entities);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $entityTypesClient->batchUpdateEntities($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 = EntityTypesClient::entityTypeName('[PROJECT]', '[ENTITY_TYPE]');
    $entitiesValue = '[VALUE]';
    $entitiesSynonymsElement = '[SYNONYMS]';

    batch_update_entities_sample($formattedParent, $entitiesValue, $entitiesSynonymsElement);
}

batchUpdateEntityTypes

Updates/Creates multiple entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::batchUpdateEntityTypesAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchUpdateEntityTypesRequest

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\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchUpdateEntityTypesRequest;
use Google\Cloud\Dialogflow\V2\BatchUpdateEntityTypesResponse;
use Google\Cloud\Dialogflow\V2\Client\EntityTypesClient;
use Google\Rpc\Status;

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

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

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

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

    batch_update_entity_types_sample($formattedParent);
}

createEntityType

Creates an entity type in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::createEntityTypeAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\CreateEntityTypeRequest

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\Dialogflow\V2\EntityType
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\V2\CreateEntityTypeRequest;
use Google\Cloud\Dialogflow\V2\EntityType;
use Google\Cloud\Dialogflow\V2\EntityType\Kind;

/**
 * @param string $formattedParent       The agent to create a entity type for.
 *                                      Format: `projects/<Project ID>/agent`. Please see
 *                                      {@see EntityTypesClient::agentName()} for help formatting this field.
 * @param string $entityTypeDisplayName The name of the entity type.
 * @param int    $entityTypeKind        Indicates the kind of entity type.
 */
function create_entity_type_sample(
    string $formattedParent,
    string $entityTypeDisplayName,
    int $entityTypeKind
): void {
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

    // Prepare the request message.
    $entityType = (new EntityType())
        ->setDisplayName($entityTypeDisplayName)
        ->setKind($entityTypeKind);
    $request = (new CreateEntityTypeRequest())
        ->setParent($formattedParent)
        ->setEntityType($entityType);

    // Call the API and handle any network failures.
    try {
        /** @var EntityType $response */
        $response = $entityTypesClient->createEntityType($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 = EntityTypesClient::agentName('[PROJECT]');
    $entityTypeDisplayName = '[DISPLAY_NAME]';
    $entityTypeKind = Kind::KIND_UNSPECIFIED;

    create_entity_type_sample($formattedParent, $entityTypeDisplayName, $entityTypeKind);
}

deleteEntityType

Deletes the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::deleteEntityTypeAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\DeleteEntityTypeRequest

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.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\V2\DeleteEntityTypeRequest;

/**
 * @param string $formattedName The name of the entity type to delete.
 *                              Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`. Please see
 *                              {@see EntityTypesClient::entityTypeName()} for help formatting this field.
 */
function delete_entity_type_sample(string $formattedName): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

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

    // Call the API and handle any network failures.
    try {
        $entityTypesClient->deleteEntityType($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 = EntityTypesClient::entityTypeName('[PROJECT]', '[ENTITY_TYPE]');

    delete_entity_type_sample($formattedName);
}

getEntityType

Retrieves the specified entity type.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::getEntityTypeAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\GetEntityTypeRequest

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\Dialogflow\V2\EntityType
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\V2\EntityType;
use Google\Cloud\Dialogflow\V2\GetEntityTypeRequest;

/**
 * @param string $formattedName The name of the entity type.
 *                              Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`. Please see
 *                              {@see EntityTypesClient::entityTypeName()} for help formatting this field.
 */
function get_entity_type_sample(string $formattedName): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var EntityType $response */
        $response = $entityTypesClient->getEntityType($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 = EntityTypesClient::entityTypeName('[PROJECT]', '[ENTITY_TYPE]');

    get_entity_type_sample($formattedName);
}

listEntityTypes

Returns the list of all entity types in the specified agent.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::listEntityTypesAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\ListEntityTypesRequest

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\Dialogflow\V2\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\V2\EntityType;
use Google\Cloud\Dialogflow\V2\ListEntityTypesRequest;

/**
 * @param string $formattedParent The agent to list all entity types from.
 *                                Format: `projects/<Project ID>/agent`. Please see
 *                                {@see EntityTypesClient::agentName()} for help formatting this field.
 */
function list_entity_types_sample(string $formattedParent): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

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

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

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

    list_entity_types_sample($formattedParent);
}

updateEntityType

Updates the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::updateEntityTypeAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\UpdateEntityTypeRequest

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\Dialogflow\V2\EntityType
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\V2\EntityType;
use Google\Cloud\Dialogflow\V2\EntityType\Kind;
use Google\Cloud\Dialogflow\V2\UpdateEntityTypeRequest;

/**
 * @param string $entityTypeDisplayName The name of the entity type.
 * @param int    $entityTypeKind        Indicates the kind of entity type.
 */
function update_entity_type_sample(string $entityTypeDisplayName, int $entityTypeKind): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

    // Prepare the request message.
    $entityType = (new EntityType())
        ->setDisplayName($entityTypeDisplayName)
        ->setKind($entityTypeKind);
    $request = (new UpdateEntityTypeRequest())
        ->setEntityType($entityType);

    // Call the API and handle any network failures.
    try {
        /** @var EntityType $response */
        $response = $entityTypesClient->updateEntityType($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
{
    $entityTypeDisplayName = '[DISPLAY_NAME]';
    $entityTypeKind = Kind::KIND_UNSPECIFIED;

    update_entity_type_sample($entityTypeDisplayName, $entityTypeKind);
}

getLocation

Gets information about a location.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::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\Dialogflow\V2\Client\EntityTypesClient;
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.
    $entityTypesClient = new EntityTypesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $entityTypesClient->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.

The async variant is Google\Cloud\Dialogflow\V2\Client\EntityTypesClient::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\Dialogflow\V2\Client\EntityTypesClient;
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.
    $entityTypesClient = new EntityTypesClient();

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

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

batchCreateEntitiesAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchCreateEntitiesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

batchDeleteEntitiesAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchDeleteEntitiesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

batchDeleteEntityTypesAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchDeleteEntityTypesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

batchUpdateEntitiesAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchUpdateEntitiesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

batchUpdateEntityTypesAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\BatchUpdateEntityTypesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

createEntityTypeAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\CreateEntityTypeRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

deleteEntityTypeAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\DeleteEntityTypeRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getEntityTypeAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\GetEntityTypeRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listEntityTypesAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\ListEntityTypesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

updateEntityTypeAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\UpdateEntityTypeRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name Description
operationName string

The name of the long running operation
methodName string

The name of the method used to start the operation
Returns
Type Description
Google\ApiCore\OperationResponse

static::agentName

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

Parameter
Name Description
project string
Returns
Type Description
string The formatted agent resource.

static::entityTypeName

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

Parameters
Name Description
project string
entityType string
Returns
Type Description
string The formatted entity_type resource.

static::projectAgentName

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

Parameter
Name Description
project string
Returns
Type Description
string The formatted project_agent resource.

static::projectEntityTypeName

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

Parameters
Name Description
project string
entityType string
Returns
Type Description
string The formatted project_entity_type resource.

static::projectLocationAgentName

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

Parameters
Name Description
project string
location string
Returns
Type Description
string The formatted project_location_agent resource.

static::projectLocationEntityTypeName

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

Parameters
Name Description
project string
location string
entityType string
Returns
Type Description
string The formatted project_location_entity_type 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}/agent
  • entityType: projects/{project}/agent/entityTypes/{entity_type}
  • projectAgent: projects/{project}/agent
  • projectEntityType: projects/{project}/agent/entityTypes/{entity_type}
  • projectLocationAgent: projects/{project}/locations/{location}/agent
  • projectLocationEntityType: projects/{project}/locations/{location}/agent/entityTypes/{entity_type}

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.