Class SummarizationQualityInstance.Builder (3.84.0)

public static final class SummarizationQualityInstance.Builder extends GeneratedMessage.Builder<SummarizationQualityInstance.Builder> implements SummarizationQualityInstanceOrBuilder

Spec for summarization quality instance.

Protobuf type google.cloud.aiplatform.v1.SummarizationQualityInstance

Static Methods

getDescriptor()

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

Methods

build()

public SummarizationQualityInstance build()
Returns
Type Description
SummarizationQualityInstance

buildPartial()

public SummarizationQualityInstance buildPartial()
Returns
Type Description
SummarizationQualityInstance

clear()

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

clearContext()

public SummarizationQualityInstance.Builder clearContext()

Required. Text to be summarized.

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

Returns
Type Description
SummarizationQualityInstance.Builder

This builder for chaining.

clearInstruction()

public SummarizationQualityInstance.Builder clearInstruction()

Required. Summarization prompt for LLM.

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

Returns
Type Description
SummarizationQualityInstance.Builder

This builder for chaining.

clearPrediction()

public SummarizationQualityInstance.Builder clearPrediction()

Required. Output of the evaluated model.

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

Returns
Type Description
SummarizationQualityInstance.Builder

This builder for chaining.

clearReference()

public SummarizationQualityInstance.Builder clearReference()

Optional. Ground truth used to compare against the prediction.

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

Returns
Type Description
SummarizationQualityInstance.Builder

This builder for chaining.

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 SummarizationQualityInstance getDefaultInstanceForType()
Returns
Type Description
SummarizationQualityInstance

getDescriptorForType()

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

getInstruction()

public String getInstruction()

Required. Summarization prompt for LLM.

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

Returns
Type Description
String

The instruction.

getInstructionBytes()

public ByteString getInstructionBytes()

Required. Summarization prompt for LLM.

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

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()

Required. Summarization prompt for LLM.

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

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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SummarizationQualityInstance other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setContext(String value)

public SummarizationQualityInstance.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
SummarizationQualityInstance.Builder

This builder for chaining.

setContextBytes(ByteString value)

public SummarizationQualityInstance.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
SummarizationQualityInstance.Builder

This builder for chaining.

setInstruction(String value)

public SummarizationQualityInstance.Builder setInstruction(String value)

Required. Summarization prompt for LLM.

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

Parameter
Name Description
value String

The instruction to set.

Returns
Type Description
SummarizationQualityInstance.Builder

This builder for chaining.

setInstructionBytes(ByteString value)

public SummarizationQualityInstance.Builder setInstructionBytes(ByteString value)

Required. Summarization prompt for LLM.

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

Parameter
Name Description
value ByteString

The bytes for instruction to set.

Returns
Type Description
SummarizationQualityInstance.Builder

This builder for chaining.

setPrediction(String value)

public SummarizationQualityInstance.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
SummarizationQualityInstance.Builder

This builder for chaining.

setPredictionBytes(ByteString value)

public SummarizationQualityInstance.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
SummarizationQualityInstance.Builder

This builder for chaining.

setReference(String value)

public SummarizationQualityInstance.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
SummarizationQualityInstance.Builder

This builder for chaining.

setReferenceBytes(ByteString value)

public SummarizationQualityInstance.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
SummarizationQualityInstance.Builder

This builder for chaining.