Google Cloud Dialogflow V2 Client - Class SessionEntityTypesClient (1.17.0)

Namespace

Methods

__construct

createSessionEntityType

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\SessionEntityTypesClient;
use Google\Cloud\Dialogflow\V2\CreateSessionEntityTypeRequest;
use Google\Cloud\Dialogflow\V2\EntityType\Entity;
use Google\Cloud\Dialogflow\V2\SessionEntityType;
use Google\Cloud\Dialogflow\V2\SessionEntityType\EntityOverrideMode;

/**
 * @param string $formattedParent                          The session to create a session entity type 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 SessionEntityTypesClient::sessionName()} for help formatting this field.
 * @param string $sessionEntityTypeName                    The unique identifier of this session entity type. Format:
 *                                                         `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 *                                                         Display Name>`, or `projects/<Project ID>/agent/environments/<Environment
 *                                                         ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 *                                                         Name>`.
 *                                                         If `Environment ID` is not specified, we assume default 'draft'
 *                                                         environment. If `User ID` is not specified, we assume default '-' user.
 *
 *                                                         `<Entity Type Display Name>` must be the display name of an existing entity
 *                                                         type in the same agent that will be overridden or supplemented.
 * @param int    $sessionEntityTypeEntityOverrideMode      Indicates whether the additional data should override or
 *                                                         supplement the custom entity type definition.
 * @param string $sessionEntityTypeEntitiesValue           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 $sessionEntityTypeEntitiesSynonymsElement 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 create_session_entity_type_sample(
    string $formattedParent,
    string $sessionEntityTypeName,
    int $sessionEntityTypeEntityOverrideMode,
    string $sessionEntityTypeEntitiesValue,
    string $sessionEntityTypeEntitiesSynonymsElement
): void {
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

    // Prepare the request message.
    $sessionEntityTypeEntitiesSynonyms = [$sessionEntityTypeEntitiesSynonymsElement,];
    $entity = (new Entity())
        ->setValue($sessionEntityTypeEntitiesValue)
        ->setSynonyms($sessionEntityTypeEntitiesSynonyms);
    $sessionEntityTypeEntities = [$entity,];
    $sessionEntityType = (new SessionEntityType())
        ->setName($sessionEntityTypeName)
        ->setEntityOverrideMode($sessionEntityTypeEntityOverrideMode)
        ->setEntities($sessionEntityTypeEntities);
    $request = (new CreateSessionEntityTypeRequest())
        ->setParent($formattedParent)
        ->setSessionEntityType($sessionEntityType);

    // Call the API and handle any network failures.
    try {
        /** @var SessionEntityType $response */
        $response = $sessionEntityTypesClient->createSessionEntityType($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 = SessionEntityTypesClient::sessionName('[PROJECT]', '[SESSION]');
    $sessionEntityTypeName = '[NAME]';
    $sessionEntityTypeEntityOverrideMode = EntityOverrideMode::ENTITY_OVERRIDE_MODE_UNSPECIFIED;
    $sessionEntityTypeEntitiesValue = '[VALUE]';
    $sessionEntityTypeEntitiesSynonymsElement = '[SYNONYMS]';

    create_session_entity_type_sample(
        $formattedParent,
        $sessionEntityTypeName,
        $sessionEntityTypeEntityOverrideMode,
        $sessionEntityTypeEntitiesValue,
        $sessionEntityTypeEntitiesSynonymsElement
    );
}

deleteSessionEntityType

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\SessionEntityTypesClient;
use Google\Cloud\Dialogflow\V2\DeleteSessionEntityTypeRequest;

/**
 * @param string $formattedName The name of the entity type to delete. Format:
 *                              `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 *                              Display Name>` or `projects/<Project ID>/agent/environments/<Environment
 *                              ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 *                              Name>`.
 *                              If `Environment ID` is not specified, we assume default 'draft'
 *                              environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                              {@see SessionEntityTypesClient::sessionEntityTypeName()} for help formatting this field.
 */
function delete_session_entity_type_sample(string $formattedName): void
{
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

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

    // Call the API and handle any network failures.
    try {
        $sessionEntityTypesClient->deleteSessionEntityType($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 = SessionEntityTypesClient::sessionEntityTypeName(
        '[PROJECT]',
        '[SESSION]',
        '[ENTITY_TYPE]'
    );

    delete_session_entity_type_sample($formattedName);
}

getSessionEntityType

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\SessionEntityTypesClient;
use Google\Cloud\Dialogflow\V2\GetSessionEntityTypeRequest;
use Google\Cloud\Dialogflow\V2\SessionEntityType;

/**
 * @param string $formattedName The name of the session entity type. Format:
 *                              `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 *                              Display Name>` or `projects/<Project ID>/agent/environments/<Environment
 *                              ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 *                              Name>`.
 *                              If `Environment ID` is not specified, we assume default 'draft'
 *                              environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                              {@see SessionEntityTypesClient::sessionEntityTypeName()} for help formatting this field.
 */
function get_session_entity_type_sample(string $formattedName): void
{
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var SessionEntityType $response */
        $response = $sessionEntityTypesClient->getSessionEntityType($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 = SessionEntityTypesClient::sessionEntityTypeName(
        '[PROJECT]',
        '[SESSION]',
        '[ENTITY_TYPE]'
    );

    get_session_entity_type_sample($formattedName);
}

listSessionEntityTypes

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\SessionEntityTypesClient;
use Google\Cloud\Dialogflow\V2\ListSessionEntityTypesRequest;
use Google\Cloud\Dialogflow\V2\SessionEntityType;

/**
 * @param string $formattedParent The session to list all session entity types 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 SessionEntityTypesClient::sessionName()} for help formatting this field.
 */
function list_session_entity_types_sample(string $formattedParent): void
{
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

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

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

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

    list_session_entity_types_sample($formattedParent);
}

updateSessionEntityType

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\SessionEntityTypesClient;
use Google\Cloud\Dialogflow\V2\EntityType\Entity;
use Google\Cloud\Dialogflow\V2\SessionEntityType;
use Google\Cloud\Dialogflow\V2\SessionEntityType\EntityOverrideMode;
use Google\Cloud\Dialogflow\V2\UpdateSessionEntityTypeRequest;

/**
 * @param string $sessionEntityTypeName                    The unique identifier of this session entity type. Format:
 *                                                         `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 *                                                         Display Name>`, or `projects/<Project ID>/agent/environments/<Environment
 *                                                         ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 *                                                         Name>`.
 *                                                         If `Environment ID` is not specified, we assume default 'draft'
 *                                                         environment. If `User ID` is not specified, we assume default '-' user.
 *
 *                                                         `<Entity Type Display Name>` must be the display name of an existing entity
 *                                                         type in the same agent that will be overridden or supplemented.
 * @param int    $sessionEntityTypeEntityOverrideMode      Indicates whether the additional data should override or
 *                                                         supplement the custom entity type definition.
 * @param string $sessionEntityTypeEntitiesValue           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 $sessionEntityTypeEntitiesSynonymsElement 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 update_session_entity_type_sample(
    string $sessionEntityTypeName,
    int $sessionEntityTypeEntityOverrideMode,
    string $sessionEntityTypeEntitiesValue,
    string $sessionEntityTypeEntitiesSynonymsElement
): void {
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

    // Prepare the request message.
    $sessionEntityTypeEntitiesSynonyms = [$sessionEntityTypeEntitiesSynonymsElement,];
    $entity = (new Entity())
        ->setValue($sessionEntityTypeEntitiesValue)
        ->setSynonyms($sessionEntityTypeEntitiesSynonyms);
    $sessionEntityTypeEntities = [$entity,];
    $sessionEntityType = (new SessionEntityType())
        ->setName($sessionEntityTypeName)
        ->setEntityOverrideMode($sessionEntityTypeEntityOverrideMode)
        ->setEntities($sessionEntityTypeEntities);
    $request = (new UpdateSessionEntityTypeRequest())
        ->setSessionEntityType($sessionEntityType);

    // Call the API and handle any network failures.
    try {
        /** @var SessionEntityType $response */
        $response = $sessionEntityTypesClient->updateSessionEntityType($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
{
    $sessionEntityTypeName = '[NAME]';
    $sessionEntityTypeEntityOverrideMode = EntityOverrideMode::ENTITY_OVERRIDE_MODE_UNSPECIFIED;
    $sessionEntityTypeEntitiesValue = '[VALUE]';
    $sessionEntityTypeEntitiesSynonymsElement = '[SYNONYMS]';

    update_session_entity_type_sample(
        $sessionEntityTypeName,
        $sessionEntityTypeEntityOverrideMode,
        $sessionEntityTypeEntitiesValue,
        $sessionEntityTypeEntitiesSynonymsElement
    );
}

getLocation

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

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $sessionEntityTypesClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

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

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

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

createSessionEntityTypeAsync

deleteSessionEntityTypeAsync

getSessionEntityTypeAsync

listSessionEntityTypesAsync

updateSessionEntityTypeAsync

getLocationAsync

listLocationsAsync

static::projectEnvironmentUserSessionName

static::projectEnvironmentUserSessionEntityTypeName

static::projectLocationEnvironmentUserSessionName

static::projectLocationEnvironmentUserSessionEntityTypeName

static::projectLocationSessionName

static::projectLocationSessionEntityTypeName

static::projectSessionName

static::projectSessionEntityTypeName

static::sessionName

static::sessionEntityTypeName

static::parseName