Google Cloud Dialogflow V2 Client - Class ToolsClient (2.3.0)

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

/**
 * @param string $formattedParent The project/location to create tool for. Format:
 *                                `projects/<Project ID>/locations/<Location ID>`
 *                                Please see {@see ToolsClient::locationName()} for help formatting this field.
 * @param string $toolToolKey     A human readable short name of the tool, which should be unique
 *                                within the project. It should only contain letters, numbers, and
 *                                underscores, and it will be used by LLM to identify the tool.
 */
function create_tool_sample(string $formattedParent, string $toolToolKey): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

    // Prepare the request message.
    $tool = (new Tool())
        ->setToolKey($toolToolKey);
    $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::locationName('[PROJECT]', '[LOCATION]');
    $toolToolKey = '[TOOL_KEY]';

    create_tool_sample($formattedParent, $toolToolKey);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ToolsClient;
use Google\Cloud\Dialogflow\V2\DeleteToolRequest;

/**
 * @param string $formattedName The tool resource name to delete. Format:
 *                              `projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>`
 *                              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]', '[TOOL]');

    delete_tool_sample($formattedName);
}

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

/**
 * @param string $formattedName The tool resource name to retrieve. Format:
 *                              `projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>`
 *                              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]', '[TOOL]');

    get_tool_sample($formattedName);
}

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

/**
 * @param string $formattedParent The project/location to list tools for. Format:
 *                                `projects/<Project ID>/locations/<Location ID>`
 *                                Please see {@see ToolsClient::locationName()} 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::locationName('[PROJECT]', '[LOCATION]');

    list_tools_sample($formattedParent);
}

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

/**
 * @param string $toolToolKey A human readable short name of the tool, which should be unique
 *                            within the project. It should only contain letters, numbers, and
 *                            underscores, and it will be used by LLM to identify the tool.
 */
function update_tool_sample(string $toolToolKey): void
{
    // Create a client.
    $toolsClient = new ToolsClient();

    // Prepare the request message.
    $tool = (new Tool())
        ->setToolKey($toolToolKey);
    $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
{
    $toolToolKey = '[TOOL_KEY]';

    update_tool_sample($toolToolKey);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\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\V2\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());
    }
}