Console
    Contact Us Start free

    Google Cloud Dialogflow Cx V3 Client - Class ExperimentsClient (0.1.1)

    Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class ExperimentsClient.

    Service Description: Service for managing Experiments .

    This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

     $experimentsClient = new ExperimentsClient();
try {
    $formattedParent = $experimentsClient->environmentName('[PROJECT]', '[LOCATION]', '[AGENT]', '[ENVIRONMENT]');
    $experiment = new Experiment();
    $response = $experimentsClient->createExperiment($formattedParent, $experiment);
} finally {
    $experimentsClient->close();
}

    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 \ Cx \ V3

    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.

    createExperiment

    Creates an Experiment in the specified Environment .

    Parameters
    Name
    Description
    parent
    string

    Required. The Agent to create an Environment for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID> .

    experiment
    Google\Cloud\Dialogflow\Cx\V3\Experiment

    Required. The experiment to create.

    optionalArgs
    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\Cx\V3\Experiment
    Example 
     use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\ExperimentsClient;

/**
 * @param string $formattedParent       The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an
 *                                      [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format:
 *                                      `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                                      ID>/environments/<Environment ID>`. Please see
 *                                      {@see ExperimentsClient::environmentName()} for help formatting this field.
 * @param string $experimentDisplayName The human-readable name of the experiment (unique in an
 *                                      environment). Limit of 64 characters.
 */
function create_experiment_sample(string $formattedParent, string $experimentDisplayName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $experiment = (new Experiment())
        ->setDisplayName($experimentDisplayName);

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->createExperiment($formattedParent, $experiment);
        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 = ExperimentsClient::environmentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]'
    );
    $experimentDisplayName = '[DISPLAY_NAME]';

    create_experiment_sample($formattedParent, $experimentDisplayName);
}

    deleteExperiment

    Deletes the specified Experiment .

    Parameters
    Name
    Description
    name
    string

    Required. The name of the Environment to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID> .

    optionalArgs
    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\Cx\V3\ExperimentsClient;

/**
 * @param string $formattedName The name of the
 *                              [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format:
 *                              `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/environments/<Environment ID>/experiments/<Experiment ID>`. Please see
 *                              {@see ExperimentsClient::experimentName()} for help formatting this field.
 */
function delete_experiment_sample(string $formattedName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Call the API and handle any network failures.
    try {
        $experimentsClient->deleteExperiment($formattedName);
        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 = ExperimentsClient::experimentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]',
        '[EXPERIMENT]'
    );

    delete_experiment_sample($formattedName);
}

    getExperiment

    Retrieves the specified Experiment .

    Parameters
    Name
    Description
    name
    string

    Required. The name of the Environment . Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID> .

    optionalArgs
    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\Cx\V3\Experiment
    Example 
     use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\ExperimentsClient;

/**
 * @param string $formattedName The name of the
 *                              [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format:
 *                              `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/environments/<Environment ID>/experiments/<Experiment ID>`. Please see
 *                              {@see ExperimentsClient::experimentName()} for help formatting this field.
 */
function get_experiment_sample(string $formattedName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->getExperiment($formattedName);
        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 = ExperimentsClient::experimentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]',
        '[EXPERIMENT]'
    );

    get_experiment_sample($formattedName);
}

    listExperiments

    Returns the list of all experiments in the specified Environment .

    Parameters
    Name
    Description
    parent
    string

    Required. The Environment to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID> .

    optionalArgs
    array

    Optional.

    ↳ pageSize
    int

    The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

    ↳ pageToken
    string

    A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

    ↳ 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\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\ExperimentsClient;

/**
 * @param string $formattedParent The [Environment][google.cloud.dialogflow.cx.v3.Environment] to
 *                                list all environments for. Format: `projects/<Project
 *                                ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment
 *                                ID>`. Please see
 *                                {@see ExperimentsClient::environmentName()} for help formatting this field.
 */
function list_experiments_sample(string $formattedParent): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

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

        /** @var Experiment $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 = ExperimentsClient::environmentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]'
    );

    list_experiments_sample($formattedParent);
}

    startExperiment

    Starts the specified Experiment . This rpc only changes the state of experiment from PENDING to RUNNING.

    Parameters
    Name
    Description
    name
    string

    Required. Resource name of the experiment to start. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID> .

    optionalArgs
    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\Cx\V3\Experiment
    Example 
     use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\ExperimentsClient;

/**
 * @param string $formattedName Resource name of the experiment to start.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/environments/<Environment ID>/experiments/<Experiment ID>`. Please see
 *                              {@see ExperimentsClient::experimentName()} for help formatting this field.
 */
function start_experiment_sample(string $formattedName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->startExperiment($formattedName);
        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 = ExperimentsClient::experimentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]',
        '[EXPERIMENT]'
    );

    start_experiment_sample($formattedName);
}

    stopExperiment

    Stops the specified Experiment .

    This rpc only changes the state of experiment from RUNNING to DONE.

    Parameters
    Name
    Description
    name
    string

    Required. Resource name of the experiment to stop. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID> .

    optionalArgs
    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\Cx\V3\Experiment
    Example 
     use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\ExperimentsClient;

/**
 * @param string $formattedName Resource name of the experiment to stop.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/environments/<Environment ID>/experiments/<Experiment ID>`. Please see
 *                              {@see ExperimentsClient::experimentName()} for help formatting this field.
 */
function stop_experiment_sample(string $formattedName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->stopExperiment($formattedName);
        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 = ExperimentsClient::experimentName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENVIRONMENT]',
        '[EXPERIMENT]'
    );

    stop_experiment_sample($formattedName);
}

    updateExperiment

    Updates the specified Experiment .

    Parameters
    Name
    Description
    experiment
    Google\Cloud\Dialogflow\Cx\V3\Experiment

    Required. The experiment to update.

    updateMask
    Google\Protobuf\FieldMask

    Required. The mask to control which fields get updated.

    optionalArgs
    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\Cx\V3\Experiment
    Example 
     use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Experiment;
use Google\Cloud\Dialogflow\Cx\V3\ExperimentsClient;
use Google\Protobuf\FieldMask;

/**
 * @param string $experimentDisplayName The human-readable name of the experiment (unique in an
 *                                      environment). Limit of 64 characters.
 */
function update_experiment_sample(string $experimentDisplayName): void
{
    // Create a client.
    $experimentsClient = new ExperimentsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $experiment = (new Experiment())
        ->setDisplayName($experimentDisplayName);
    $updateMask = new FieldMask();

    // Call the API and handle any network failures.
    try {
        /** @var Experiment $response */
        $response = $experimentsClient->updateExperiment($experiment, $updateMask);
        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
{
    $experimentDisplayName = '[DISPLAY_NAME]';

    update_experiment_sample($experimentDisplayName);
}

    getLocation

    Gets information about a location.

    Parameters
    Name
    Description
    optionalArgs
    array

    Optional.

    ↳ name
    string

    Resource name for the location.

    ↳ 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\Cx\V3\ExperimentsClient;
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.
    $experimentsClient = new ExperimentsClient();

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

    Parameters
    Name
    Description
    optionalArgs
    array

    Optional.

    ↳ name
    string

    The resource that owns the locations collection, if applicable.

    ↳ filter
    string

    The standard list filter.

    ↳ pageSize
    int

    The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

    ↳ pageToken
    string

    A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

    ↳ 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\Cx\V3\ExperimentsClient;
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.
    $experimentsClient = new ExperimentsClient();

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

        /** @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());
    }
}

    static::environmentName

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

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

    static::experimentName

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

    Parameters
    Name
    Description
    project
    string
    location
    string
    agent
    string
    environment
    string
    experiment
    string
    Returns
    Type
    Description
    string
    The formatted experiment resource.

    static::versionName

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

    Parameters
    Name
    Description
    project
    string
    location
    string
    agent
    string
    flow
    string
    version
    string
    Returns
    Type
    Description
    string
    The formatted version 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

    • environment: projects/{project}/locations/{location}/agents/{agent}/environments/{environment}
    • experiment: projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/experiments/{experiment}
    • version: projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/versions/{version}

    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.

    Constants

    SERVICE_NAME

      Value: 'google.cloud.dialogflow.cx.v3.Experiments'

    The name of the service.

    SERVICE_ADDRESS

      Value: 'dialogflow.googleapis.com'

    The default address of the service.

    DEFAULT_SERVICE_PORT

      Value: 443

    The default port of the service.

    CODEGEN_NAME

      Value: 'gapic'

    The name of the code generator, to be included in the agent header.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: