com.google.cloud.aiplatform.v1beta1

Class SummarizationHelpfulnessInstance

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.SummarizationHelpfulnessInstance

All Implemented Interfaces:

SummarizationHelpfulnessInstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class SummarizationHelpfulnessInstance
extends com.google.protobuf.GeneratedMessageV3
implements SummarizationHelpfulnessInstanceOrBuilder

 Spec for summarization helpfulness instance.
 

Protobuf type google.cloud.aiplatform.v1beta1.SummarizationHelpfulnessInstance

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SummarizationHelpfulnessInstance.Builder Spec for summarization helpfulness instance.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTEXT_FIELD_NUMBER
static int	INSTRUCTION_FIELD_NUMBER
static int	PREDICTION_FIELD_NUMBER
static int	REFERENCE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getContext() Required.
com.google.protobuf.ByteString	getContextBytes() Required.
static SummarizationHelpfulnessInstance	getDefaultInstance()
SummarizationHelpfulnessInstance	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getInstruction() Optional.
com.google.protobuf.ByteString	getInstructionBytes() Optional.
com.google.protobuf.Parser<SummarizationHelpfulnessInstance>	getParserForType()
String	getPrediction() Required.
com.google.protobuf.ByteString	getPredictionBytes() Required.
String	getReference() Optional.
com.google.protobuf.ByteString	getReferenceBytes() Optional.
int	getSerializedSize()
boolean	hasContext() Required.
int	hashCode()
boolean	hasInstruction() Optional.
boolean	hasPrediction() Required.
boolean	hasReference() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SummarizationHelpfulnessInstance.Builder	newBuilder()
static SummarizationHelpfulnessInstance.Builder	newBuilder(SummarizationHelpfulnessInstance prototype)
SummarizationHelpfulnessInstance.Builder	newBuilderForType()
protected SummarizationHelpfulnessInstance.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SummarizationHelpfulnessInstance	parseDelimitedFrom(InputStream input)
static SummarizationHelpfulnessInstance	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummarizationHelpfulnessInstance	parseFrom(byte[] data)
static SummarizationHelpfulnessInstance	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummarizationHelpfulnessInstance	parseFrom(ByteBuffer data)
static SummarizationHelpfulnessInstance	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummarizationHelpfulnessInstance	parseFrom(com.google.protobuf.ByteString data)
static SummarizationHelpfulnessInstance	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummarizationHelpfulnessInstance	parseFrom(com.google.protobuf.CodedInputStream input)
static SummarizationHelpfulnessInstance	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummarizationHelpfulnessInstance	parseFrom(InputStream input)
static SummarizationHelpfulnessInstance	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SummarizationHelpfulnessInstance>	parser()
SummarizationHelpfulnessInstance.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PREDICTION_FIELD_NUMBER

public static final int PREDICTION_FIELD_NUMBER

See Also:

Constant Field Values

REFERENCE_FIELD_NUMBER

public static final int REFERENCE_FIELD_NUMBER

See Also:

Constant Field Values

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER

See Also:

Constant Field Values

INSTRUCTION_FIELD_NUMBER

public static final int INSTRUCTION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasPrediction

public boolean hasPrediction()

 Required. Output of the evaluated model.
 

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

Specified by:

hasPrediction in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

Whether the prediction field is set.

getPrediction

public String getPrediction()

 Required. Output of the evaluated model.
 

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

Specified by:

getPrediction in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

The prediction.

getPredictionBytes

public com.google.protobuf.ByteString getPredictionBytes()

 Required. Output of the evaluated model.
 

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

Specified by:

getPredictionBytes in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

The bytes for prediction.

hasReference

public boolean hasReference()

 Optional. Ground truth used to compare against the prediction.
 

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

Specified by:

hasReference in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

Whether the reference field is set.

getReference

public String getReference()

 Optional. Ground truth used to compare against the prediction.
 

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

Specified by:

getReference in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

The reference.

getReferenceBytes

public com.google.protobuf.ByteString getReferenceBytes()

 Optional. Ground truth used to compare against the prediction.
 

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

Specified by:

getReferenceBytes in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

The bytes for reference.

hasContext

public boolean hasContext()

 Required. Text to be summarized.
 

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

Specified by:

hasContext in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

Whether the context field is set.

getContext

public String getContext()

 Required. Text to be summarized.
 

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

Specified by:

getContext in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

The context.

getContextBytes

public com.google.protobuf.ByteString getContextBytes()

 Required. Text to be summarized.
 

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

Specified by:

getContextBytes in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

The bytes for context.

hasInstruction

public boolean hasInstruction()

 Optional. Summarization prompt for LLM.
 

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

Specified by:

hasInstruction in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

Whether the instruction field is set.

getInstruction

public String getInstruction()

 Optional. Summarization prompt for LLM.
 

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

Specified by:

getInstruction in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

The instruction.

getInstructionBytes

public com.google.protobuf.ByteString getInstructionBytes()

 Optional. Summarization prompt for LLM.
 

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

Specified by:

getInstructionBytes in interface SummarizationHelpfulnessInstanceOrBuilder

Returns:

The bytes for instruction.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(com.google.protobuf.ByteString data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(byte[] data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static SummarizationHelpfulnessInstance parseDelimitedFrom(InputStream input)
                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static SummarizationHelpfulnessInstance parseDelimitedFrom(InputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:

IOException

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(com.google.protobuf.CodedInputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

public static SummarizationHelpfulnessInstance parseFrom(com.google.protobuf.CodedInputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

newBuilderForType

public SummarizationHelpfulnessInstance.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SummarizationHelpfulnessInstance.Builder newBuilder()

newBuilder

public static SummarizationHelpfulnessInstance.Builder newBuilder(SummarizationHelpfulnessInstance prototype)

toBuilder

public SummarizationHelpfulnessInstance.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SummarizationHelpfulnessInstance.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SummarizationHelpfulnessInstance getDefaultInstance()

parser

public static com.google.protobuf.Parser<SummarizationHelpfulnessInstance> parser()

getParserForType

public com.google.protobuf.Parser<SummarizationHelpfulnessInstance> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SummarizationHelpfulnessInstance getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder