Google Cloud Dialogflow V2 Client - Class KnowledgeBasesClient (1.14.0)

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\KnowledgeBasesClient;
use Google\Cloud\Dialogflow\V2\CreateKnowledgeBaseRequest;
use Google\Cloud\Dialogflow\V2\KnowledgeBase;

/**
 * @param string $formattedParent          The project to create a knowledge base for.
 *                                         Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                         {@see KnowledgeBasesClient::projectName()} for help formatting this field.
 * @param string $knowledgeBaseDisplayName The display name of the knowledge base. The name must be 1024
 *                                         bytes or less; otherwise, the creation request fails.
 */
function create_knowledge_base_sample(
    string $formattedParent,
    string $knowledgeBaseDisplayName
): void {
    // Create a client.
    $knowledgeBasesClient = new KnowledgeBasesClient();

    // Prepare the request message.
    $knowledgeBase = (new KnowledgeBase())
        ->setDisplayName($knowledgeBaseDisplayName);
    $request = (new CreateKnowledgeBaseRequest())
        ->setParent($formattedParent)
        ->setKnowledgeBase($knowledgeBase);

    // Call the API and handle any network failures.
    try {
        /** @var KnowledgeBase $response */
        $response = $knowledgeBasesClient->createKnowledgeBase($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 = KnowledgeBasesClient::projectName('[PROJECT]');
    $knowledgeBaseDisplayName = '[DISPLAY_NAME]';

    create_knowledge_base_sample($formattedParent, $knowledgeBaseDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\KnowledgeBasesClient;
use Google\Cloud\Dialogflow\V2\DeleteKnowledgeBaseRequest;

/**
 * @param string $formattedName The name of the knowledge base to delete.
 *                              Format: `projects/<Project ID>/locations/<Location
 *                              ID>/knowledgeBases/<Knowledge Base ID>`. Please see
 *                              {@see KnowledgeBasesClient::knowledgeBaseName()} for help formatting this field.
 */
function delete_knowledge_base_sample(string $formattedName): void
{
    // Create a client.
    $knowledgeBasesClient = new KnowledgeBasesClient();

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

    // Call the API and handle any network failures.
    try {
        $knowledgeBasesClient->deleteKnowledgeBase($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 = KnowledgeBasesClient::knowledgeBaseName('[PROJECT]', '[KNOWLEDGE_BASE]');

    delete_knowledge_base_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\KnowledgeBasesClient;
use Google\Cloud\Dialogflow\V2\GetKnowledgeBaseRequest;
use Google\Cloud\Dialogflow\V2\KnowledgeBase;

/**
 * @param string $formattedName The name of the knowledge base to retrieve.
 *                              Format `projects/<Project ID>/locations/<Location
 *                              ID>/knowledgeBases/<Knowledge Base ID>`. Please see
 *                              {@see KnowledgeBasesClient::knowledgeBaseName()} for help formatting this field.
 */
function get_knowledge_base_sample(string $formattedName): void
{
    // Create a client.
    $knowledgeBasesClient = new KnowledgeBasesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var KnowledgeBase $response */
        $response = $knowledgeBasesClient->getKnowledgeBase($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 = KnowledgeBasesClient::knowledgeBaseName('[PROJECT]', '[KNOWLEDGE_BASE]');

    get_knowledge_base_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\KnowledgeBasesClient;
use Google\Cloud\Dialogflow\V2\KnowledgeBase;
use Google\Cloud\Dialogflow\V2\ListKnowledgeBasesRequest;

/**
 * @param string $formattedParent The project to list of knowledge bases for.
 *                                Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                {@see KnowledgeBasesClient::projectName()} for help formatting this field.
 */
function list_knowledge_bases_sample(string $formattedParent): void
{
    // Create a client.
    $knowledgeBasesClient = new KnowledgeBasesClient();

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

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

        /** @var KnowledgeBase $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 = KnowledgeBasesClient::projectName('[PROJECT]');

    list_knowledge_bases_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\KnowledgeBasesClient;
use Google\Cloud\Dialogflow\V2\KnowledgeBase;
use Google\Cloud\Dialogflow\V2\UpdateKnowledgeBaseRequest;

/**
 * @param string $knowledgeBaseDisplayName The display name of the knowledge base. The name must be 1024
 *                                         bytes or less; otherwise, the creation request fails.
 */
function update_knowledge_base_sample(string $knowledgeBaseDisplayName): void
{
    // Create a client.
    $knowledgeBasesClient = new KnowledgeBasesClient();

    // Prepare the request message.
    $knowledgeBase = (new KnowledgeBase())
        ->setDisplayName($knowledgeBaseDisplayName);
    $request = (new UpdateKnowledgeBaseRequest())
        ->setKnowledgeBase($knowledgeBase);

    // Call the API and handle any network failures.
    try {
        /** @var KnowledgeBase $response */
        $response = $knowledgeBasesClient->updateKnowledgeBase($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
{
    $knowledgeBaseDisplayName = '[DISPLAY_NAME]';

    update_knowledge_base_sample($knowledgeBaseDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\KnowledgeBasesClient;
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.
    $knowledgeBasesClient = new KnowledgeBasesClient();

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

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

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

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