Google Cloud Contact Center Insights V1 Client - Class RuntimeAnnotation (2.1.1)

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

An annotation that was generated during the customer and agent interaction.

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

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ article_suggestion`	`Google\Cloud\ContactCenterInsights\V1\ArticleSuggestionData` Agent Assist Article Suggestion data.
`↳ faq_answer`	`Google\Cloud\ContactCenterInsights\V1\FaqAnswerData` Agent Assist FAQ answer data.
`↳ smart_reply`	`Google\Cloud\ContactCenterInsights\V1\SmartReplyData` Agent Assist Smart Reply data.
`↳ smart_compose_suggestion`	`Google\Cloud\ContactCenterInsights\V1\SmartComposeSuggestionData` Agent Assist Smart Compose suggestion data.
`↳ dialogflow_interaction`	`Google\Cloud\ContactCenterInsights\V1\DialogflowInteractionData` Dialogflow interaction data.
`↳ conversation_summarization_suggestion`	`Google\Cloud\ContactCenterInsights\V1\ConversationSummarizationSuggestionData` Conversation summarization suggestion data.
`↳ annotation_id`	`string` The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
`↳ create_time`	`Google\Protobuf\Timestamp` The time at which this annotation was created.
`↳ start_boundary`	`Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary` The boundary in the conversation where the annotation starts, inclusive.
`↳ end_boundary`	`Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary` The boundary in the conversation where the annotation ends, inclusive.
`↳ answer_feedback`	`Google\Cloud\ContactCenterInsights\V1\AnswerFeedback` The feedback that the customer has about the answer in `data`.
`↳ user_input`	`Google\Cloud\ContactCenterInsights\V1\RuntimeAnnotation\UserInput` Explicit input used for generating the answer

getArticleSuggestion

Agent Assist Article Suggestion data.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\ArticleSuggestionData\|null`

hasArticleSuggestion

setArticleSuggestion

Agent Assist Article Suggestion data.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\ArticleSuggestionData`

Returns
Type	Description
`$this`

getFaqAnswer

Agent Assist FAQ answer data.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\FaqAnswerData\|null`

hasFaqAnswer

setFaqAnswer

Agent Assist FAQ answer data.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\FaqAnswerData`

Returns
Type	Description
`$this`

getSmartReply

Agent Assist Smart Reply data.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\SmartReplyData\|null`

hasSmartReply

setSmartReply

Agent Assist Smart Reply data.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\SmartReplyData`

Returns
Type	Description
`$this`

getSmartComposeSuggestion

Agent Assist Smart Compose suggestion data.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\SmartComposeSuggestionData\|null`

hasSmartComposeSuggestion

setSmartComposeSuggestion

Agent Assist Smart Compose suggestion data.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\SmartComposeSuggestionData`

Returns
Type	Description
`$this`

getDialogflowInteraction

Dialogflow interaction data.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\DialogflowInteractionData\|null`

hasDialogflowInteraction

setDialogflowInteraction

Dialogflow interaction data.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\DialogflowInteractionData`

Returns
Type	Description
`$this`

getConversationSummarizationSuggestion

Conversation summarization suggestion data.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\ConversationSummarizationSuggestionData\|null`

hasConversationSummarizationSuggestion

setConversationSummarizationSuggestion

Conversation summarization suggestion data.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\ConversationSummarizationSuggestionData`

Returns
Type	Description
`$this`

getAnnotationId

The unique identifier of the annotation.

Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}

Returns
Type	Description
`string`

setAnnotationId

The unique identifier of the annotation.

Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

The time at which this annotation was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

The time at which this annotation was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getStartBoundary

The boundary in the conversation where the annotation starts, inclusive.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary\|null`

hasStartBoundary

clearStartBoundary

setStartBoundary

The boundary in the conversation where the annotation starts, inclusive.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary`

Returns
Type	Description
`$this`

getEndBoundary

The boundary in the conversation where the annotation ends, inclusive.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary\|null`

hasEndBoundary

clearEndBoundary

setEndBoundary

The boundary in the conversation where the annotation ends, inclusive.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\AnnotationBoundary`

Returns
Type	Description
`$this`

getAnswerFeedback

The feedback that the customer has about the answer in data.

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\AnswerFeedback\|null`

hasAnswerFeedback

clearAnswerFeedback

setAnswerFeedback

The feedback that the customer has about the answer in data.

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\AnswerFeedback`

Returns
Type	Description
`$this`

getUserInput

Explicit input used for generating the answer

Returns
Type	Description
`Google\Cloud\ContactCenterInsights\V1\RuntimeAnnotation\UserInput\|null`

hasUserInput

clearUserInput

setUserInput

Explicit input used for generating the answer

Parameter
Name	Description
`var`	`Google\Cloud\ContactCenterInsights\V1\RuntimeAnnotation\UserInput`

Returns
Type	Description
`$this`

getData

Returns
Type	Description
`string`