Contact Center AI Insights V1 API - Class Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation (v1.5.0)

Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#annotation_id

def annotation_id() -> ::String

Returns

(::String) — The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}

#annotation_id=

def annotation_id=(value) -> ::String

Parameter

value (::String) — The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}

Returns

(::String) — The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}

#answer_feedback

def answer_feedback() -> ::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback

Returns

(::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback) — The feedback that the customer has about the answer in data.

#answer_feedback=

def answer_feedback=(value) -> ::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback) — The feedback that the customer has about the answer in data.

Returns

(::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback) — The feedback that the customer has about the answer in data.

#article_suggestion

def article_suggestion() -> ::Google::Cloud::ContactCenterInsights::V1::ArticleSuggestionData

Returns

(::Google::Cloud::ContactCenterInsights::V1::ArticleSuggestionData) — Agent Assist Article Suggestion data.

Note: The following fields are mutually exclusive: article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#article_suggestion=

def article_suggestion=(value) -> ::Google::Cloud::ContactCenterInsights::V1::ArticleSuggestionData

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::ArticleSuggestionData) — Agent Assist Article Suggestion data.

Note: The following fields are mutually exclusive: article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::ContactCenterInsights::V1::ArticleSuggestionData) — Agent Assist Article Suggestion data.

Note: The following fields are mutually exclusive: article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#conversation_summarization_suggestion

def conversation_summarization_suggestion() -> ::Google::Cloud::ContactCenterInsights::V1::ConversationSummarizationSuggestionData

Returns

(::Google::Cloud::ContactCenterInsights::V1::ConversationSummarizationSuggestionData) — Conversation summarization suggestion data.

Note: The following fields are mutually exclusive: conversation_summarization_suggestion, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

#conversation_summarization_suggestion=

def conversation_summarization_suggestion=(value) -> ::Google::Cloud::ContactCenterInsights::V1::ConversationSummarizationSuggestionData

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::ConversationSummarizationSuggestionData) — Conversation summarization suggestion data.

Note: The following fields are mutually exclusive: conversation_summarization_suggestion, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::ContactCenterInsights::V1::ConversationSummarizationSuggestionData) — Conversation summarization suggestion data.

Note: The following fields are mutually exclusive: conversation_summarization_suggestion, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — The time at which this annotation was created.

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — The time at which this annotation was created.

Returns

(::Google::Protobuf::Timestamp) — The time at which this annotation was created.

#dialogflow_interaction

def dialogflow_interaction() -> ::Google::Cloud::ContactCenterInsights::V1::DialogflowInteractionData

Returns

(::Google::Cloud::ContactCenterInsights::V1::DialogflowInteractionData) — Dialogflow interaction data.

Note: The following fields are mutually exclusive: dialogflow_interaction, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#dialogflow_interaction=

def dialogflow_interaction=(value) -> ::Google::Cloud::ContactCenterInsights::V1::DialogflowInteractionData

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::DialogflowInteractionData) — Dialogflow interaction data.

Note: The following fields are mutually exclusive: dialogflow_interaction, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::ContactCenterInsights::V1::DialogflowInteractionData) — Dialogflow interaction data.

Note: The following fields are mutually exclusive: dialogflow_interaction, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#end_boundary

def end_boundary() -> ::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary

Returns

(::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary) — The boundary in the conversation where the annotation ends, inclusive.

#end_boundary=

def end_boundary=(value) -> ::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary) — The boundary in the conversation where the annotation ends, inclusive.

Returns

(::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary) — The boundary in the conversation where the annotation ends, inclusive.

#faq_answer

def faq_answer() -> ::Google::Cloud::ContactCenterInsights::V1::FaqAnswerData

Returns

(::Google::Cloud::ContactCenterInsights::V1::FaqAnswerData) — Agent Assist FAQ answer data.

Note: The following fields are mutually exclusive: faq_answer, article_suggestion, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#faq_answer=

def faq_answer=(value) -> ::Google::Cloud::ContactCenterInsights::V1::FaqAnswerData

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::FaqAnswerData) — Agent Assist FAQ answer data.

Note: The following fields are mutually exclusive: faq_answer, article_suggestion, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::ContactCenterInsights::V1::FaqAnswerData) — Agent Assist FAQ answer data.

Note: The following fields are mutually exclusive: faq_answer, article_suggestion, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#smart_compose_suggestion

def smart_compose_suggestion() -> ::Google::Cloud::ContactCenterInsights::V1::SmartComposeSuggestionData

Returns

(::Google::Cloud::ContactCenterInsights::V1::SmartComposeSuggestionData) — Agent Assist Smart Compose suggestion data.

Note: The following fields are mutually exclusive: smart_compose_suggestion, article_suggestion, faq_answer, smart_reply, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#smart_compose_suggestion=

def smart_compose_suggestion=(value) -> ::Google::Cloud::ContactCenterInsights::V1::SmartComposeSuggestionData

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::SmartComposeSuggestionData) — Agent Assist Smart Compose suggestion data.

Note: The following fields are mutually exclusive: smart_compose_suggestion, article_suggestion, faq_answer, smart_reply, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::ContactCenterInsights::V1::SmartComposeSuggestionData) — Agent Assist Smart Compose suggestion data.

Note: The following fields are mutually exclusive: smart_compose_suggestion, article_suggestion, faq_answer, smart_reply, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#smart_reply

def smart_reply() -> ::Google::Cloud::ContactCenterInsights::V1::SmartReplyData

Returns

(::Google::Cloud::ContactCenterInsights::V1::SmartReplyData) — Agent Assist Smart Reply data.

Note: The following fields are mutually exclusive: smart_reply, article_suggestion, faq_answer, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#smart_reply=

def smart_reply=(value) -> ::Google::Cloud::ContactCenterInsights::V1::SmartReplyData

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::SmartReplyData) — Agent Assist Smart Reply data.

Note: The following fields are mutually exclusive: smart_reply, article_suggestion, faq_answer, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::ContactCenterInsights::V1::SmartReplyData) — Agent Assist Smart Reply data.

Note: The following fields are mutually exclusive: smart_reply, article_suggestion, faq_answer, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#start_boundary

def start_boundary() -> ::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary

Returns

(::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary) — The boundary in the conversation where the annotation starts, inclusive.

#start_boundary=

def start_boundary=(value) -> ::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary) — The boundary in the conversation where the annotation starts, inclusive.

Returns

(::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary) — The boundary in the conversation where the annotation starts, inclusive.

#user_input

def user_input() -> ::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput

Returns

(::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput) — Explicit input used for generating the answer

#user_input=

def user_input=(value) -> ::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput

Parameter

value (::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput) — Explicit input used for generating the answer

Returns

(::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput) — Explicit input used for generating the answer