Google Cloud Dialogflow V2 Client - Class GeneratorEvaluationsClient (2.3.0)

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

Service Description: Service for managing generator evaluations.

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\|Google\ApiCore\Options\ClientOptions` 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`	`FetchAuthTokenInterface\|CredentialsWrapper` This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Dialogflow\V2\GeneratorEvaluationsClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new GeneratorEvaluationsClient(['credentials' => $creds]);` https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
`↳ 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.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
`↳ universeDomain`	`string` The service domain for the client. Defaults to 'googleapis.com'.

createGeneratorEvaluation

Creates evaluation of a generator.

The async variant is GeneratorEvaluationsClient::createGeneratorEvaluationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\CreateGeneratorEvaluationRequest` 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<Google\Cloud\Dialogflow\V2\GeneratorEvaluation>`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\GeneratorEvaluationsClient;
use Google\Cloud\Dialogflow\V2\CreateGeneratorEvaluationRequest;
use Google\Cloud\Dialogflow\V2\Generator;
use Google\Cloud\Dialogflow\V2\GeneratorEvaluation;
use Google\Cloud\Dialogflow\V2\GeneratorEvaluationConfig;
use Google\Cloud\Dialogflow\V2\GeneratorEvaluationConfig\InputDataConfig;
use Google\Cloud\Dialogflow\V2\GeneratorEvaluationConfig\InputDataSourceType;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                                                                The generator resource name. Format:
 *                                                                                               `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
 *                                                                                               Please see {@see GeneratorEvaluationsClient::generatorName()} for help formatting this field.
 * @param int    $generatorEvaluationGeneratorEvaluationConfigInputDataConfigInputDataSourceType The source type of input data.
 * @param string $generatorEvaluationGeneratorEvaluationConfigOutputGcsBucketPath                The output Cloud Storage bucket path to store eval files, e.g.
 *                                                                                               per_summary_accuracy_score report. This path is provided by customer and
 *                                                                                               files stored in it are visible to customer, no internal data should be
 *                                                                                               stored in this path.
 */
function create_generator_evaluation_sample(
    string $formattedParent,
    int $generatorEvaluationGeneratorEvaluationConfigInputDataConfigInputDataSourceType,
    string $generatorEvaluationGeneratorEvaluationConfigOutputGcsBucketPath
): void {
    // Create a client.
    $generatorEvaluationsClient = new GeneratorEvaluationsClient();

    // Prepare the request message.
    $generatorEvaluationGeneratorEvaluationConfigInputDataConfig = (new InputDataConfig())
        ->setInputDataSourceType(
            $generatorEvaluationGeneratorEvaluationConfigInputDataConfigInputDataSourceType
        );
    $generatorEvaluationGeneratorEvaluationConfig = (new GeneratorEvaluationConfig())
        ->setInputDataConfig($generatorEvaluationGeneratorEvaluationConfigInputDataConfig)
        ->setOutputGcsBucketPath($generatorEvaluationGeneratorEvaluationConfigOutputGcsBucketPath);
    $generatorEvaluationInitialGenerator = new Generator();
    $generatorEvaluation = (new GeneratorEvaluation())
        ->setGeneratorEvaluationConfig($generatorEvaluationGeneratorEvaluationConfig)
        ->setInitialGenerator($generatorEvaluationInitialGenerator);
    $request = (new CreateGeneratorEvaluationRequest())
        ->setParent($formattedParent)
        ->setGeneratorEvaluation($generatorEvaluation);

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

        if ($response->operationSucceeded()) {
            /** @var GeneratorEvaluation $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 = GeneratorEvaluationsClient::generatorName(
        '[PROJECT]',
        '[LOCATION]',
        '[GENERATOR]'
    );
    $generatorEvaluationGeneratorEvaluationConfigInputDataConfigInputDataSourceType = InputDataSourceType::INPUT_DATA_SOURCE_TYPE_UNSPECIFIED;
    $generatorEvaluationGeneratorEvaluationConfigOutputGcsBucketPath = '[OUTPUT_GCS_BUCKET_PATH]';

    create_generator_evaluation_sample(
        $formattedParent,
        $generatorEvaluationGeneratorEvaluationConfigInputDataConfigInputDataSourceType,
        $generatorEvaluationGeneratorEvaluationConfigOutputGcsBucketPath
    );
}

deleteGeneratorEvaluation

Deletes an evaluation of generator.

The async variant is GeneratorEvaluationsClient::deleteGeneratorEvaluationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\DeleteGeneratorEvaluationRequest` 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\GeneratorEvaluationsClient;
use Google\Cloud\Dialogflow\V2\DeleteGeneratorEvaluationRequest;

/**
 * @param string $formattedName The generator evaluation resource name. Format:
 *                              `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/
 *                              evaluations/<Evaluation ID>`
 *                              Please see {@see GeneratorEvaluationsClient::generatorEvaluationName()} for help formatting this field.
 */
function delete_generator_evaluation_sample(string $formattedName): void
{
    // Create a client.
    $generatorEvaluationsClient = new GeneratorEvaluationsClient();

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

    // Call the API and handle any network failures.
    try {
        $generatorEvaluationsClient->deleteGeneratorEvaluation($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 = GeneratorEvaluationsClient::generatorEvaluationName(
        '[PROJECT]',
        '[LOCATION]',
        '[GENERATOR]',
        '[EVALUATION]'
    );

    delete_generator_evaluation_sample($formattedName);
}

getGeneratorEvaluation

Gets an evaluation of generator.

The async variant is GeneratorEvaluationsClient::getGeneratorEvaluationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\GetGeneratorEvaluationRequest` 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\GeneratorEvaluation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\GeneratorEvaluationsClient;
use Google\Cloud\Dialogflow\V2\GeneratorEvaluation;
use Google\Cloud\Dialogflow\V2\GetGeneratorEvaluationRequest;

/**
 * @param string $formattedName The generator evaluation resource name. Format:
 *                              `projects/<Project ID>/locations/<Location ID>/generators/<Generator
 *                              ID>/evaluations/<Evaluation ID>`
 *                              Please see {@see GeneratorEvaluationsClient::generatorEvaluationName()} for help formatting this field.
 */
function get_generator_evaluation_sample(string $formattedName): void
{
    // Create a client.
    $generatorEvaluationsClient = new GeneratorEvaluationsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var GeneratorEvaluation $response */
        $response = $generatorEvaluationsClient->getGeneratorEvaluation($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 = GeneratorEvaluationsClient::generatorEvaluationName(
        '[PROJECT]',
        '[LOCATION]',
        '[GENERATOR]',
        '[EVALUATION]'
    );

    get_generator_evaluation_sample($formattedName);
}

listGeneratorEvaluations

Lists evaluations of generator.

The async variant is GeneratorEvaluationsClient::listGeneratorEvaluationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ListGeneratorEvaluationsRequest` 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\GeneratorEvaluationsClient;
use Google\Cloud\Dialogflow\V2\GeneratorEvaluation;
use Google\Cloud\Dialogflow\V2\ListGeneratorEvaluationsRequest;

/**
 * @param string $formattedParent The generator resource name. Format:
 *                                `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
 *                                Wildcard value `-` is supported on generator_id to list evaluations across
 *                                all generators under same project. Please see
 *                                {@see GeneratorEvaluationsClient::generatorName()} for help formatting this field.
 */
function list_generator_evaluations_sample(string $formattedParent): void
{
    // Create a client.
    $generatorEvaluationsClient = new GeneratorEvaluationsClient();

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

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

        /** @var GeneratorEvaluation $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 = GeneratorEvaluationsClient::generatorName(
        '[PROJECT]',
        '[LOCATION]',
        '[GENERATOR]'
    );

    list_generator_evaluations_sample($formattedParent);
}

getLocation

Gets information about a location.

The async variant is GeneratorEvaluationsClient::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\GeneratorEvaluationsClient;
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.
    $generatorEvaluationsClient = new GeneratorEvaluationsClient();

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

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

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

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

createGeneratorEvaluationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\CreateGeneratorEvaluationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

deleteGeneratorEvaluationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\DeleteGeneratorEvaluationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

getGeneratorEvaluationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\GetGeneratorEvaluationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\GeneratorEvaluation>`

listGeneratorEvaluationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ListGeneratorEvaluationsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

getOperationsClient

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

Returns
Type	Description
`Google\LongRunning\Client\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::generatorName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`generator`	`string`

Returns
Type	Description
`string`	The formatted generator resource.

static::generatorEvaluationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`generator`	`string`
`evaluation`	`string`

Returns
Type	Description
`string`	The formatted generator_evaluation resource.

static::toolName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`tool`	`string`

Returns
Type	Description
`string`	The formatted tool 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

generator: projects/{project}/locations/{location}/generators/{generator}
generatorEvaluation: projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}
tool: projects/{project}/locations/{location}/tools/{tool}

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.

Google Cloud Dialogflow V2 Client - Class GeneratorEvaluationsClient (2.3.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

createGeneratorEvaluation

deleteGeneratorEvaluation

getGeneratorEvaluation

listGeneratorEvaluations

getLocation

listLocations

createGeneratorEvaluationAsync

deleteGeneratorEvaluationAsync

getGeneratorEvaluationAsync

listGeneratorEvaluationsAsync

getLocationAsync

listLocationsAsync

getOperationsClient

resumeOperation

static::generatorName

static::generatorEvaluationName

static::toolName

static::parseName

Google Cloud Dialogflow V2 Client - Class GeneratorEvaluationsClient (2.3.0)