Class protos.google.cloud.contactcenterinsights.v1.RuntimeAnnotation (3.7.0)

Represents a RuntimeAnnotation.

Package

@google-cloud/contact-center-insights

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.contactcenterinsights.v1.IRuntimeAnnotation);

Constructs a new RuntimeAnnotation.

Parameter
Name Description
properties IRuntimeAnnotation

Properties to set

Properties

annotationId

public annotationId: string;

RuntimeAnnotation annotationId.

answerFeedback

public answerFeedback?: (google.cloud.contactcenterinsights.v1.IAnswerFeedback|null);

RuntimeAnnotation answerFeedback.

articleSuggestion

public articleSuggestion?: (google.cloud.contactcenterinsights.v1.IArticleSuggestionData|null);

RuntimeAnnotation articleSuggestion.

conversationSummarizationSuggestion

public conversationSummarizationSuggestion?: (google.cloud.contactcenterinsights.v1.IConversationSummarizationSuggestionData|null);

RuntimeAnnotation conversationSummarizationSuggestion.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

RuntimeAnnotation createTime.

data

public data?: ("articleSuggestion"|"faqAnswer"|"smartReply"|"smartComposeSuggestion"|"dialogflowInteraction"|"conversationSummarizationSuggestion");

RuntimeAnnotation data.

dialogflowInteraction

public dialogflowInteraction?: (google.cloud.contactcenterinsights.v1.IDialogflowInteractionData|null);

RuntimeAnnotation dialogflowInteraction.

endBoundary

public endBoundary?: (google.cloud.contactcenterinsights.v1.IAnnotationBoundary|null);

RuntimeAnnotation endBoundary.

faqAnswer

public faqAnswer?: (google.cloud.contactcenterinsights.v1.IFaqAnswerData|null);

RuntimeAnnotation faqAnswer.

smartComposeSuggestion

public smartComposeSuggestion?: (google.cloud.contactcenterinsights.v1.ISmartComposeSuggestionData|null);

RuntimeAnnotation smartComposeSuggestion.

smartReply

public smartReply?: (google.cloud.contactcenterinsights.v1.ISmartReplyData|null);

RuntimeAnnotation smartReply.

startBoundary

public startBoundary?: (google.cloud.contactcenterinsights.v1.IAnnotationBoundary|null);

RuntimeAnnotation startBoundary.

userInput

public userInput?: (google.cloud.contactcenterinsights.v1.RuntimeAnnotation.IUserInput|null);

RuntimeAnnotation userInput.

Methods

create(properties)

public static create(properties?: google.cloud.contactcenterinsights.v1.IRuntimeAnnotation): google.cloud.contactcenterinsights.v1.RuntimeAnnotation;

Creates a new RuntimeAnnotation instance using the specified properties.

Parameter
Name Description
properties IRuntimeAnnotation

Properties to set
Returns
Type Description
RuntimeAnnotation

RuntimeAnnotation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contactcenterinsights.v1.RuntimeAnnotation;

Decodes a RuntimeAnnotation message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
RuntimeAnnotation

RuntimeAnnotation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contactcenterinsights.v1.RuntimeAnnotation;

Decodes a RuntimeAnnotation message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
RuntimeAnnotation

RuntimeAnnotation

encode(message, writer)

public static encode(message: google.cloud.contactcenterinsights.v1.IRuntimeAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RuntimeAnnotation message. Does not implicitly messages.

Parameters
Name Description
message IRuntimeAnnotation

RuntimeAnnotation message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.contactcenterinsights.v1.IRuntimeAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RuntimeAnnotation message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IRuntimeAnnotation

RuntimeAnnotation message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.contactcenterinsights.v1.RuntimeAnnotation;

Creates a RuntimeAnnotation message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object
Returns
Type Description
RuntimeAnnotation

RuntimeAnnotation

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for RuntimeAnnotation

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this RuntimeAnnotation to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.contactcenterinsights.v1.RuntimeAnnotation, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a RuntimeAnnotation message. Also converts values to other types if specified.

Parameters
Name Description
message RuntimeAnnotation

RuntimeAnnotation
options $protobuf.IConversionOptions

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a RuntimeAnnotation message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not