Class RougeSpec.Builder (3.56.0)

public static final class RougeSpec.Builder extends GeneratedMessageV3.Builder<RougeSpec.Builder> implements RougeSpecOrBuilder

Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1.

Protobuf type google.cloud.aiplatform.v1.RougeSpec

Implements

RougeSpecOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RougeSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RougeSpec.Builder
Overrides

build()

public RougeSpec build()
Returns
Type Description
RougeSpec

buildPartial()

public RougeSpec buildPartial()
Returns
Type Description
RougeSpec

clear()

public RougeSpec.Builder clear()
Returns
Type Description
RougeSpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RougeSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RougeSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RougeSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RougeSpec.Builder
Overrides

clearRougeType()

public RougeSpec.Builder clearRougeType()

Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.

string rouge_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RougeSpec.Builder

This builder for chaining.

clearSplitSummaries()

public RougeSpec.Builder clearSplitSummaries()

Optional. Whether to split summaries while using rougeLsum.

bool split_summaries = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RougeSpec.Builder

This builder for chaining.

clearUseStemmer()

public RougeSpec.Builder clearUseStemmer()

Optional. Whether to use stemmer to compute rouge score.

bool use_stemmer = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RougeSpec.Builder

This builder for chaining.

clone()

public RougeSpec.Builder clone()
Returns
Type Description
RougeSpec.Builder
Overrides

getDefaultInstanceForType()

public RougeSpec getDefaultInstanceForType()
Returns
Type Description
RougeSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getRougeType()

public String getRougeType()

Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.

string rouge_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The rougeType.

getRougeTypeBytes()

public ByteString getRougeTypeBytes()

Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.

string rouge_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for rougeType.

getSplitSummaries()

public boolean getSplitSummaries()

Optional. Whether to split summaries while using rougeLsum.

bool split_summaries = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The splitSummaries.

getUseStemmer()

public boolean getUseStemmer()

Optional. Whether to use stemmer to compute rouge score.

bool use_stemmer = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The useStemmer.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RougeSpec other)

public RougeSpec.Builder mergeFrom(RougeSpec other)
Parameter
Name Description
other RougeSpec
Returns
Type Description
RougeSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RougeSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RougeSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RougeSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RougeSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RougeSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RougeSpec.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RougeSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RougeSpec.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RougeSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RougeSpec.Builder
Overrides

setRougeType(String value)

public RougeSpec.Builder setRougeType(String value)

Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.

string rouge_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The rougeType to set.

Returns
Type Description
RougeSpec.Builder

This builder for chaining.

setRougeTypeBytes(ByteString value)

public RougeSpec.Builder setRougeTypeBytes(ByteString value)

Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.

string rouge_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for rougeType to set.

Returns
Type Description
RougeSpec.Builder

This builder for chaining.

setSplitSummaries(boolean value)

public RougeSpec.Builder setSplitSummaries(boolean value)

Optional. Whether to split summaries while using rougeLsum.

bool split_summaries = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The splitSummaries to set.

Returns
Type Description
RougeSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RougeSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RougeSpec.Builder
Overrides

setUseStemmer(boolean value)

public RougeSpec.Builder setUseStemmer(boolean value)

Optional. Whether to use stemmer to compute rouge score.

bool use_stemmer = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The useStemmer to set.

Returns
Type Description
RougeSpec.Builder

This builder for chaining.