Class SummarizationHelpfulnessInstance (3.41.0)

public final class SummarizationHelpfulnessInstance extends GeneratedMessageV3 implements SummarizationHelpfulnessInstanceOrBuilder

Spec for summarization helpfulness instance.

Protobuf type google.cloud.aiplatform.v1beta1.SummarizationHelpfulnessInstance

Inheritance

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

Static Fields

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER
Field Value
TypeDescription
int

INSTRUCTION_FIELD_NUMBER

public static final int INSTRUCTION_FIELD_NUMBER
Field Value
TypeDescription
int

PREDICTION_FIELD_NUMBER

public static final int PREDICTION_FIELD_NUMBER
Field Value
TypeDescription
int

REFERENCE_FIELD_NUMBER

public static final int REFERENCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SummarizationHelpfulnessInstance getDefaultInstance()
Returns
TypeDescription
SummarizationHelpfulnessInstance

getDescriptor()

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

newBuilder()

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

newBuilder(SummarizationHelpfulnessInstance prototype)

public static SummarizationHelpfulnessInstance.Builder newBuilder(SummarizationHelpfulnessInstance prototype)
Parameter
NameDescription
prototypeSummarizationHelpfulnessInstance
Returns
TypeDescription
SummarizationHelpfulnessInstance.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getContext()

public String getContext()

Required. Text to be summarized.

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

Returns
TypeDescription
String

The context.

getContextBytes()

public ByteString getContextBytes()

Required. Text to be summarized.

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

Returns
TypeDescription
ByteString

The bytes for context.

getDefaultInstanceForType()

public SummarizationHelpfulnessInstance getDefaultInstanceForType()
Returns
TypeDescription
SummarizationHelpfulnessInstance

getInstruction()

public String getInstruction()

Optional. Summarization prompt for LLM.

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

Returns
TypeDescription
String

The instruction.

getInstructionBytes()

public ByteString getInstructionBytes()

Optional. Summarization prompt for LLM.

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

Returns
TypeDescription
ByteString

The bytes for instruction.

getParserForType()

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

getPrediction()

public String getPrediction()

Required. Output of the evaluated model.

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

Returns
TypeDescription
String

The prediction.

getPredictionBytes()

public ByteString getPredictionBytes()

Required. Output of the evaluated model.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for reference.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasContext()

public boolean hasContext()

Required. Text to be summarized.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the reference field is set.

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 SummarizationHelpfulnessInstance.Builder newBuilderForType()
Returns
TypeDescription
SummarizationHelpfulnessInstance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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