Class PairwiseSummarizationQualityInstance.Builder (3.44.0)

public static final class PairwiseSummarizationQualityInstance.Builder extends GeneratedMessageV3.Builder<PairwiseSummarizationQualityInstance.Builder> implements PairwiseSummarizationQualityInstanceOrBuilder

Spec for pairwise summarization quality instance.

Protobuf type google.cloud.aiplatform.v1beta1.PairwiseSummarizationQualityInstance

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PairwiseSummarizationQualityInstance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PairwiseSummarizationQualityInstance.Builder
Overrides

build()

public PairwiseSummarizationQualityInstance build()
Returns
Type Description
PairwiseSummarizationQualityInstance

buildPartial()

public PairwiseSummarizationQualityInstance buildPartial()
Returns
Type Description
PairwiseSummarizationQualityInstance

clear()

public PairwiseSummarizationQualityInstance.Builder clear()
Returns
Type Description
PairwiseSummarizationQualityInstance.Builder
Overrides

clearBaselinePrediction()

public PairwiseSummarizationQualityInstance.Builder clearBaselinePrediction()

Required. Output of the baseline model.

optional string baseline_prediction = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

clearContext()

public PairwiseSummarizationQualityInstance.Builder clearContext()

Required. Text to be summarized.

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

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PairwiseSummarizationQualityInstance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PairwiseSummarizationQualityInstance.Builder
Overrides

clearInstruction()

public PairwiseSummarizationQualityInstance.Builder clearInstruction()

Required. Summarization prompt for LLM.

optional string instruction = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PairwiseSummarizationQualityInstance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PairwiseSummarizationQualityInstance.Builder
Overrides

clearPrediction()

public PairwiseSummarizationQualityInstance.Builder clearPrediction()

Required. Output of the candidate model.

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

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

clearReference()

public PairwiseSummarizationQualityInstance.Builder clearReference()

Optional. Ground truth used to compare against the prediction.

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

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

clone()

public PairwiseSummarizationQualityInstance.Builder clone()
Returns
Type Description
PairwiseSummarizationQualityInstance.Builder
Overrides

getBaselinePrediction()

public String getBaselinePrediction()

Required. Output of the baseline model.

optional string baseline_prediction = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The baselinePrediction.

getBaselinePredictionBytes()

public ByteString getBaselinePredictionBytes()

Required. Output of the baseline model.

optional string baseline_prediction = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for baselinePrediction.

getContext()

public String getContext()

Required. Text to be summarized.

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

Returns
Type Description
String

The context.

getContextBytes()

public ByteString getContextBytes()

Required. Text to be summarized.

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

Returns
Type Description
ByteString

The bytes for context.

getDefaultInstanceForType()

public PairwiseSummarizationQualityInstance getDefaultInstanceForType()
Returns
Type Description
PairwiseSummarizationQualityInstance

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInstruction()

public String getInstruction()

Required. Summarization prompt for LLM.

optional string instruction = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The instruction.

getInstructionBytes()

public ByteString getInstructionBytes()

Required. Summarization prompt for LLM.

optional string instruction = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for instruction.

getPrediction()

public String getPrediction()

Required. Output of the candidate model.

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

Returns
Type Description
String

The prediction.

getPredictionBytes()

public ByteString getPredictionBytes()

Required. Output of the candidate 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 = 3 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for reference.

hasBaselinePrediction()

public boolean hasBaselinePrediction()

Required. Output of the baseline model.

optional string baseline_prediction = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the baselinePrediction field is set.

hasContext()

public boolean hasContext()

Required. Text to be summarized.

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

Returns
Type Description
boolean

Whether the context field is set.

hasInstruction()

public boolean hasInstruction()

Required. Summarization prompt for LLM.

optional string instruction = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the instruction field is set.

hasPrediction()

public boolean hasPrediction()

Required. Output of the candidate 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 = 3 [(.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(PairwiseSummarizationQualityInstance other)

public PairwiseSummarizationQualityInstance.Builder mergeFrom(PairwiseSummarizationQualityInstance other)
Parameter
Name Description
other PairwiseSummarizationQualityInstance
Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PairwiseSummarizationQualityInstance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PairwiseSummarizationQualityInstance.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBaselinePrediction(String value)

public PairwiseSummarizationQualityInstance.Builder setBaselinePrediction(String value)

Required. Output of the baseline model.

optional string baseline_prediction = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The baselinePrediction to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

setBaselinePredictionBytes(ByteString value)

public PairwiseSummarizationQualityInstance.Builder setBaselinePredictionBytes(ByteString value)

Required. Output of the baseline model.

optional string baseline_prediction = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for baselinePrediction to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

setContext(String value)

public PairwiseSummarizationQualityInstance.Builder setContext(String value)

Required. Text to be summarized.

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

Parameter
Name Description
value String

The context to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

setContextBytes(ByteString value)

public PairwiseSummarizationQualityInstance.Builder setContextBytes(ByteString value)

Required. Text to be summarized.

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

Parameter
Name Description
value ByteString

The bytes for context to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PairwiseSummarizationQualityInstance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PairwiseSummarizationQualityInstance.Builder
Overrides

setInstruction(String value)

public PairwiseSummarizationQualityInstance.Builder setInstruction(String value)

Required. Summarization prompt for LLM.

optional string instruction = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The instruction to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

setInstructionBytes(ByteString value)

public PairwiseSummarizationQualityInstance.Builder setInstructionBytes(ByteString value)

Required. Summarization prompt for LLM.

optional string instruction = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for instruction to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

setPrediction(String value)

public PairwiseSummarizationQualityInstance.Builder setPrediction(String value)

Required. Output of the candidate model.

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

Parameter
Name Description
value String

The prediction to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

setPredictionBytes(ByteString value)

public PairwiseSummarizationQualityInstance.Builder setPredictionBytes(ByteString value)

Required. Output of the candidate model.

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

Parameter
Name Description
value ByteString

The bytes for prediction to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

setReference(String value)

public PairwiseSummarizationQualityInstance.Builder setReference(String value)

Optional. Ground truth used to compare against the prediction.

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

Parameter
Name Description
value String

The reference to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

setReferenceBytes(ByteString value)

public PairwiseSummarizationQualityInstance.Builder setReferenceBytes(ByteString value)

Optional. Ground truth used to compare against the prediction.

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

Parameter
Name Description
value ByteString

The bytes for reference to set.

Returns
Type Description
PairwiseSummarizationQualityInstance.Builder

This builder for chaining.

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

public PairwiseSummarizationQualityInstance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PairwiseSummarizationQualityInstance.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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