Class RougeSpec (3.47.0)

public final class RougeSpec extends GeneratedMessageV3 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.v1beta1.RougeSpec

Implements

RougeSpecOrBuilder

Static Fields

ROUGE_TYPE_FIELD_NUMBER

public static final int ROUGE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SPLIT_SUMMARIES_FIELD_NUMBER

public static final int SPLIT_SUMMARIES_FIELD_NUMBER
Field Value
Type Description
int

USE_STEMMER_FIELD_NUMBER

public static final int USE_STEMMER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RougeSpec getDefaultInstance()
Returns
Type Description
RougeSpec

getDescriptor()

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

newBuilder()

public static RougeSpec.Builder newBuilder()
Returns
Type Description
RougeSpec.Builder

newBuilder(RougeSpec prototype)

public static RougeSpec.Builder newBuilder(RougeSpec prototype)
Parameter
Name Description
prototype RougeSpec
Returns
Type Description
RougeSpec.Builder

parseDelimitedFrom(InputStream input)

public static RougeSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RougeSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RougeSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RougeSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RougeSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RougeSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RougeSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RougeSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RougeSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RougeSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RougeSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RougeSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RougeSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RougeSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RougeSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RougeSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RougeSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RougeSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RougeSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RougeSpec> parser()
Returns
Type Description
Parser<RougeSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RougeSpec getDefaultInstanceForType()
Returns
Type Description
RougeSpec

getParserForType()

public Parser<RougeSpec> getParserForType()
Returns
Type Description
Parser<RougeSpec>
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RougeSpec.Builder newBuilderForType()
Returns
Type Description
RougeSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RougeSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RougeSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RougeSpec.Builder toBuilder()
Returns
Type Description
RougeSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException