Google Cloud Dialogflow V2 Client - Class ConversationModelsClient (1.10.2)

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.

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 class is currently experimental and may be subject to changes. See Google\Cloud\Dialogflow\V2\ConversationModelsClient for the stable implementation

Namespace

Google \ Cloud \ Dialogflow \ V2 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
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 false.

↳ 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 rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ 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:

The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient::createConversationModelAsync() .

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\CreateConversationModelRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\ApiCore\OperationResponse

createConversationModelEvaluation

Creates evaluation of a conversation model.

The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient::createConversationModelEvaluationAsync() .

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\CreateConversationModelEvaluationRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\ApiCore\OperationResponse

deleteConversationModel

Deletes a model.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient::deleteConversationModelAsync() .

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\DeleteConversationModelRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\ApiCore\OperationResponse

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:

The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient::deployConversationModelAsync() .

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\DeployConversationModelRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\ApiCore\OperationResponse

getConversationModel

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\GetConversationModelRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\Cloud\Dialogflow\V2\ConversationModel

getConversationModelEvaluation

Gets an evaluation of conversation model.

The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient::getConversationModelEvaluationAsync() .

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\GetConversationModelEvaluationRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\Cloud\Dialogflow\V2\ConversationModelEvaluation

listConversationModelEvaluations

Lists evaluations of a conversation model.

The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient::listConversationModelEvaluationsAsync() .

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\ListConversationModelEvaluationsRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\ApiCore\PagedListResponse

listConversationModels

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\ListConversationModelsRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\ApiCore\PagedListResponse

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:

The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient::undeployConversationModelAsync() .

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\UndeployConversationModelRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\ApiCore\OperationResponse

getLocation

Gets information about a location.

The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient::getLocationAsync() .

Parameters
NameDescription
request Google\Cloud\Location\GetLocationRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\Cloud\Location\Location

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationModelsClient::listLocationsAsync() .

Parameters
NameDescription
request Google\Cloud\Location\ListLocationsRequest

A request to house fields associated with the call.

callOptions 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
TypeDescription
Google\ApiCore\PagedListResponse

createConversationModelAsync

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\CreateConversationModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createConversationModelEvaluationAsync

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\CreateConversationModelEvaluationRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteConversationModelAsync

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\DeleteConversationModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deployConversationModelAsync

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\DeployConversationModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getConversationModelAsync

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\GetConversationModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getConversationModelEvaluationAsync

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\GetConversationModelEvaluationRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listConversationModelEvaluationsAsync

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\ListConversationModelEvaluationsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listConversationModelsAsync

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\ListConversationModelsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

undeployConversationModelAsync

Parameters
NameDescription
request Google\Cloud\Dialogflow\V2\UndeployConversationModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
NameDescription
request Google\Cloud\Location\GetLocationRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
NameDescription
request Google\Cloud\Location\ListLocationsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
TypeDescription
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
NameDescription
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
TypeDescription
Google\ApiCore\OperationResponse

static::conversationDatasetName

Formats a string containing the fully-qualified path to represent a conversation_dataset resource.

Parameters
NameDescription
project string
location string
conversationDataset string
Returns
TypeDescription
stringThe formatted conversation_dataset resource.

static::conversationModelName

Formats a string containing the fully-qualified path to represent a conversation_model resource.

Parameters
NameDescription
project string
location string
conversationModel string
Returns
TypeDescription
stringThe formatted conversation_model resource.

static::conversationModelEvaluationName

Formats a string containing the fully-qualified path to represent a conversation_model_evaluation resource.

Parameters
NameDescription
project string
conversationModel string
evaluation string
Returns
TypeDescription
stringThe formatted conversation_model_evaluation resource.

static::documentName

Formats a string containing the fully-qualified path to represent a document resource.

Parameters
NameDescription
project string
knowledgeBase string
document string
Returns
TypeDescription
stringThe formatted document resource.

static::projectConversationModelName

Formats a string containing the fully-qualified path to represent a project_conversation_model resource.

Parameters
NameDescription
project string
conversationModel string
Returns
TypeDescription
stringThe formatted project_conversation_model resource.

static::projectConversationModelEvaluationName

Formats a string containing the fully-qualified path to represent a project_conversation_model_evaluation resource.

Parameters
NameDescription
project string
conversationModel string
evaluation string
Returns
TypeDescription
stringThe 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
NameDescription
project string
knowledgeBase string
document string
Returns
TypeDescription
stringThe 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
NameDescription
project string
location string
conversationModel string
Returns
TypeDescription
stringThe 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
NameDescription
project string
location string
conversationModel string
evaluation string
Returns
TypeDescription
stringThe 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
NameDescription
project string
location string
knowledgeBase string
document string
Returns
TypeDescription
stringThe 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
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.