Class SummarizationHelpfulnessSpec (3.46.0)

public final class SummarizationHelpfulnessSpec extends GeneratedMessageV3 implements SummarizationHelpfulnessSpecOrBuilder

Spec for summarization helpfulness score metric.

Protobuf type google.cloud.aiplatform.v1beta1.SummarizationHelpfulnessSpec

Static Fields

USE_REFERENCE_FIELD_NUMBER

public static final int USE_REFERENCE_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SummarizationHelpfulnessSpec getDefaultInstance()
Returns
Type Description
SummarizationHelpfulnessSpec

getDescriptor()

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

newBuilder()

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

newBuilder(SummarizationHelpfulnessSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SummarizationHelpfulnessSpec getDefaultInstanceForType()
Returns
Type Description
SummarizationHelpfulnessSpec

getParserForType()

public Parser<SummarizationHelpfulnessSpec> getParserForType()
Returns
Type Description
Parser<SummarizationHelpfulnessSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUseReference()

public boolean getUseReference()

Optional. Whether to use instance.reference to compute summarization helpfulness.

bool use_reference = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The useReference.

getVersion()

public int getVersion()

Optional. Which version to use for evaluation.

int32 version = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The version.

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 SummarizationHelpfulnessSpec.Builder newBuilderForType()
Returns
Type Description
SummarizationHelpfulnessSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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