Class SummarizationHelpfulnessInstance.Builder (3.48.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

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

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

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

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

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

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SummarizationHelpfulnessInstance.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SummarizationHelpfulnessInstance.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SummarizationHelpfulnessInstance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SummarizationHelpfulnessInstance.Builder
Overrides

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final SummarizationHelpfulnessInstance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SummarizationHelpfulnessInstance.Builder
Overrides