Google Cloud Dialogflow Cx V3 Client - Class ToolsClient (0.10.1)

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\CreateToolRequest;
use Google\Cloud\Dialogflow\Cx\V3\Tool;

/**
 * @param string $formattedParent The agent to create a Tool for.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                {@see ToolsClient::agentName()} for help formatting this field.
 * @param string $toolDisplayName The human-readable name of the Tool, unique within an agent.
 * @param string $toolDescription High level description of the Tool and its usage.
 */
function create_tool_sample(
    string $formattedParent,
    string $toolDisplayName,
    string $toolDescription
): void {
    // Create a client.
    $toolsClient = new ToolsClient();

    // Prepare the request message.
    $tool = (new Tool())
        ->setDisplayName($toolDisplayName)
        ->setDescription($toolDescription);
    $request = (new CreateToolRequest())
        ->setParent($formattedParent)
        ->setTool($tool);

    // Call the API and handle any network failures.
    try {
        /** @var Tool $response */
        $response = $toolsClient->createTool($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 = ToolsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $toolDisplayName = '[DISPLAY_NAME]';
    $toolDescription = '[DESCRIPTION]';

    create_tool_sample($formattedParent, $toolDisplayName, $toolDescription);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\CreateToolVersionRequest;
use Google\Cloud\Dialogflow\Cx\V3\Tool;
use Google\Cloud\Dialogflow\Cx\V3\ToolVersion;

/**
 * @param string $formattedParent            The tool to create a version for.
 *                                           Format:
 *                                           `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`. Please see
 *                                           {@see ToolsClient::toolName()} for help formatting this field.
 * @param string $toolVersionDisplayName     The display name of the tool version.
 * @param string $toolVersionToolDisplayName The human-readable name of the Tool, unique within an agent.
 * @param string $toolVersionToolDescription High level description of the Tool and its usage.
 */
function create_tool_version_sample(
    string $formattedParent,
    string $toolVersionDisplayName,
    string $toolVersionToolDisplayName,
    string $toolVersionToolDescription
): void {
    // Create a client.
    $toolsClient = new ToolsClient();

    // Prepare the request message.
    $toolVersionTool = (new Tool())
        ->setDisplayName($toolVersionToolDisplayName)
        ->setDescription($toolVersionToolDescription);
    $toolVersion = (new ToolVersion())
        ->setDisplayName($toolVersionDisplayName)
        ->setTool($toolVersionTool);
    $request = (new CreateToolVersionRequest())
        ->setParent($formattedParent)
        ->setToolVersion($toolVersion);

    // Call the API and handle any network failures.
    try {
        /** @var ToolVersion $response */
        $response = $toolsClient->createToolVersion($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 = ToolsClient::toolName('[PROJECT]', '[LOCATION]', '[AGENT]', '[TOOL]');
    $toolVersionDisplayName = '[DISPLAY_NAME]';
    $toolVersionToolDisplayName = '[DISPLAY_NAME]';
    $toolVersionToolDescription = '[DESCRIPTION]';

    create_tool_version_sample(
        $formattedParent,
        $toolVersionDisplayName,
        $toolVersionToolDisplayName,
        $toolVersionToolDescription
    );
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\DeleteToolRequest;

/**
 * @param string $formattedName The name of the Tool to be deleted.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`. Please see
 *                              {@see ToolsClient::toolName()} for help formatting this field.
 */
function delete_tool_sample(string $formattedName): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

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

    // Call the API and handle any network failures.
    try {
        $toolsClient->deleteTool($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 = ToolsClient::toolName('[PROJECT]', '[LOCATION]', '[AGENT]', '[TOOL]');

    delete_tool_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\DeleteToolVersionRequest;

/**
 * @param string $formattedName The name of the tool version to delete.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>`. Please see
 *                              {@see ToolsClient::toolVersionName()} for help formatting this field.
 */
function delete_tool_version_sample(string $formattedName): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

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

    // Call the API and handle any network failures.
    try {
        $toolsClient->deleteToolVersion($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 = ToolsClient::toolVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[TOOL]',
        '[VERSION]'
    );

    delete_tool_version_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\GetToolRequest;
use Google\Cloud\Dialogflow\Cx\V3\Tool;

/**
 * @param string $formattedName The name of the Tool.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`. Please see
 *                              {@see ToolsClient::toolName()} for help formatting this field.
 */
function get_tool_sample(string $formattedName): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Tool $response */
        $response = $toolsClient->getTool($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 = ToolsClient::toolName('[PROJECT]', '[LOCATION]', '[AGENT]', '[TOOL]');

    get_tool_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\GetToolVersionRequest;
use Google\Cloud\Dialogflow\Cx\V3\ToolVersion;

/**
 * @param string $formattedName The name of the tool version.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>`. Please see
 *                              {@see ToolsClient::toolVersionName()} for help formatting this field.
 */
function get_tool_version_sample(string $formattedName): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ToolVersion $response */
        $response = $toolsClient->getToolVersion($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 = ToolsClient::toolVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[TOOL]',
        '[VERSION]'
    );

    get_tool_version_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\ListToolVersionsRequest;
use Google\Cloud\Dialogflow\Cx\V3\ToolVersion;

/**
 * @param string $formattedParent The parent of the tool versions.
 *                                Format:
 *                                `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`. Please see
 *                                {@see ToolsClient::toolName()} for help formatting this field.
 */
function list_tool_versions_sample(string $formattedParent): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

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

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

        /** @var ToolVersion $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 = ToolsClient::toolName('[PROJECT]', '[LOCATION]', '[AGENT]', '[TOOL]');

    list_tool_versions_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\ListToolsRequest;
use Google\Cloud\Dialogflow\Cx\V3\Tool;

/**
 * @param string $formattedParent The agent to list the Tools from.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                {@see ToolsClient::agentName()} for help formatting this field.
 */
function list_tools_sample(string $formattedParent): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

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

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

        /** @var Tool $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 = ToolsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    list_tools_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\RestoreToolVersionRequest;
use Google\Cloud\Dialogflow\Cx\V3\RestoreToolVersionResponse;

/**
 * @param string $formattedName The name of the tool version.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>`. Please see
 *                              {@see ToolsClient::toolVersionName()} for help formatting this field.
 */
function restore_tool_version_sample(string $formattedName): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var RestoreToolVersionResponse $response */
        $response = $toolsClient->restoreToolVersion($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 = ToolsClient::toolVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[TOOL]',
        '[VERSION]'
    );

    restore_tool_version_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\ToolsClient;
use Google\Cloud\Dialogflow\Cx\V3\Tool;
use Google\Cloud\Dialogflow\Cx\V3\UpdateToolRequest;

/**
 * @param string $toolDisplayName The human-readable name of the Tool, unique within an agent.
 * @param string $toolDescription High level description of the Tool and its usage.
 */
function update_tool_sample(string $toolDisplayName, string $toolDescription): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

    // Prepare the request message.
    $tool = (new Tool())
        ->setDisplayName($toolDisplayName)
        ->setDescription($toolDescription);
    $request = (new UpdateToolRequest())
        ->setTool($tool);

    // Call the API and handle any network failures.
    try {
        /** @var Tool $response */
        $response = $toolsClient->updateTool($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
{
    $toolDisplayName = '[DISPLAY_NAME]';
    $toolDescription = '[DESCRIPTION]';

    update_tool_sample($toolDisplayName, $toolDescription);
}

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

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

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

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

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