Class SummarizationHelpfulnessInstance (3.53.0)

Version 3.53.0

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public final class SummarizationHelpfulnessInstance extends GeneratedMessageV3 implements SummarizationHelpfulnessInstanceOrBuilder

Spec for summarization helpfulness instance.

Protobuf type google.cloud.aiplatform.v1.SummarizationHelpfulnessInstance

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SummarizationHelpfulnessInstance

Implements

SummarizationHelpfulnessInstanceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER

Field Value
Type	Description
int

INSTRUCTION_FIELD_NUMBER

public static final int INSTRUCTION_FIELD_NUMBER

Field Value
Type	Description
int

PREDICTION_FIELD_NUMBER

public static final int PREDICTION_FIELD_NUMBER

Field Value
Type	Description
int

REFERENCE_FIELD_NUMBER

public static final int REFERENCE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SummarizationHelpfulnessInstance getDefaultInstance()

Returns
Type	Description
SummarizationHelpfulnessInstance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SummarizationHelpfulnessInstance.Builder newBuilder()

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

newBuilder(SummarizationHelpfulnessInstance prototype)

public static SummarizationHelpfulnessInstance.Builder newBuilder(SummarizationHelpfulnessInstance prototype)

Parameter
Name	Description
prototype	SummarizationHelpfulnessInstance

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

parseDelimitedFrom(InputStream input)

public static SummarizationHelpfulnessInstance parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SummarizationHelpfulnessInstance parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SummarizationHelpfulnessInstance parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SummarizationHelpfulnessInstance parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SummarizationHelpfulnessInstance parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SummarizationHelpfulnessInstance parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SummarizationHelpfulnessInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SummarizationHelpfulnessInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SummarizationHelpfulnessInstance> parser()

Returns
Type	Description
Parser<SummarizationHelpfulnessInstance>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getContext()

public String getContext()

Required. Text to be summarized.

optional string context = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The context.

getContextBytes()

public ByteString getContextBytes()

Required. Text to be summarized.

optional string context = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for context.

getDefaultInstanceForType()

public SummarizationHelpfulnessInstance getDefaultInstanceForType()

Returns
Type	Description
SummarizationHelpfulnessInstance

getInstruction()

public String getInstruction()

Optional. Summarization prompt for LLM.

optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The instruction.

getInstructionBytes()

public ByteString getInstructionBytes()

Optional. Summarization prompt for LLM.

optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for instruction.

getParserForType()

public Parser<SummarizationHelpfulnessInstance> getParserForType()

Returns
Type	Description
Parser<SummarizationHelpfulnessInstance>

Overrides

GeneratedMessageV3.getParserForType()

getPrediction()

public String getPrediction()

Required. Output of the evaluated model.

optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The prediction.

getPredictionBytes()

public ByteString getPredictionBytes()

Required. Output of the evaluated model.

optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for prediction.

getReference()

public String getReference()

Optional. Ground truth used to compare against the prediction.

optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The reference.

getReferenceBytes()

public ByteString getReferenceBytes()

Optional. Ground truth used to compare against the prediction.

optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for reference.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasContext()

public boolean hasContext()

Required. Text to be summarized.

optional string context = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the context field is set.

hasInstruction()

public boolean hasInstruction()

Optional. Summarization prompt for LLM.

optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the instruction field is set.

hasPrediction()

public boolean hasPrediction()

Required. Output of the evaluated model.

optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the prediction field is set.

hasReference()

public boolean hasReference()

Optional. Ground truth used to compare against the prediction.

optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the reference field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SummarizationHelpfulnessInstance.Builder newBuilderForType()

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SummarizationHelpfulnessInstance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SummarizationHelpfulnessInstance.Builder toBuilder()

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException