Class protos.google.cloud.contactcenterinsights.v1.RuntimeAnnotation (1.4.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.

Property Value

Type	Description
string

answerFeedback

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

RuntimeAnnotation answerFeedback.

Property Value

Type	Description
(google.cloud.contactcenterinsights.v1.IAnswerFeedback\|null)

articleSuggestion

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

RuntimeAnnotation articleSuggestion.

Property Value

Type	Description
(google.cloud.contactcenterinsights.v1.IArticleSuggestionData\|null)

createTime

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

RuntimeAnnotation createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

data

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

RuntimeAnnotation data.

Property Value

Type	Description
("articleSuggestion"\|"faqAnswer"\|"smartReply"\|"smartComposeSuggestion"\|"dialogflowInteraction")

dialogflowInteraction

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

RuntimeAnnotation dialogflowInteraction.

Property Value

Type	Description
(google.cloud.contactcenterinsights.v1.IDialogflowInteractionData\|null)

endBoundary

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

RuntimeAnnotation endBoundary.

Property Value

Type	Description
(google.cloud.contactcenterinsights.v1.IAnnotationBoundary\|null)

faqAnswer

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

RuntimeAnnotation faqAnswer.

Property Value

Type	Description
(google.cloud.contactcenterinsights.v1.IFaqAnswerData\|null)

smartComposeSuggestion

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

RuntimeAnnotation smartComposeSuggestion.

Property Value

Type	Description
(google.cloud.contactcenterinsights.v1.ISmartComposeSuggestionData\|null)

smartReply

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

RuntimeAnnotation smartReply.

Property Value

Type	Description
(google.cloud.contactcenterinsights.v1.ISmartReplyData\|null)

startBoundary

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

RuntimeAnnotation startBoundary.

Property Value

Type	Description
(google.cloud.contactcenterinsights.v1.IAnnotationBoundary\|null)

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
google.cloud.contactcenterinsights.v1.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	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.contactcenterinsights.v1.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	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.contactcenterinsights.v1.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
google.cloud.contactcenterinsights.v1.RuntimeAnnotation	RuntimeAnnotation

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	`google.cloud.contactcenterinsights.v1.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