Class protos.google.cloud.aiplatform.v1.RougeSpec (5.14.0)

Represents a RougeSpec.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.IRougeSpec);

Constructs a new RougeSpec.

Parameter
Name Description
properties IRougeSpec

Properties to set

Properties

rougeType

public rougeType: string;

RougeSpec rougeType.

splitSummaries

public splitSummaries: boolean;

RougeSpec splitSummaries.

useStemmer

public useStemmer: boolean;

RougeSpec useStemmer.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IRougeSpec): google.cloud.aiplatform.v1.RougeSpec;

Creates a new RougeSpec instance using the specified properties.

Parameter
Name Description
properties IRougeSpec

Properties to set

Returns
Type Description
RougeSpec

RougeSpec instance

decode(reader, length)

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

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

RougeSpec

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
RougeSpec

RougeSpec

encode(message, writer)

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

Encodes the specified RougeSpec message. Does not implicitly messages.

Parameters
Name Description
message IRougeSpec

RougeSpec 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.aiplatform.v1.IRougeSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IRougeSpec

RougeSpec 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.aiplatform.v1.RougeSpec;

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

RougeSpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RougeSpec

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message RougeSpec

RougeSpec

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