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
Namespace
Google \ Cloud \ ContactCenterInsights \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ interruption_data |
InterruptionData
Data specifying an interruption. |
↳ sentiment_data |
SentimentData
Data specifying sentiment. |
↳ silence_data |
SilenceData
Data specifying silence. |
↳ hold_data |
HoldData
Data specifying a hold. |
↳ entity_mention_data |
EntityMentionData
Data specifying an entity mention. |
↳ intent_match_data |
IntentMatchData
Data specifying an intent match. |
↳ phrase_match_data |
PhraseMatchData
Data specifying a phrase match. |
↳ issue_match_data |
IssueMatchData
Data specifying an issue 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 |
AnnotationBoundary
The boundary in the conversation where the annotation starts, inclusive. |
↳ annotation_end_boundary |
AnnotationBoundary
The boundary in the conversation where the annotation ends, inclusive. |
getInterruptionData
Data specifying an interruption.
| Returns | |
|---|---|
| Type | Description |
InterruptionData|null |
|
hasInterruptionData
setInterruptionData
Data specifying an interruption.
| Parameter | |
|---|---|
| Name | Description |
var |
InterruptionData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSentimentData
Data specifying sentiment.
| Returns | |
|---|---|
| Type | Description |
SentimentData|null |
|
hasSentimentData
setSentimentData
Data specifying sentiment.
| Parameter | |
|---|---|
| Name | Description |
var |
SentimentData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSilenceData
Data specifying silence.
| Returns | |
|---|---|
| Type | Description |
SilenceData|null |
|
hasSilenceData
setSilenceData
Data specifying silence.
| Parameter | |
|---|---|
| Name | Description |
var |
SilenceData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHoldData
Data specifying a hold.
| Returns | |
|---|---|
| Type | Description |
HoldData|null |
|
hasHoldData
setHoldData
Data specifying a hold.
| Parameter | |
|---|---|
| Name | Description |
var |
HoldData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEntityMentionData
Data specifying an entity mention.
| Returns | |
|---|---|
| Type | Description |
EntityMentionData|null |
|
hasEntityMentionData
setEntityMentionData
Data specifying an entity mention.
| Parameter | |
|---|---|
| Name | Description |
var |
EntityMentionData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIntentMatchData
Data specifying an intent match.
| Returns | |
|---|---|
| Type | Description |
IntentMatchData|null |
|
hasIntentMatchData
setIntentMatchData
Data specifying an intent match.
| Parameter | |
|---|---|
| Name | Description |
var |
IntentMatchData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPhraseMatchData
Data specifying a phrase match.
| Returns | |
|---|---|
| Type | Description |
PhraseMatchData|null |
|
hasPhraseMatchData
setPhraseMatchData
Data specifying a phrase match.
| Parameter | |
|---|---|
| Name | Description |
var |
PhraseMatchData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIssueMatchData
Data specifying an issue match.
| Returns | |
|---|---|
| Type | Description |
IssueMatchData|null |
|
hasIssueMatchData
setIssueMatchData
Data specifying an issue match.
| Parameter | |
|---|---|
| Name | Description |
var |
IssueMatchData
|
| 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 |
AnnotationBoundary|null |
|
hasAnnotationStartBoundary
clearAnnotationStartBoundary
setAnnotationStartBoundary
The boundary in the conversation where the annotation starts, inclusive.
| Parameter | |
|---|---|
| Name | Description |
var |
AnnotationBoundary
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotationEndBoundary
The boundary in the conversation where the annotation ends, inclusive.
| Returns | |
|---|---|
| Type | Description |
AnnotationBoundary|null |
|
hasAnnotationEndBoundary
clearAnnotationEndBoundary
setAnnotationEndBoundary
The boundary in the conversation where the annotation ends, inclusive.
| Parameter | |
|---|---|
| Name | Description |
var |
AnnotationBoundary
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getData
| Returns | |
|---|---|
| Type | Description |
string |
|