Google Cloud Dialogflow V2 Client - Class ConversationModelsClient (1.15.0)

Namespace

Methods

__construct

createConversationModel

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient;
use Google\Cloud\Dialogflow\V2\ConversationModel;
use Google\Cloud\Dialogflow\V2\CreateConversationModelRequest;
use Google\Cloud\Dialogflow\V2\InputDataset;
use Google\Rpc\Status;

/**
 * @param string $conversationModelDisplayName              The display name of the model. At most 64 bytes long.
 * @param string $formattedConversationModelDatasetsDataset ConversationDataset resource name. Format:
 *                                                          `projects/<Project ID>/locations/<Location
 *                                                          ID>/conversationDatasets/<Conversation Dataset ID>`
 *                                                          Please see {@see ConversationModelsClient::conversationDatasetName()} for help formatting this field.
 */
function create_conversation_model_sample(
    string $conversationModelDisplayName,
    string $formattedConversationModelDatasetsDataset
): void {
    // Create a client.
    $conversationModelsClient = new ConversationModelsClient();

    // Prepare the request message.
    $inputDataset = (new InputDataset())
        ->setDataset($formattedConversationModelDatasetsDataset);
    $conversationModelDatasets = [$inputDataset,];
    $conversationModel = (new ConversationModel())
        ->setDisplayName($conversationModelDisplayName)
        ->setDatasets($conversationModelDatasets);
    $request = (new CreateConversationModelRequest())
        ->setConversationModel($conversationModel);

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

        if ($response->operationSucceeded()) {
            /** @var ConversationModel $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
{
    $conversationModelDisplayName = '[DISPLAY_NAME]';
    $formattedConversationModelDatasetsDataset = ConversationModelsClient::conversationDatasetName(
        '[PROJECT]',
        '[LOCATION]',
        '[CONVERSATION_DATASET]'
    );

    create_conversation_model_sample(
        $conversationModelDisplayName,
        $formattedConversationModelDatasetsDataset
    );
}

createConversationModelEvaluation

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient;
use Google\Cloud\Dialogflow\V2\ConversationModelEvaluation;
use Google\Cloud\Dialogflow\V2\CreateConversationModelEvaluationRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The conversation model resource name. Format:
 *                                `projects/<Project ID>/locations/<Location
 *                                ID>/conversationModels/<Conversation Model ID>`
 *                                Please see {@see ConversationModelsClient::conversationModelName()} for help formatting this field.
 */
function create_conversation_model_evaluation_sample(string $formattedParent): void
{
    // Create a client.
    $conversationModelsClient = new ConversationModelsClient();

    // Prepare the request message.
    $conversationModelEvaluation = new ConversationModelEvaluation();
    $request = (new CreateConversationModelEvaluationRequest())
        ->setParent($formattedParent)
        ->setConversationModelEvaluation($conversationModelEvaluation);

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

        if ($response->operationSucceeded()) {
            /** @var ConversationModelEvaluation $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 = ConversationModelsClient::conversationModelName(
        '[PROJECT]',
        '[LOCATION]',
        '[CONVERSATION_MODEL]'
    );

    create_conversation_model_evaluation_sample($formattedParent);
}

deleteConversationModel

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient;
use Google\Cloud\Dialogflow\V2\DeleteConversationModelRequest;
use Google\Rpc\Status;

/**
 * @param string $name The conversation model to delete. Format:
 *                     `projects/<Project ID>/conversationModels/<Conversation Model ID>`
 */
function delete_conversation_model_sample(string $name): void
{
    // Create a client.
    $conversationModelsClient = new ConversationModelsClient();

    // Prepare the request message.
    $request = (new DeleteConversationModelRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $conversationModelsClient->deleteConversationModel($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
{
    $name = '[NAME]';

    delete_conversation_model_sample($name);
}

deployConversationModel

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient;
use Google\Cloud\Dialogflow\V2\DeployConversationModelRequest;
use Google\Rpc\Status;

/**
 * @param string $name The conversation model to deploy. Format:
 *                     `projects/<Project ID>/conversationModels/<Conversation Model ID>`
 */
function deploy_conversation_model_sample(string $name): void
{
    // Create a client.
    $conversationModelsClient = new ConversationModelsClient();

    // Prepare the request message.
    $request = (new DeployConversationModelRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $conversationModelsClient->deployConversationModel($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
{
    $name = '[NAME]';

    deploy_conversation_model_sample($name);
}

getConversationModel

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient;
use Google\Cloud\Dialogflow\V2\ConversationModel;
use Google\Cloud\Dialogflow\V2\GetConversationModelRequest;

/**
 * @param string $name The conversation model to retrieve. Format:
 *                     `projects/<Project ID>/conversationModels/<Conversation Model ID>`
 */
function get_conversation_model_sample(string $name): void
{
    // Create a client.
    $conversationModelsClient = new ConversationModelsClient();

    // Prepare the request message.
    $request = (new GetConversationModelRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var ConversationModel $response */
        $response = $conversationModelsClient->getConversationModel($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
{
    $name = '[NAME]';

    get_conversation_model_sample($name);
}

getConversationModelEvaluation

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient;
use Google\Cloud\Dialogflow\V2\ConversationModelEvaluation;
use Google\Cloud\Dialogflow\V2\GetConversationModelEvaluationRequest;

/**
 * @param string $name The conversation model evaluation resource name. Format:
 *                     `projects/<Project ID>/conversationModels/<Conversation Model
 *                     ID>/evaluations/<Evaluation ID>`
 */
function get_conversation_model_evaluation_sample(string $name): void
{
    // Create a client.
    $conversationModelsClient = new ConversationModelsClient();

    // Prepare the request message.
    $request = (new GetConversationModelEvaluationRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var ConversationModelEvaluation $response */
        $response = $conversationModelsClient->getConversationModelEvaluation($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
{
    $name = '[NAME]';

    get_conversation_model_evaluation_sample($name);
}

listConversationModelEvaluations

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient;
use Google\Cloud\Dialogflow\V2\ConversationModelEvaluation;
use Google\Cloud\Dialogflow\V2\ListConversationModelEvaluationsRequest;

/**
 * @param string $parent The conversation model resource name. Format:
 *                       `projects/<Project ID>/conversationModels/<Conversation Model ID>`
 */
function list_conversation_model_evaluations_sample(string $parent): void
{
    // Create a client.
    $conversationModelsClient = new ConversationModelsClient();

    // Prepare the request message.
    $request = (new ListConversationModelEvaluationsRequest())
        ->setParent($parent);

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

        /** @var ConversationModelEvaluation $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
{
    $parent = '[PARENT]';

    list_conversation_model_evaluations_sample($parent);
}

listConversationModels

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient;
use Google\Cloud\Dialogflow\V2\ConversationModel;
use Google\Cloud\Dialogflow\V2\ListConversationModelsRequest;

/**
 * @param string $parent The project to list all conversation models for.
 *                       Format: `projects/<Project ID>`
 */
function list_conversation_models_sample(string $parent): void
{
    // Create a client.
    $conversationModelsClient = new ConversationModelsClient();

    // Prepare the request message.
    $request = (new ListConversationModelsRequest())
        ->setParent($parent);

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

        /** @var ConversationModel $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
{
    $parent = '[PARENT]';

    list_conversation_models_sample($parent);
}

undeployConversationModel

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient;
use Google\Cloud\Dialogflow\V2\UndeployConversationModelRequest;
use Google\Rpc\Status;

/**
 * @param string $name The conversation model to undeploy. Format:
 *                     `projects/<Project ID>/conversationModels/<Conversation Model ID>`
 */
function undeploy_conversation_model_sample(string $name): void
{
    // Create a client.
    $conversationModelsClient = new ConversationModelsClient();

    // Prepare the request message.
    $request = (new UndeployConversationModelRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $conversationModelsClient->undeployConversationModel($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
{
    $name = '[NAME]';

    undeploy_conversation_model_sample($name);
}

getLocation

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

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

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

listLocations

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

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

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

createConversationModelAsync

createConversationModelEvaluationAsync

deleteConversationModelAsync

deployConversationModelAsync

getConversationModelAsync

getConversationModelEvaluationAsync

listConversationModelEvaluationsAsync

listConversationModelsAsync

undeployConversationModelAsync

getLocationAsync

listLocationsAsync

getOperationsClient

resumeOperation

static::conversationDatasetName

static::conversationModelName

static::conversationModelEvaluationName

static::documentName

static::projectConversationModelName

static::projectConversationModelEvaluationName

static::projectKnowledgeBaseDocumentName

static::projectLocationConversationModelName

static::projectLocationConversationModelEvaluationName

static::projectLocationKnowledgeBaseDocumentName

static::parseName