Google Cloud Contact Center Insights V1 Client - Class Analysis (1.3.0)

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

The analysis resource.

Generated from protobuf message google.cloud.contactcenterinsights.v1.Analysis

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

↳ request_time Google\Protobuf\Timestamp

Output only. The time at which the analysis was requested.

↳ create_time Google\Protobuf\Timestamp

Output only. The time at which the analysis was created, which occurs when the long-running operation completes.

↳ analysis_result Google\Cloud\ContactCenterInsights\V1\AnalysisResult

Output only. The result of the analysis, which is populated when the analysis finishes.

↳ annotator_selector Google\Cloud\ContactCenterInsights\V1\AnnotatorSelector

To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.

getName

Immutable. The resource name of the analysis.

Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

Returns
TypeDescription
string

setName

Immutable. The resource name of the analysis.

Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRequestTime

Output only. The time at which the analysis was requested.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasRequestTime

clearRequestTime

setRequestTime

Output only. The time at which the analysis was requested.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getCreateTime

Output only. The time at which the analysis was created, which occurs when the long-running operation completes.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the analysis was created, which occurs when the long-running operation completes.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getAnalysisResult

Output only. The result of the analysis, which is populated when the analysis finishes.

Returns
TypeDescription
Google\Cloud\ContactCenterInsights\V1\AnalysisResult|null

hasAnalysisResult

clearAnalysisResult

setAnalysisResult

Output only. The result of the analysis, which is populated when the analysis finishes.

Parameter
NameDescription
var Google\Cloud\ContactCenterInsights\V1\AnalysisResult
Returns
TypeDescription
$this

getAnnotatorSelector

To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.

Returns
TypeDescription
Google\Cloud\ContactCenterInsights\V1\AnnotatorSelector|null

hasAnnotatorSelector

clearAnnotatorSelector

setAnnotatorSelector

To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.

Parameter
NameDescription
var Google\Cloud\ContactCenterInsights\V1\AnnotatorSelector
Returns
TypeDescription
$this