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

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Agent;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;

/**
 * @param string $formattedParent          The location to create a agent for.
 *                                         Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                         {@see AgentsClient::locationName()} for help formatting this field.
 * @param string $agentDisplayName         The human-readable name of the agent, unique within the location.
 * @param string $agentDefaultLanguageCode Immutable. The default language of the agent as a language tag.
 *                                         See [Language
 *                                         Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 *                                         for a list of the currently supported language codes.
 *                                         This field cannot be set by the
 *                                         [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 *                                         method.
 * @param string $agentTimeZone            The time zone of the agent from the [time zone
 *                                         database](https://www.iana.org/time-zones), e.g., America/New_York,
 *                                         Europe/Paris.
 */
function create_agent_sample(
    string $formattedParent,
    string $agentDisplayName,
    string $agentDefaultLanguageCode,
    string $agentTimeZone
): void {
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $agent = (new Agent())
        ->setDisplayName($agentDisplayName)
        ->setDefaultLanguageCode($agentDefaultLanguageCode)
        ->setTimeZone($agentTimeZone);

    // Call the API and handle any network failures.
    try {
        /** @var Agent $response */
        $response = $agentsClient->createAgent($formattedParent, $agent);
        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 = AgentsClient::locationName('[PROJECT]', '[LOCATION]');
    $agentDisplayName = '[DISPLAY_NAME]';
    $agentDefaultLanguageCode = '[DEFAULT_LANGUAGE_CODE]';
    $agentTimeZone = '[TIME_ZONE]';

    create_agent_sample($formattedParent, $agentDisplayName, $agentDefaultLanguageCode, $agentTimeZone);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;

/**
 * @param string $formattedName The name of the agent to delete.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function delete_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        $agentsClient->deleteAgent($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 = AgentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    delete_agent_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\ExportAgentResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the agent to export.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function export_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

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

        if ($response->operationSucceeded()) {
            /** @var ExportAgentResponse $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
{
    $formattedName = AgentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    export_agent_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Agent;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;

/**
 * @param string $formattedName The name of the agent.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function get_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Agent $response */
        $response = $agentsClient->getAgent($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 = AgentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    get_agent_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\AgentValidationResult;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;

/**
 * @param string $formattedName The agent name.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/validationResult`. Please see
 *                              {@see AgentsClient::agentValidationResultName()} for help formatting this field.
 */
function get_agent_validation_result_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var AgentValidationResult $response */
        $response = $agentsClient->getAgentValidationResult($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 = AgentsClient::agentValidationResultName('[PROJECT]', '[LOCATION]', '[AGENT]');

    get_agent_validation_result_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\GenerativeSettings;

/**
 * @param string $formattedName Format: `projects/<Project ID>/locations/<Location
 *                              ID>/agents/<Agent ID>/generativeSettings`. Please see
 *                              {@see AgentsClient::agentGenerativeSettingsName()} for help formatting this field.
 * @param string $languageCode  Language code of the generative settings.
 */
function get_generative_settings_sample(string $formattedName, string $languageCode): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var GenerativeSettings $response */
        $response = $agentsClient->getGenerativeSettings($formattedName, $languageCode);
        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 = AgentsClient::agentGenerativeSettingsName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $languageCode = '[LANGUAGE_CODE]';

    get_generative_settings_sample($formattedName, $languageCode);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Agent;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;

/**
 * @param string $formattedParent The location to list all agents for.
 *                                Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                {@see AgentsClient::locationName()} for help formatting this field.
 */
function list_agents_sample(string $formattedParent): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

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

        /** @var Agent $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 = AgentsClient::locationName('[PROJECT]', '[LOCATION]');

    list_agents_sample($formattedParent);
} 

 use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the agent to restore into.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function restore_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $agentsClient->restoreAgent($formattedName);
        $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
{
    $formattedName = AgentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    restore_agent_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Agent;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;

/**
 * @param string $agentDisplayName         The human-readable name of the agent, unique within the location.
 * @param string $agentDefaultLanguageCode Immutable. The default language of the agent as a language tag.
 *                                         See [Language
 *                                         Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 *                                         for a list of the currently supported language codes.
 *                                         This field cannot be set by the
 *                                         [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 *                                         method.
 * @param string $agentTimeZone            The time zone of the agent from the [time zone
 *                                         database](https://www.iana.org/time-zones), e.g., America/New_York,
 *                                         Europe/Paris.
 */
function update_agent_sample(
    string $agentDisplayName,
    string $agentDefaultLanguageCode,
    string $agentTimeZone
): void {
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $agent = (new Agent())
        ->setDisplayName($agentDisplayName)
        ->setDefaultLanguageCode($agentDefaultLanguageCode)
        ->setTimeZone($agentTimeZone);

    // Call the API and handle any network failures.
    try {
        /** @var Agent $response */
        $response = $agentsClient->updateAgent($agent);
        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
{
    $agentDisplayName = '[DISPLAY_NAME]';
    $agentDefaultLanguageCode = '[DEFAULT_LANGUAGE_CODE]';
    $agentTimeZone = '[TIME_ZONE]';

    update_agent_sample($agentDisplayName, $agentDefaultLanguageCode, $agentTimeZone);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\GenerativeSettings;

/**
 * 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 update_generative_settings_sample(): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $generativeSettings = new GenerativeSettings();

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

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\AgentValidationResult;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;

/**
 * @param string $formattedName The agent to validate.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function validate_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var AgentValidationResult $response */
        $response = $agentsClient->validateAgent($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 = AgentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    validate_agent_sample($formattedName);
} 

 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;
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.
    $agentsClient = new AgentsClient();

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

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\AgentsClient;
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.
    $agentsClient = new AgentsClient();

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