Google Cloud Dialogflow V2 Client - Class ConversationProfilesClient (1.8.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ConversationProfilesClient.

Service Description: Service for managing ConversationProfiles.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Dialogflow \ V2 \ Client

Methods

__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 `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.

clearSuggestionFeatureConfig

Clears a suggestion feature from a conversation profile for the given participant role.

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

metadata: ClearSuggestionFeatureConfigOperationMetadata
response: ConversationProfile

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::clearSuggestionFeatureConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ClearSuggestionFeatureConfigRequest` 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
Type	Description
`Google\ApiCore\OperationResponse`

createConversationProfile

Creates a conversation profile in the specified project.

ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::createConversationProfileAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\CreateConversationProfileRequest` 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
Type	Description
`Google\Cloud\Dialogflow\V2\ConversationProfile`

deleteConversationProfile

Deletes the specified conversation profile.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::deleteConversationProfileAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\DeleteConversationProfileRequest` 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.

getConversationProfile

Retrieves the specified conversation profile.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getConversationProfileAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\GetConversationProfileRequest` 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
Type	Description
`Google\Cloud\Dialogflow\V2\ConversationProfile`

listConversationProfiles

Returns the list of all conversation profiles in the specified project.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::listConversationProfilesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ListConversationProfilesRequest` 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
Type	Description
`Google\ApiCore\PagedListResponse`

setSuggestionFeatureConfig

Adds or updates a suggestion feature in a conversation profile.

If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

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

metadata: SetSuggestionFeatureConfigOperationMetadata
response: ConversationProfile

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::setSuggestionFeatureConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\SetSuggestionFeatureConfigRequest` 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
Type	Description
`Google\ApiCore\OperationResponse`

updateConversationProfile

Updates the specified conversation profile.

ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::updateConversationProfileAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\UpdateConversationProfileRequest` 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
Type	Description
`Google\Cloud\Dialogflow\V2\ConversationProfile`

getLocation

Gets information about a location.

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

Parameters
Name	Description
`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
Type	Description
`Google\Cloud\Location\Location`

listLocations

Lists information about the supported locations for this service.

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

Parameters
Name	Description
`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
Type	Description
`Google\ApiCore\PagedListResponse`

clearSuggestionFeatureConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ClearSuggestionFeatureConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createConversationProfileAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\CreateConversationProfileRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteConversationProfileAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\DeleteConversationProfileRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getConversationProfileAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\GetConversationProfileRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listConversationProfilesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ListConversationProfilesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

setSuggestionFeatureConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\SetSuggestionFeatureConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateConversationProfileAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\UpdateConversationProfileRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

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

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted agent resource.

static::cXSecuritySettingsName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`securitySettings`	`string`

Returns
Type	Description
`string`	The formatted cx_security_settings 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::conversationProfileName

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

Parameters
Name	Description
`project`	`string`
`conversationProfile`	`string`

Returns
Type	Description
`string`	The formatted conversation_profile 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::knowledgeBaseName

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

Parameters
Name	Description
`project`	`string`
`knowledgeBase`	`string`

Returns
Type	Description
`string`	The formatted knowledge_base resource.

static::locationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::projectName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

static::projectAgentName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project_agent 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::projectConversationProfileName

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

Parameters
Name	Description
`project`	`string`
`conversationProfile`	`string`

Returns
Type	Description
`string`	The formatted project_conversation_profile resource.

static::projectKnowledgeBaseName

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

Parameters
Name	Description
`project`	`string`
`knowledgeBase`	`string`

Returns
Type	Description
`string`	The formatted project_knowledge_base 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::projectLocationAgentName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted project_location_agent 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::projectLocationConversationProfileName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`conversationProfile`	`string`

Returns
Type	Description
`string`	The formatted project_location_conversation_profile resource.

static::projectLocationKnowledgeBaseName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`knowledgeBase`	`string`

Returns
Type	Description
`string`	The formatted project_location_knowledge_base 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

agent: projects/{project}/agent
cXSecuritySettings: projects/{project}/locations/{location}/securitySettings/{security_settings}
conversationModel: projects/{project}/locations/{location}/conversationModels/{conversation_model}
conversationProfile: projects/{project}/conversationProfiles/{conversation_profile}
document: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
knowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
location: projects/{project}/locations/{location}
project: projects/{project}
projectAgent: projects/{project}/agent
projectConversationModel: projects/{project}/conversationModels/{conversation_model}
projectConversationProfile: projects/{project}/conversationProfiles/{conversation_profile}
projectKnowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
projectKnowledgeBaseDocument: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
projectLocationAgent: projects/{project}/locations/{location}/agent
projectLocationConversationModel: projects/{project}/locations/{location}/conversationModels/{conversation_model}
projectLocationConversationProfile: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
projectLocationKnowledgeBase: projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}
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.