Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class CallAnnotation.
A piece of metadata that applies to a window of a call.
Generated from protobuf message google.cloud.contactcenterinsights.v1.CallAnnotation
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ interruption_data |
Google\Cloud\ContactCenterInsights\V1\InterruptionData
Data specifying an interruption. |
↳ sentiment_data |
Google\Cloud\ContactCenterInsights\V1\SentimentData
Data specifying sentiment. |
↳ silence_data |
Google\Cloud\ContactCenterInsights\V1\SilenceData
Data specifying silence. |
↳ hold_data |
Google\Cloud\ContactCenterInsights\V1\HoldData
Data specifying a hold. |
↳ entity_mention_data |
Google\Cloud\ContactCenterInsights\V1\EntityMentionData
Data specifying an entity mention. |
↳ intent_match_data |
Google\Cloud\ContactCenterInsights\V1\IntentMatchData
Data specifying an intent match. |
↳ phrase_match_data |
Google\Cloud\ContactCenterInsights\V1\PhraseMatchData
Data specifying a phrase match. |
↳ channel_tag |
int
The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. |
↳ annotation_start_boundary |
Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary
The boundary in the conversation where the annotation starts, inclusive. |
↳ annotation_end_boundary |
Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary
The boundary in the conversation where the annotation ends, inclusive. |
getInterruptionData
Data specifying an interruption.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\InterruptionData|null | |
hasInterruptionData
setInterruptionData
Data specifying an interruption.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\InterruptionData
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSentimentData
Data specifying sentiment.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\SentimentData|null | |
hasSentimentData
setSentimentData
Data specifying sentiment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\SentimentData
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSilenceData
Data specifying silence.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\SilenceData|null | |
hasSilenceData
setSilenceData
Data specifying silence.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\SilenceData
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHoldData
Data specifying a hold.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\HoldData|null | |
hasHoldData
setHoldData
Data specifying a hold.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\HoldData
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEntityMentionData
Data specifying an entity mention.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\EntityMentionData|null | |
hasEntityMentionData
setEntityMentionData
Data specifying an entity mention.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\EntityMentionData
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIntentMatchData
Data specifying an intent match.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\IntentMatchData|null | |
hasIntentMatchData
setIntentMatchData
Data specifying an intent match.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\IntentMatchData
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPhraseMatchData
Data specifying a phrase match.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\PhraseMatchData|null | |
hasPhraseMatchData
setPhraseMatchData
Data specifying a phrase match.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\PhraseMatchData
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getChannelTag
The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
| Returns | |
|---|---|
| Type | Description |
int | |
setChannelTag
The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotationStartBoundary
The boundary in the conversation where the annotation starts, inclusive.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary|null | |
hasAnnotationStartBoundary
clearAnnotationStartBoundary
setAnnotationStartBoundary
The boundary in the conversation where the annotation starts, inclusive.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotationEndBoundary
The boundary in the conversation where the annotation ends, inclusive.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary|null | |
hasAnnotationEndBoundary
clearAnnotationEndBoundary
setAnnotationEndBoundary
The boundary in the conversation where the annotation ends, inclusive.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getData
| Returns | |
|---|---|
| Type | Description |
string | |