Class SummarizationHelpfulnessInstance.Builder (3.40.0)

Version 3.40.0

• 3.52.0 (latest)
• 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 static final class SummarizationHelpfulnessInstance.Builder extends GeneratedMessageV3.Builder<SummarizationHelpfulnessInstance.Builder> implements SummarizationHelpfulnessInstanceOrBuilder

Spec for summarization helpfulness instance.

Protobuf type google.cloud.aiplatform.v1beta1.SummarizationHelpfulnessInstance

Inheritance

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

Implements

SummarizationHelpfulnessInstanceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SummarizationHelpfulnessInstance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SummarizationHelpfulnessInstance build()

Returns
Type	Description
SummarizationHelpfulnessInstance

buildPartial()

public SummarizationHelpfulnessInstance buildPartial()

Returns
Type	Description
SummarizationHelpfulnessInstance

clear()

public SummarizationHelpfulnessInstance.Builder clear()

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearContext()

public SummarizationHelpfulnessInstance.Builder clearContext()

Required. Text to be summarized.

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

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SummarizationHelpfulnessInstance.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInstruction()

public SummarizationHelpfulnessInstance.Builder clearInstruction()

Optional. Summarization prompt for LLM.

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

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SummarizationHelpfulnessInstance.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPrediction()

public SummarizationHelpfulnessInstance.Builder clearPrediction()

Required. Output of the evaluated model.

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

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

clearReference()

public SummarizationHelpfulnessInstance.Builder clearReference()

Optional. Ground truth used to compare against the prediction.

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

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

clone()

public SummarizationHelpfulnessInstance.Builder clone()

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SummarizationHelpfulnessInstance other)

public SummarizationHelpfulnessInstance.Builder mergeFrom(SummarizationHelpfulnessInstance other)

Parameter
Name	Description
other	SummarizationHelpfulnessInstance

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SummarizationHelpfulnessInstance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SummarizationHelpfulnessInstance.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SummarizationHelpfulnessInstance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setContext(String value)

public SummarizationHelpfulnessInstance.Builder setContext(String value)

Required. Text to be summarized.

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

Parameter
Name	Description
value	String The context to set.

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

setContextBytes(ByteString value)

public SummarizationHelpfulnessInstance.Builder setContextBytes(ByteString value)

Required. Text to be summarized.

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

Parameter
Name	Description
value	ByteString The bytes for context to set.

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SummarizationHelpfulnessInstance.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInstruction(String value)

public SummarizationHelpfulnessInstance.Builder setInstruction(String value)

Optional. Summarization prompt for LLM.

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

Parameter
Name	Description
value	String The instruction to set.

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

setInstructionBytes(ByteString value)

public SummarizationHelpfulnessInstance.Builder setInstructionBytes(ByteString value)

Optional. Summarization prompt for LLM.

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

Parameter
Name	Description
value	ByteString The bytes for instruction to set.

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

setPrediction(String value)

public SummarizationHelpfulnessInstance.Builder setPrediction(String value)

Required. Output of the evaluated model.

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

Parameter
Name	Description
value	String The prediction to set.

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

setPredictionBytes(ByteString value)

public SummarizationHelpfulnessInstance.Builder setPredictionBytes(ByteString value)

Required. Output of the evaluated model.

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

Parameter
Name	Description
value	ByteString The bytes for prediction to set.

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

setReference(String value)

public SummarizationHelpfulnessInstance.Builder setReference(String value)

Optional. Ground truth used to compare against the prediction.

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

Parameter
Name	Description
value	String The reference to set.

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

setReferenceBytes(ByteString value)

public SummarizationHelpfulnessInstance.Builder setReferenceBytes(ByteString value)

Optional. Ground truth used to compare against the prediction.

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

Parameter
Name	Description
value	ByteString The bytes for reference to set.

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SummarizationHelpfulnessInstance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final SummarizationHelpfulnessInstance.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SummarizationHelpfulnessInstance.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)