Class RuntimeAnnotation (2.53.0)

public final class RuntimeAnnotation extends GeneratedMessageV3 implements RuntimeAnnotationOrBuilder

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

Protobuf type google.cloud.contactcenterinsights.v1.RuntimeAnnotation

Static Fields

ANNOTATION_ID_FIELD_NUMBER

public static final int ANNOTATION_ID_FIELD_NUMBER
Field Value
Type Description
int

ANSWER_FEEDBACK_FIELD_NUMBER

public static final int ANSWER_FEEDBACK_FIELD_NUMBER
Field Value
Type Description
int

ARTICLE_SUGGESTION_FIELD_NUMBER

public static final int ARTICLE_SUGGESTION_FIELD_NUMBER
Field Value
Type Description
int

CONVERSATION_SUMMARIZATION_SUGGESTION_FIELD_NUMBER

public static final int CONVERSATION_SUMMARIZATION_SUGGESTION_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DIALOGFLOW_INTERACTION_FIELD_NUMBER

public static final int DIALOGFLOW_INTERACTION_FIELD_NUMBER
Field Value
Type Description
int

END_BOUNDARY_FIELD_NUMBER

public static final int END_BOUNDARY_FIELD_NUMBER
Field Value
Type Description
int

FAQ_ANSWER_FIELD_NUMBER

public static final int FAQ_ANSWER_FIELD_NUMBER
Field Value
Type Description
int

SMART_COMPOSE_SUGGESTION_FIELD_NUMBER

public static final int SMART_COMPOSE_SUGGESTION_FIELD_NUMBER
Field Value
Type Description
int

SMART_REPLY_FIELD_NUMBER

public static final int SMART_REPLY_FIELD_NUMBER
Field Value
Type Description
int

START_BOUNDARY_FIELD_NUMBER

public static final int START_BOUNDARY_FIELD_NUMBER
Field Value
Type Description
int

USER_INPUT_FIELD_NUMBER

public static final int USER_INPUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RuntimeAnnotation getDefaultInstance()
Returns
Type Description
RuntimeAnnotation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RuntimeAnnotation.Builder newBuilder()
Returns
Type Description
RuntimeAnnotation.Builder

newBuilder(RuntimeAnnotation prototype)

public static RuntimeAnnotation.Builder newBuilder(RuntimeAnnotation prototype)
Parameter
Name Description
prototype RuntimeAnnotation
Returns
Type Description
RuntimeAnnotation.Builder

parseDelimitedFrom(InputStream input)

public static RuntimeAnnotation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeAnnotation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RuntimeAnnotation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RuntimeAnnotation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RuntimeAnnotation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RuntimeAnnotation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RuntimeAnnotation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeAnnotation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RuntimeAnnotation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeAnnotation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RuntimeAnnotation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RuntimeAnnotation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RuntimeAnnotation> parser()
Returns
Type Description
Parser<RuntimeAnnotation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotationId()

public String getAnnotationId()

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

string annotation_id = 1;

Returns
Type Description
String

The annotationId.

getAnnotationIdBytes()

public ByteString getAnnotationIdBytes()

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

string annotation_id = 1;

Returns
Type Description
ByteString

The bytes for annotationId.

getAnswerFeedback()

public AnswerFeedback getAnswerFeedback()

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

.google.cloud.contactcenterinsights.v1.AnswerFeedback answer_feedback = 5;

Returns
Type Description
AnswerFeedback

The answerFeedback.

getAnswerFeedbackOrBuilder()

public AnswerFeedbackOrBuilder getAnswerFeedbackOrBuilder()

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

.google.cloud.contactcenterinsights.v1.AnswerFeedback answer_feedback = 5;

Returns
Type Description
AnswerFeedbackOrBuilder

getArticleSuggestion()

public ArticleSuggestionData getArticleSuggestion()

Agent Assist Article Suggestion data.

.google.cloud.contactcenterinsights.v1.ArticleSuggestionData article_suggestion = 6;

Returns
Type Description
ArticleSuggestionData

The articleSuggestion.

getArticleSuggestionOrBuilder()

public ArticleSuggestionDataOrBuilder getArticleSuggestionOrBuilder()

Agent Assist Article Suggestion data.

.google.cloud.contactcenterinsights.v1.ArticleSuggestionData article_suggestion = 6;

Returns
Type Description
ArticleSuggestionDataOrBuilder

getConversationSummarizationSuggestion()

public ConversationSummarizationSuggestionData getConversationSummarizationSuggestion()

Conversation summarization suggestion data.

.google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData conversation_summarization_suggestion = 12;

Returns
Type Description
ConversationSummarizationSuggestionData

The conversationSummarizationSuggestion.

getConversationSummarizationSuggestionOrBuilder()

public ConversationSummarizationSuggestionDataOrBuilder getConversationSummarizationSuggestionOrBuilder()

Conversation summarization suggestion data.

.google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData conversation_summarization_suggestion = 12;

Returns
Type Description
ConversationSummarizationSuggestionDataOrBuilder

getCreateTime()

public Timestamp getCreateTime()

The time at which this annotation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time at which this annotation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDataCase()

public RuntimeAnnotation.DataCase getDataCase()
Returns
Type Description
RuntimeAnnotation.DataCase

getDefaultInstanceForType()

public RuntimeAnnotation getDefaultInstanceForType()
Returns
Type Description
RuntimeAnnotation

getDialogflowInteraction()

public DialogflowInteractionData getDialogflowInteraction()

Dialogflow interaction data.

.google.cloud.contactcenterinsights.v1.DialogflowInteractionData dialogflow_interaction = 10;

Returns
Type Description
DialogflowInteractionData

The dialogflowInteraction.

getDialogflowInteractionOrBuilder()

public DialogflowInteractionDataOrBuilder getDialogflowInteractionOrBuilder()

Dialogflow interaction data.

.google.cloud.contactcenterinsights.v1.DialogflowInteractionData dialogflow_interaction = 10;

Returns
Type Description
DialogflowInteractionDataOrBuilder

getEndBoundary()

public AnnotationBoundary getEndBoundary()

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

.google.cloud.contactcenterinsights.v1.AnnotationBoundary end_boundary = 4;

Returns
Type Description
AnnotationBoundary

The endBoundary.

getEndBoundaryOrBuilder()

public AnnotationBoundaryOrBuilder getEndBoundaryOrBuilder()

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

.google.cloud.contactcenterinsights.v1.AnnotationBoundary end_boundary = 4;

Returns
Type Description
AnnotationBoundaryOrBuilder

getFaqAnswer()

public FaqAnswerData getFaqAnswer()

Agent Assist FAQ answer data.

.google.cloud.contactcenterinsights.v1.FaqAnswerData faq_answer = 7;

Returns
Type Description
FaqAnswerData

The faqAnswer.

getFaqAnswerOrBuilder()

public FaqAnswerDataOrBuilder getFaqAnswerOrBuilder()

Agent Assist FAQ answer data.

.google.cloud.contactcenterinsights.v1.FaqAnswerData faq_answer = 7;

Returns
Type Description
FaqAnswerDataOrBuilder

getParserForType()

public Parser<RuntimeAnnotation> getParserForType()
Returns
Type Description
Parser<RuntimeAnnotation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSmartComposeSuggestion()

public SmartComposeSuggestionData getSmartComposeSuggestion()

Agent Assist Smart Compose suggestion data.

.google.cloud.contactcenterinsights.v1.SmartComposeSuggestionData smart_compose_suggestion = 9;

Returns
Type Description
SmartComposeSuggestionData

The smartComposeSuggestion.

getSmartComposeSuggestionOrBuilder()

public SmartComposeSuggestionDataOrBuilder getSmartComposeSuggestionOrBuilder()

Agent Assist Smart Compose suggestion data.

.google.cloud.contactcenterinsights.v1.SmartComposeSuggestionData smart_compose_suggestion = 9;

Returns
Type Description
SmartComposeSuggestionDataOrBuilder

getSmartReply()

public SmartReplyData getSmartReply()

Agent Assist Smart Reply data.

.google.cloud.contactcenterinsights.v1.SmartReplyData smart_reply = 8;

Returns
Type Description
SmartReplyData

The smartReply.

getSmartReplyOrBuilder()

public SmartReplyDataOrBuilder getSmartReplyOrBuilder()

Agent Assist Smart Reply data.

.google.cloud.contactcenterinsights.v1.SmartReplyData smart_reply = 8;

Returns
Type Description
SmartReplyDataOrBuilder

getStartBoundary()

public AnnotationBoundary getStartBoundary()

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

.google.cloud.contactcenterinsights.v1.AnnotationBoundary start_boundary = 3;

Returns
Type Description
AnnotationBoundary

The startBoundary.

getStartBoundaryOrBuilder()

public AnnotationBoundaryOrBuilder getStartBoundaryOrBuilder()

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

.google.cloud.contactcenterinsights.v1.AnnotationBoundary start_boundary = 3;

Returns
Type Description
AnnotationBoundaryOrBuilder

getUserInput()

public RuntimeAnnotation.UserInput getUserInput()

Explicit input used for generating the answer

.google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput user_input = 16;

Returns
Type Description
RuntimeAnnotation.UserInput

The userInput.

getUserInputOrBuilder()

public RuntimeAnnotation.UserInputOrBuilder getUserInputOrBuilder()

Explicit input used for generating the answer

.google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput user_input = 16;

Returns
Type Description
RuntimeAnnotation.UserInputOrBuilder

hasAnswerFeedback()

public boolean hasAnswerFeedback()

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

.google.cloud.contactcenterinsights.v1.AnswerFeedback answer_feedback = 5;

Returns
Type Description
boolean

Whether the answerFeedback field is set.

hasArticleSuggestion()

public boolean hasArticleSuggestion()

Agent Assist Article Suggestion data.

.google.cloud.contactcenterinsights.v1.ArticleSuggestionData article_suggestion = 6;

Returns
Type Description
boolean

Whether the articleSuggestion field is set.

hasConversationSummarizationSuggestion()

public boolean hasConversationSummarizationSuggestion()

Conversation summarization suggestion data.

.google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData conversation_summarization_suggestion = 12;

Returns
Type Description
boolean

Whether the conversationSummarizationSuggestion field is set.

hasCreateTime()

public boolean hasCreateTime()

The time at which this annotation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
boolean

Whether the createTime field is set.

hasDialogflowInteraction()

public boolean hasDialogflowInteraction()

Dialogflow interaction data.

.google.cloud.contactcenterinsights.v1.DialogflowInteractionData dialogflow_interaction = 10;

Returns
Type Description
boolean

Whether the dialogflowInteraction field is set.

hasEndBoundary()

public boolean hasEndBoundary()

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

.google.cloud.contactcenterinsights.v1.AnnotationBoundary end_boundary = 4;

Returns
Type Description
boolean

Whether the endBoundary field is set.

hasFaqAnswer()

public boolean hasFaqAnswer()

Agent Assist FAQ answer data.

.google.cloud.contactcenterinsights.v1.FaqAnswerData faq_answer = 7;

Returns
Type Description
boolean

Whether the faqAnswer field is set.

hasSmartComposeSuggestion()

public boolean hasSmartComposeSuggestion()

Agent Assist Smart Compose suggestion data.

.google.cloud.contactcenterinsights.v1.SmartComposeSuggestionData smart_compose_suggestion = 9;

Returns
Type Description
boolean

Whether the smartComposeSuggestion field is set.

hasSmartReply()

public boolean hasSmartReply()

Agent Assist Smart Reply data.

.google.cloud.contactcenterinsights.v1.SmartReplyData smart_reply = 8;

Returns
Type Description
boolean

Whether the smartReply field is set.

hasStartBoundary()

public boolean hasStartBoundary()

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

.google.cloud.contactcenterinsights.v1.AnnotationBoundary start_boundary = 3;

Returns
Type Description
boolean

Whether the startBoundary field is set.

hasUserInput()

public boolean hasUserInput()

Explicit input used for generating the answer

.google.cloud.contactcenterinsights.v1.RuntimeAnnotation.UserInput user_input = 16;

Returns
Type Description
boolean

Whether the userInput field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RuntimeAnnotation.Builder newBuilderForType()
Returns
Type Description
RuntimeAnnotation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RuntimeAnnotation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RuntimeAnnotation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RuntimeAnnotation.Builder toBuilder()
Returns
Type Description
RuntimeAnnotation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException