Class protos.google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig (3.3.0)

Represents a SummarizationConfig.

Package

@google-cloud/contact-center-insights

Constructors

(constructor)(properties)

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

Constructs a new SummarizationConfig.

Parameter
Name Description
properties ISummarizationConfig

Properties to set

Properties

conversationProfile

public conversationProfile?: (string|null);

SummarizationConfig conversationProfile.

modelSource

public modelSource?: ("conversationProfile"|"summarizationModel");

SummarizationConfig modelSource.

summarizationModel

public summarizationModel?: (google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig.SummarizationModel|keyof typeof google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig.SummarizationModel|null);

SummarizationConfig summarizationModel.

Methods

create(properties)

public static create(properties?: google.cloud.contactcenterinsights.v1.AnnotatorSelector.ISummarizationConfig): google.cloud.contactcenterinsights.v1.AnnotatorSelector.SummarizationConfig;

Creates a new SummarizationConfig instance using the specified properties.

Parameter
Name Description
properties ISummarizationConfig

Properties to set

Returns
Type Description
SummarizationConfig

SummarizationConfig instance

decode(reader, length)

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

Decodes a SummarizationConfig 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
SummarizationConfig

SummarizationConfig

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SummarizationConfig

SummarizationConfig

encode(message, writer)

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

Encodes the specified SummarizationConfig message. Does not implicitly messages.

Parameters
Name Description
message ISummarizationConfig

SummarizationConfig 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.AnnotatorSelector.ISummarizationConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISummarizationConfig

SummarizationConfig 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.AnnotatorSelector.SummarizationConfig;

Creates a SummarizationConfig 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
SummarizationConfig

SummarizationConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SummarizationConfig

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 SummarizationConfig to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SummarizationConfig

SummarizationConfig

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 SummarizationConfig 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