Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ConversationModelsClient.
Service Description: Manages a collection of models for human agent assistant.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$conversationModelsClient = new ConversationModelsClient();
try {
$conversationModel = new ConversationModel();
$operationResponse = $conversationModelsClient->createConversationModel($conversationModel);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $conversationModelsClient->createConversationModel($conversationModel);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $conversationModelsClient->resumeOperation($operationName, 'createConversationModel');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$conversationModelsClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This service has a new (beta) implementation. See Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient to use the new surface.
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createConversationModel
Creates a model.
This method is a long-running
operation.
The returned Operation
type has the following method-specific fields:
metadata
: CreateConversationModelOperationMetadataresponse
: ConversationModel
Parameters | |
---|---|
Name | Description |
conversationModel |
Google\Cloud\Dialogflow\V2\ConversationModel
Required. The conversation model to create. |
optionalArgs |
array
Optional. |
↳ parent |
string
The project to create conversation model for. Format: |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\ConversationModel;
use Google\Cloud\Dialogflow\V2\ConversationDatasetsClient;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
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 any non-scalar elements to be passed along with the request.
$inputDataset = (new InputDataset())
->setDataset($formattedConversationModelDatasetsDataset);
$conversationModelDatasets = [$inputDataset,];
$conversationModel = (new ConversationModel())
->setDisplayName($conversationModelDisplayName)
->setDatasets($conversationModelDatasets);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $conversationModelsClient->createConversationModel($conversationModel);
$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 = ConversationDatasetsClient::conversationDatasetName(
'[PROJECT]',
'[LOCATION]',
'[CONVERSATION_DATASET]'
);
create_conversation_model_sample(
$conversationModelDisplayName,
$formattedConversationModelDatasetsDataset
);
}
createConversationModelEvaluation
Creates evaluation of a conversation model.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The conversation model resource name. Format:
|
conversationModelEvaluation |
Google\Cloud\Dialogflow\V2\ConversationModelEvaluation
Required. The conversation model evaluation to be created. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\ConversationModelEvaluation;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
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 any non-scalar elements to be passed along with the request.
$conversationModelEvaluation = new ConversationModelEvaluation();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $conversationModelsClient->createConversationModelEvaluation(
$formattedParent,
$conversationModelEvaluation
);
$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
Deletes a model.
This method is a long-running
operation.
The returned Operation
type has the following method-specific fields:
metadata
: DeleteConversationModelOperationMetadataresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
name |
string
Required. The conversation model to delete. Format:
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $conversationModelsClient->deleteConversationModel($name);
$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
Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed.
This method is a long-running
operation.
The returned Operation
type has the following method-specific fields:
metadata
: DeployConversationModelOperationMetadataresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
name |
string
Required. The conversation model to deploy. Format:
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $conversationModelsClient->deployConversationModel($name);
$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
Gets conversation model.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The conversation model to retrieve. Format:
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dialogflow\V2\ConversationModel |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ConversationModel;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var ConversationModel $response */
$response = $conversationModelsClient->getConversationModel($name);
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
Gets an evaluation of conversation model.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The conversation model evaluation resource name. Format:
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dialogflow\V2\ConversationModelEvaluation |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ConversationModelEvaluation;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var ConversationModelEvaluation $response */
$response = $conversationModelsClient->getConversationModelEvaluation($name);
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
Lists evaluations of a conversation model.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The conversation model resource name. Format:
|
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\ConversationModelEvaluation;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $conversationModelsClient->listConversationModelEvaluations($parent);
/** @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
Lists conversation models.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The project to list all conversation models for.
Format: |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\ConversationModel;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $conversationModelsClient->listConversationModels($parent);
/** @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
Undeploys a model. If the model is not deployed this method has no effect.
If the model is currently being used:
- For article suggestion, article suggestion will fallback to the default model if model is undeployed.
This method is a long-running
operation.
The returned Operation
type has the following method-specific fields:
metadata
: UndeployConversationModelOperationMetadataresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
name |
string
Required. The conversation model to undeploy. Format:
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $conversationModelsClient->undeployConversationModel($name);
$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
Gets information about a location.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Location\Location |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
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();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $conversationModelsClient->getLocation();
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\ConversationModelsClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $conversationModelsClient->listLocations();
/** @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());
}
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::conversationDatasetName
Formats a string containing the fully-qualified path to represent a conversation_dataset resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
conversationDataset |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted conversation_dataset resource. |
static::conversationModelName
Formats a string containing the fully-qualified path to represent a conversation_model resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
conversationModel |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted conversation_model resource. |
static::conversationModelEvaluationName
Formats a string containing the fully-qualified path to represent a conversation_model_evaluation resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
conversationModel |
string
|
evaluation |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted conversation_model_evaluation resource. |
static::documentName
Formats a string containing the fully-qualified path to represent a document resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
knowledgeBase |
string
|
document |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted document resource. |
static::projectConversationModelName
Formats a string containing the fully-qualified path to represent a project_conversation_model resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
conversationModel |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_conversation_model resource. |
static::projectConversationModelEvaluationName
Formats a string containing the fully-qualified path to represent a project_conversation_model_evaluation resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
conversationModel |
string
|
evaluation |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_conversation_model_evaluation resource. |
static::projectKnowledgeBaseDocumentName
Formats a string containing the fully-qualified path to represent a project_knowledge_base_document resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
knowledgeBase |
string
|
document |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_knowledge_base_document resource. |
static::projectLocationConversationModelName
Formats a string containing the fully-qualified path to represent a project_location_conversation_model resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
conversationModel |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_conversation_model resource. |
static::projectLocationConversationModelEvaluationName
Formats a string containing the fully-qualified path to represent a project_location_conversation_model_evaluation resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
conversationModel |
string
|
evaluation |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_conversation_model_evaluation resource. |
static::projectLocationKnowledgeBaseDocumentName
Formats a string containing the fully-qualified path to represent a project_location_knowledge_base_document resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
knowledgeBase |
string
|
document |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_knowledge_base_document resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- conversationDataset: projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}
- conversationModel: projects/{project}/locations/{location}/conversationModels/{conversation_model}
- conversationModelEvaluation: projects/{project}/conversationModels/{conversation_model}/evaluations/{evaluation}
- document: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
- projectConversationModel: projects/{project}/conversationModels/{conversation_model}
- projectConversationModelEvaluation: projects/{project}/conversationModels/{conversation_model}/evaluations/{evaluation}
- projectKnowledgeBaseDocument: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
- projectLocationConversationModel: projects/{project}/locations/{location}/conversationModels/{conversation_model}
- projectLocationConversationModelEvaluation: projects/{project}/locations/{location}/conversationModels/{conversation_model}/evaluations/{evaluation}
- projectLocationKnowledgeBaseDocument: projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |
Constants
SERVICE_NAME
Value: 'google.cloud.dialogflow.v2.ConversationModels'
The name of the service.
SERVICE_ADDRESS
Value: 'dialogflow.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.