Google Cloud Dialogflow V2 Client - Class DocumentsClient (1.11.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\DocumentsClient;
use Google\Cloud\Dialogflow\V2\CreateDocumentRequest;
use Google\Cloud\Dialogflow\V2\Document;
use Google\Cloud\Dialogflow\V2\Document\KnowledgeType;
use Google\Rpc\Status;

/**
 * @param string $formattedParent               The knowledge base to create a document for.
 *                                              Format: `projects/<Project ID>/locations/<Location
 *                                              ID>/knowledgeBases/<Knowledge Base ID>`. Please see
 *                                              {@see DocumentsClient::knowledgeBaseName()} for help formatting this field.
 * @param string $documentDisplayName           The display name of the document. The name must be 1024 bytes or
 *                                              less; otherwise, the creation request fails.
 * @param string $documentMimeType              The MIME type of this document.
 * @param int    $documentKnowledgeTypesElement The knowledge type of document content.
 */
function create_document_sample(
    string $formattedParent,
    string $documentDisplayName,
    string $documentMimeType,
    int $documentKnowledgeTypesElement
): void {
    // Create a client.
    $documentsClient = new DocumentsClient();

    // Prepare the request message.
    $documentKnowledgeTypes = [$documentKnowledgeTypesElement,];
    $document = (new Document())
        ->setDisplayName($documentDisplayName)
        ->setMimeType($documentMimeType)
        ->setKnowledgeTypes($documentKnowledgeTypes);
    $request = (new CreateDocumentRequest())
        ->setParent($formattedParent)
        ->setDocument($document);

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

        if ($response->operationSucceeded()) {
            /** @var Document $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
{
    $formattedParent = DocumentsClient::knowledgeBaseName('[PROJECT]', '[KNOWLEDGE_BASE]');
    $documentDisplayName = '[DISPLAY_NAME]';
    $documentMimeType = '[MIME_TYPE]';
    $documentKnowledgeTypesElement = KnowledgeType::KNOWLEDGE_TYPE_UNSPECIFIED;

    create_document_sample(
        $formattedParent,
        $documentDisplayName,
        $documentMimeType,
        $documentKnowledgeTypesElement
    );
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\DocumentsClient;
use Google\Cloud\Dialogflow\V2\DeleteDocumentRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the document to delete.
 *                              Format: `projects/<Project ID>/locations/<Location
 *                              ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. Please see
 *                              {@see DocumentsClient::documentName()} for help formatting this field.
 */
function delete_document_sample(string $formattedName): void
{
    // Create a client.
    $documentsClient = new DocumentsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $documentsClient->deleteDocument($request);
        $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 = DocumentsClient::documentName('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]');

    delete_document_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\DocumentsClient;
use Google\Cloud\Dialogflow\V2\Document;
use Google\Cloud\Dialogflow\V2\ExportDocumentRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the document to export.
 *                              Format: `projects/<Project ID>/locations/<Location
 *                              ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. Please see
 *                              {@see DocumentsClient::documentName()} for help formatting this field.
 */
function export_document_sample(string $formattedName): void
{
    // Create a client.
    $documentsClient = new DocumentsClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var Document $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 = DocumentsClient::documentName('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]');

    export_document_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\DocumentsClient;
use Google\Cloud\Dialogflow\V2\Document;
use Google\Cloud\Dialogflow\V2\GetDocumentRequest;

/**
 * @param string $formattedName The name of the document to retrieve.
 *                              Format `projects/<Project ID>/locations/<Location
 *                              ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. Please see
 *                              {@see DocumentsClient::documentName()} for help formatting this field.
 */
function get_document_sample(string $formattedName): void
{
    // Create a client.
    $documentsClient = new DocumentsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Document $response */
        $response = $documentsClient->getDocument($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 = DocumentsClient::documentName('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]');

    get_document_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\DocumentsClient;
use Google\Cloud\Dialogflow\V2\Document\KnowledgeType;
use Google\Cloud\Dialogflow\V2\ImportDocumentTemplate;
use Google\Cloud\Dialogflow\V2\ImportDocumentsRequest;
use Google\Cloud\Dialogflow\V2\ImportDocumentsResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                       The knowledge base to import documents into.
 *                                                      Format: `projects/<Project ID>/locations/<Location
 *                                                      ID>/knowledgeBases/<Knowledge Base ID>`. Please see
 *                                                      {@see DocumentsClient::knowledgeBaseName()} for help formatting this field.
 * @param string $documentTemplateMimeType              The MIME type of the document.
 * @param int    $documentTemplateKnowledgeTypesElement The knowledge type of document content.
 */
function import_documents_sample(
    string $formattedParent,
    string $documentTemplateMimeType,
    int $documentTemplateKnowledgeTypesElement
): void {
    // Create a client.
    $documentsClient = new DocumentsClient();

    // Prepare the request message.
    $documentTemplateKnowledgeTypes = [$documentTemplateKnowledgeTypesElement,];
    $documentTemplate = (new ImportDocumentTemplate())
        ->setMimeType($documentTemplateMimeType)
        ->setKnowledgeTypes($documentTemplateKnowledgeTypes);
    $request = (new ImportDocumentsRequest())
        ->setParent($formattedParent)
        ->setDocumentTemplate($documentTemplate);

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

        if ($response->operationSucceeded()) {
            /** @var ImportDocumentsResponse $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
{
    $formattedParent = DocumentsClient::knowledgeBaseName('[PROJECT]', '[KNOWLEDGE_BASE]');
    $documentTemplateMimeType = '[MIME_TYPE]';
    $documentTemplateKnowledgeTypesElement = KnowledgeType::KNOWLEDGE_TYPE_UNSPECIFIED;

    import_documents_sample(
        $formattedParent,
        $documentTemplateMimeType,
        $documentTemplateKnowledgeTypesElement
    );
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\DocumentsClient;
use Google\Cloud\Dialogflow\V2\Document;
use Google\Cloud\Dialogflow\V2\ListDocumentsRequest;

/**
 * @param string $formattedParent The knowledge base to list all documents for.
 *                                Format: `projects/<Project ID>/locations/<Location
 *                                ID>/knowledgeBases/<Knowledge Base ID>`. Please see
 *                                {@see DocumentsClient::knowledgeBaseName()} for help formatting this field.
 */
function list_documents_sample(string $formattedParent): void
{
    // Create a client.
    $documentsClient = new DocumentsClient();

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

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

        /** @var Document $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 = DocumentsClient::knowledgeBaseName('[PROJECT]', '[KNOWLEDGE_BASE]');

    list_documents_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\DocumentsClient;
use Google\Cloud\Dialogflow\V2\Document;
use Google\Cloud\Dialogflow\V2\ReloadDocumentRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the document to reload.
 *                              Format: `projects/<Project ID>/locations/<Location
 *                              ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
 *                              Please see {@see DocumentsClient::documentName()} for help formatting this field.
 */
function reload_document_sample(string $formattedName): void
{
    // Create a client.
    $documentsClient = new DocumentsClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var Document $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 = DocumentsClient::documentName('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]');

    reload_document_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\DocumentsClient;
use Google\Cloud\Dialogflow\V2\Document;
use Google\Cloud\Dialogflow\V2\Document\KnowledgeType;
use Google\Cloud\Dialogflow\V2\UpdateDocumentRequest;
use Google\Rpc\Status;

/**
 * @param string $documentDisplayName           The display name of the document. The name must be 1024 bytes or
 *                                              less; otherwise, the creation request fails.
 * @param string $documentMimeType              The MIME type of this document.
 * @param int    $documentKnowledgeTypesElement The knowledge type of document content.
 */
function update_document_sample(
    string $documentDisplayName,
    string $documentMimeType,
    int $documentKnowledgeTypesElement
): void {
    // Create a client.
    $documentsClient = new DocumentsClient();

    // Prepare the request message.
    $documentKnowledgeTypes = [$documentKnowledgeTypesElement,];
    $document = (new Document())
        ->setDisplayName($documentDisplayName)
        ->setMimeType($documentMimeType)
        ->setKnowledgeTypes($documentKnowledgeTypes);
    $request = (new UpdateDocumentRequest())
        ->setDocument($document);

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

        if ($response->operationSucceeded()) {
            /** @var Document $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
{
    $documentDisplayName = '[DISPLAY_NAME]';
    $documentMimeType = '[MIME_TYPE]';
    $documentKnowledgeTypesElement = KnowledgeType::KNOWLEDGE_TYPE_UNSPECIFIED;

    update_document_sample($documentDisplayName, $documentMimeType, $documentKnowledgeTypesElement);
}

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

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

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

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

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