Google Cloud Contact Center Insights V1 Client - Class ContactCenterInsightsClient (1.5.0)

Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class ContactCenterInsightsClient.

Service Description: An API that lets users analyze and explore their business conversation data.

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

Namespace

Google \ Cloud \ ContactCenterInsights \ V1 \ 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.

bulkAnalyzeConversations

Analyzes multiple conversations in a single request.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::bulkAnalyzeConversationsAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\BulkAnalyzeConversationsRequest

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

calculateIssueModelStats

Gets an issue model's statistics.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::calculateIssueModelStatsAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CalculateIssueModelStatsRequest

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\ContactCenterInsights\V1\CalculateIssueModelStatsResponse

calculateStats

Gets conversation statistics.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::calculateStatsAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CalculateStatsRequest

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\ContactCenterInsights\V1\CalculateStatsResponse

createAnalysis

Creates an analysis. The long running operation is done when the analysis has completed.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::createAnalysisAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreateAnalysisRequest

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

createConversation

Creates a conversation.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::createConversationAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreateConversationRequest

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\ContactCenterInsights\V1\Conversation

createIssueModel

Creates an issue model.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::createIssueModelAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreateIssueModelRequest

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

createPhraseMatcher

Creates a phrase matcher.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::createPhraseMatcherAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreatePhraseMatcherRequest

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\ContactCenterInsights\V1\PhraseMatcher

createView

Creates a view.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::createViewAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreateViewRequest

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\ContactCenterInsights\V1\View

deleteAnalysis

Deletes an analysis.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::deleteAnalysisAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteAnalysisRequest

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.

deleteConversation

Deletes a conversation.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::deleteConversationAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteConversationRequest

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.

deleteIssue

Deletes an issue.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::deleteIssueAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteIssueRequest

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.

deleteIssueModel

Deletes an issue model.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::deleteIssueModelAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteIssueModelRequest

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

deletePhraseMatcher

Deletes a phrase matcher.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::deletePhraseMatcherAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeletePhraseMatcherRequest

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.

deleteView

Deletes a view.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::deleteViewAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteViewRequest

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.

deployIssueModel

Deploys an issue model. Returns an error if a model is already deployed.

An issue model can only be used in analysis after it has been deployed.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::deployIssueModelAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeployIssueModelRequest

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

exportInsightsData

Export insights data to a destination defined in the request body.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::exportInsightsDataAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ExportInsightsDataRequest

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

getAnalysis

Gets an analysis.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::getAnalysisAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetAnalysisRequest

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\ContactCenterInsights\V1\Analysis

getConversation

Gets a conversation.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::getConversationAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetConversationRequest

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\ContactCenterInsights\V1\Conversation

getIssue

Gets an issue.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::getIssueAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetIssueRequest

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\ContactCenterInsights\V1\Issue

getIssueModel

Gets an issue model.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::getIssueModelAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetIssueModelRequest

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\ContactCenterInsights\V1\IssueModel

getPhraseMatcher

Gets a phrase matcher.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::getPhraseMatcherAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetPhraseMatcherRequest

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\ContactCenterInsights\V1\PhraseMatcher

getSettings

Gets project-level settings.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::getSettingsAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetSettingsRequest

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\ContactCenterInsights\V1\Settings

getView

Gets a view.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::getViewAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetViewRequest

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\ContactCenterInsights\V1\View

ingestConversations

Imports conversations and processes them according to the user's configuration.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::ingestConversationsAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\IngestConversationsRequest

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

listAnalyses

Lists analyses.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::listAnalysesAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListAnalysesRequest

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

listConversations

Lists conversations.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::listConversationsAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListConversationsRequest

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

listIssueModels

Lists issue models.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::listIssueModelsAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListIssueModelsRequest

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\ContactCenterInsights\V1\ListIssueModelsResponse

listIssues

Lists issues.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::listIssuesAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListIssuesRequest

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\ContactCenterInsights\V1\ListIssuesResponse

listPhraseMatchers

Lists phrase matchers.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::listPhraseMatchersAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListPhraseMatchersRequest

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

listViews

Lists views.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::listViewsAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListViewsRequest

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

undeployIssueModel

Undeploys an issue model.

An issue model can not be used in analysis after it has been undeployed.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::undeployIssueModelAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UndeployIssueModelRequest

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

updateConversation

Updates a conversation.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::updateConversationAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateConversationRequest

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\ContactCenterInsights\V1\Conversation

updateIssue

Updates an issue.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::updateIssueAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateIssueRequest

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\ContactCenterInsights\V1\Issue

updateIssueModel

Updates an issue model.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::updateIssueModelAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateIssueModelRequest

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\ContactCenterInsights\V1\IssueModel

updatePhraseMatcher

Updates a phrase matcher.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::updatePhraseMatcherAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdatePhraseMatcherRequest

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\ContactCenterInsights\V1\PhraseMatcher

updateSettings

Updates project-level settings.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::updateSettingsAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateSettingsRequest

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\ContactCenterInsights\V1\Settings

updateView

Updates a view.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::updateViewAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateViewRequest

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\ContactCenterInsights\V1\View

uploadConversation

Create a longrunning conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction.

The async variant is Google\Cloud\ContactCenterInsights\V1\Client\BaseClient\self::uploadConversationAsync() .

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UploadConversationRequest

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

bulkAnalyzeConversationsAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\BulkAnalyzeConversationsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

calculateIssueModelStatsAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CalculateIssueModelStatsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

calculateStatsAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CalculateStatsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createAnalysisAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreateAnalysisRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createConversationAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreateConversationRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createIssueModelAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreateIssueModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createPhraseMatcherAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreatePhraseMatcherRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createViewAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\CreateViewRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteAnalysisAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteAnalysisRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteConversationAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteConversationRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteIssueAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteIssueRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteIssueModelAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteIssueModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deletePhraseMatcherAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeletePhraseMatcherRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteViewAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeleteViewRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deployIssueModelAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\DeployIssueModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

exportInsightsDataAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ExportInsightsDataRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getAnalysisAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetAnalysisRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getConversationAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetConversationRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getIssueAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetIssueRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getIssueModelAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetIssueModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getPhraseMatcherAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetPhraseMatcherRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getSettingsAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetSettingsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getViewAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\GetViewRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

ingestConversationsAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\IngestConversationsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listAnalysesAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListAnalysesRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listConversationsAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListConversationsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listIssueModelsAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListIssueModelsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listIssuesAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListIssuesRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listPhraseMatchersAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListPhraseMatchersRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listViewsAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\ListViewsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

undeployIssueModelAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UndeployIssueModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateConversationAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateConversationRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateIssueAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateIssueRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateIssueModelAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateIssueModelRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updatePhraseMatcherAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdatePhraseMatcherRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateSettingsAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateSettingsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateViewAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UpdateViewRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

uploadConversationAsync

Parameters
NameDescription
request Google\Cloud\ContactCenterInsights\V1\UploadConversationRequest
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::analysisName

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

Parameters
NameDescription
project string
location string
conversation string
analysis string
Returns
TypeDescription
stringThe formatted analysis resource.

static::conversationName

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

Parameters
NameDescription
project string
location string
conversation string
Returns
TypeDescription
stringThe formatted conversation resource.

static::conversationProfileName

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

Parameters
NameDescription
project string
location string
conversationProfile string
Returns
TypeDescription
stringThe formatted conversation_profile resource.

static::issueName

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

Parameters
NameDescription
project string
location string
issueModel string
issue string
Returns
TypeDescription
stringThe formatted issue resource.

static::issueModelName

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

Parameters
NameDescription
project string
location string
issueModel string
Returns
TypeDescription
stringThe formatted issue_model resource.

static::locationName

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

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

static::participantName

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

Parameters
NameDescription
project string
conversation string
participant string
Returns
TypeDescription
stringThe formatted participant resource.

static::phraseMatcherName

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

Parameters
NameDescription
project string
location string
phraseMatcher string
Returns
TypeDescription
stringThe formatted phrase_matcher resource.

static::projectConversationParticipantName

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

Parameters
NameDescription
project string
conversation string
participant string
Returns
TypeDescription
stringThe formatted project_conversation_participant resource.

static::projectLocationConversationParticipantName

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

Parameters
NameDescription
project string
location string
conversation string
participant string
Returns
TypeDescription
stringThe formatted project_location_conversation_participant resource.

static::settingsName

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

Parameters
NameDescription
project string
location string
Returns
TypeDescription
stringThe formatted settings resource.

static::viewName

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

Parameters
NameDescription
project string
location string
view string
Returns
TypeDescription
stringThe formatted view 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

  • analysis: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
  • conversation: projects/{project}/locations/{location}/conversations/{conversation}
  • conversationProfile: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
  • issue: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}
  • issueModel: projects/{project}/locations/{location}/issueModels/{issue_model}
  • location: projects/{project}/locations/{location}
  • participant: projects/{project}/conversations/{conversation}/participants/{participant}
  • phraseMatcher: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
  • projectConversationParticipant: projects/{project}/conversations/{conversation}/participants/{participant}
  • projectLocationConversationParticipant: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
  • settings: projects/{project}/locations/{location}/settings
  • view: projects/{project}/locations/{location}/views/{view}

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.