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 | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setName
Immutable. The resource name of the analysis.
Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestTime
Output only. The time at which the analysis was requested.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasRequestTime
clearRequestTime
setRequestTime
Output only. The time at which the analysis was requested.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnalysisResult
Output only. The result of the analysis, which is populated when the analysis finishes.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\AnalysisResult|null | |
hasAnalysisResult
clearAnalysisResult
setAnalysisResult
Output only. The result of the analysis, which is populated when the analysis finishes.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\AnalysisResult
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\AnnotatorSelector
|
| Returns | |
|---|---|
| Type | Description |
$this | |