Class SummarizationHelpfulnessSpec (3.41.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
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SummarizationHelpfulnessSpec getDefaultInstance()
Returns
TypeDescription
SummarizationHelpfulnessSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SummarizationHelpfulnessSpec.Builder newBuilder()
Returns
TypeDescription
SummarizationHelpfulnessSpec.Builder

newBuilder(SummarizationHelpfulnessSpec prototype)

public static SummarizationHelpfulnessSpec.Builder newBuilder(SummarizationHelpfulnessSpec prototype)
Parameter
NameDescription
prototypeSummarizationHelpfulnessSpec
Returns
TypeDescription
SummarizationHelpfulnessSpec.Builder

parseDelimitedFrom(InputStream input)

public static SummarizationHelpfulnessSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SummarizationHelpfulnessSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SummarizationHelpfulnessSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SummarizationHelpfulnessSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SummarizationHelpfulnessSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SummarizationHelpfulnessSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummarizationHelpfulnessSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SummarizationHelpfulnessSpec> parser()
Returns
TypeDescription
Parser<SummarizationHelpfulnessSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SummarizationHelpfulnessSpec getDefaultInstanceForType()
Returns
TypeDescription
SummarizationHelpfulnessSpec

getParserForType()

public Parser<SummarizationHelpfulnessSpec> getParserForType()
Returns
TypeDescription
Parser<SummarizationHelpfulnessSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
boolean

The useReference.

getVersion()

public int getVersion()

Optional. Which version to use for evaluation.

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

Returns
TypeDescription
int

The version.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SummarizationHelpfulnessSpec.Builder newBuilderForType()
Returns
TypeDescription
SummarizationHelpfulnessSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SummarizationHelpfulnessSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SummarizationHelpfulnessSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SummarizationHelpfulnessSpec.Builder toBuilder()
Returns
TypeDescription
SummarizationHelpfulnessSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException