SummarizationHelpfulnessInstance.Builder (proto-google-cloud-aiplatform-v1 3.86.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<SummarizationHelpfulnessInstance.Builder>
    - - com.google.cloud.aiplatform.v1.SummarizationHelpfulnessInstance.Builder

All Implemented Interfaces:

SummarizationHelpfulnessInstanceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SummarizationHelpfulnessInstance
```
public static final class SummarizationHelpfulnessInstance.Builder
extends com.google.protobuf.GeneratedMessage.Builder<SummarizationHelpfulnessInstance.Builder>
implements SummarizationHelpfulnessInstanceOrBuilder
```
```
 Spec for summarization helpfulness instance.
 
```
Protobuf type google.cloud.aiplatform.v1.SummarizationHelpfulnessInstance

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SummarizationHelpfulnessInstance`	`build()`
`SummarizationHelpfulnessInstance`	`buildPartial()`
`SummarizationHelpfulnessInstance.Builder`	`clear()`
`SummarizationHelpfulnessInstance.Builder`	`clearContext()` Required.
`SummarizationHelpfulnessInstance.Builder`	`clearInstruction()` Optional.
`SummarizationHelpfulnessInstance.Builder`	`clearPrediction()` Required.
`SummarizationHelpfulnessInstance.Builder`	`clearReference()` Optional.
`String`	`getContext()` Required.
`com.google.protobuf.ByteString`	`getContextBytes()` Required.
`SummarizationHelpfulnessInstance`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getInstruction()` Optional.
`com.google.protobuf.ByteString`	`getInstructionBytes()` Optional.
`String`	`getPrediction()` Required.
`com.google.protobuf.ByteString`	`getPredictionBytes()` Required.
`String`	`getReference()` Optional.
`com.google.protobuf.ByteString`	`getReferenceBytes()` Optional.
`boolean`	`hasContext()` Required.
`boolean`	`hasInstruction()` Optional.
`boolean`	`hasPrediction()` Required.
`boolean`	`hasReference()` Optional.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`SummarizationHelpfulnessInstance.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`SummarizationHelpfulnessInstance.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`SummarizationHelpfulnessInstance.Builder`	`mergeFrom(SummarizationHelpfulnessInstance other)`
`SummarizationHelpfulnessInstance.Builder`	`setContext(String value)` Required.
`SummarizationHelpfulnessInstance.Builder`	`setContextBytes(com.google.protobuf.ByteString value)` Required.
`SummarizationHelpfulnessInstance.Builder`	`setInstruction(String value)` Optional.
`SummarizationHelpfulnessInstance.Builder`	`setInstructionBytes(com.google.protobuf.ByteString value)` Optional.
`SummarizationHelpfulnessInstance.Builder`	`setPrediction(String value)` Required.
`SummarizationHelpfulnessInstance.Builder`	`setPredictionBytes(com.google.protobuf.ByteString value)` Required.
`SummarizationHelpfulnessInstance.Builder`	`setReference(String value)` Optional.
`SummarizationHelpfulnessInstance.Builder`	`setReferenceBytes(com.google.protobuf.ByteString value)` Optional.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SummarizationHelpfulnessInstance.Builder>
  - clear
```
public SummarizationHelpfulnessInstance.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessage.Builder<SummarizationHelpfulnessInstance.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SummarizationHelpfulnessInstance.Builder>
  - getDefaultInstanceForType
```
public SummarizationHelpfulnessInstance getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public SummarizationHelpfulnessInstance build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public SummarizationHelpfulnessInstance buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public SummarizationHelpfulnessInstance.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SummarizationHelpfulnessInstance.Builder>
  - mergeFrom
```
public SummarizationHelpfulnessInstance.Builder mergeFrom(SummarizationHelpfulnessInstance other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SummarizationHelpfulnessInstance.Builder>
  - mergeFrom
```
public SummarizationHelpfulnessInstance.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SummarizationHelpfulnessInstance.Builder>
    
    Throws:
    
    IOException
  - hasPrediction
```
public boolean hasPrediction()
```
```
 Required. Output of the evaluated model.
 
```
    optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    hasPrediction in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    Whether the prediction field is set.
  - getPrediction
```
public String getPrediction()
```
```
 Required. Output of the evaluated model.
 
```
    optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getPrediction in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    The prediction.
  - getPredictionBytes
```
public com.google.protobuf.ByteString getPredictionBytes()
```
```
 Required. Output of the evaluated model.
 
```
    optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getPredictionBytes in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    The bytes for prediction.
  - setPrediction
```
public SummarizationHelpfulnessInstance.Builder setPrediction(String value)
```
```
 Required. Output of the evaluated model.
 
```
    optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The prediction to set.
    
    Returns:
    
    This builder for chaining.
  - clearPrediction
```
public SummarizationHelpfulnessInstance.Builder clearPrediction()
```
```
 Required. Output of the evaluated model.
 
```
    optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    This builder for chaining.
  - setPredictionBytes
```
public SummarizationHelpfulnessInstance.Builder setPredictionBytes(com.google.protobuf.ByteString value)
```
```
 Required. Output of the evaluated model.
 
```
    optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The bytes for prediction to set.
    
    Returns:
    
    This builder for chaining.
  - hasReference
```
public boolean hasReference()
```
```
 Optional. Ground truth used to compare against the prediction.
 
```
    optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasReference in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    Whether the reference field is set.
  - getReference
```
public String getReference()
```
```
 Optional. Ground truth used to compare against the prediction.
 
```
    optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getReference in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    The reference.
  - getReferenceBytes
```
public com.google.protobuf.ByteString getReferenceBytes()
```
```
 Optional. Ground truth used to compare against the prediction.
 
```
    optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getReferenceBytes in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    The bytes for reference.
  - setReference
```
public SummarizationHelpfulnessInstance.Builder setReference(String value)
```
```
 Optional. Ground truth used to compare against the prediction.
 
```
    optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The reference to set.
    
    Returns:
    
    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:
    
    This builder for chaining.
  - setReferenceBytes
```
public SummarizationHelpfulnessInstance.Builder setReferenceBytes(com.google.protobuf.ByteString value)
```
```
 Optional. Ground truth used to compare against the prediction.
 
```
    optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The bytes for reference to set.
    
    Returns:
    
    This builder for chaining.
  - hasContext
```
public boolean hasContext()
```
```
 Required. Text to be summarized.
 
```
    optional string context = 3 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    hasContext in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    Whether the context field is set.
  - getContext
```
public String getContext()
```
```
 Required. Text to be summarized.
 
```
    optional string context = 3 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getContext in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    The context.
  - getContextBytes
```
public com.google.protobuf.ByteString getContextBytes()
```
```
 Required. Text to be summarized.
 
```
    optional string context = 3 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getContextBytes in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    The bytes for context.
  - setContext
```
public SummarizationHelpfulnessInstance.Builder setContext(String value)
```
```
 Required. Text to be summarized.
 
```
    optional string context = 3 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The context to set.
    
    Returns:
    
    This builder for chaining.
  - clearContext
```
public SummarizationHelpfulnessInstance.Builder clearContext()
```
```
 Required. Text to be summarized.
 
```
    optional string context = 3 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    This builder for chaining.
  - setContextBytes
```
public SummarizationHelpfulnessInstance.Builder setContextBytes(com.google.protobuf.ByteString value)
```
```
 Required. Text to be summarized.
 
```
    optional string context = 3 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The bytes for context to set.
    
    Returns:
    
    This builder for chaining.
  - hasInstruction
```
public boolean hasInstruction()
```
```
 Optional. Summarization prompt for LLM.
 
```
    optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasInstruction in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    Whether the instruction field is set.
  - getInstruction
```
public String getInstruction()
```
```
 Optional. Summarization prompt for LLM.
 
```
    optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getInstruction in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    The instruction.
  - getInstructionBytes
```
public com.google.protobuf.ByteString getInstructionBytes()
```
```
 Optional. Summarization prompt for LLM.
 
```
    optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getInstructionBytes in interface SummarizationHelpfulnessInstanceOrBuilder
    
    Returns:
    
    The bytes for instruction.
  - setInstruction
```
public SummarizationHelpfulnessInstance.Builder setInstruction(String value)
```
```
 Optional. Summarization prompt for LLM.
 
```
    optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The instruction to set.
    
    Returns:
    
    This builder for chaining.
  - clearInstruction
```
public SummarizationHelpfulnessInstance.Builder clearInstruction()
```
```
 Optional. Summarization prompt for LLM.
 
```
    optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - setInstructionBytes
```
public SummarizationHelpfulnessInstance.Builder setInstructionBytes(com.google.protobuf.ByteString value)
```
```
 Optional. Summarization prompt for LLM.
 
```
    optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The bytes for instruction to set.
    
    Returns:
    
    This builder for chaining.

Class SummarizationHelpfulnessInstance.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasPrediction

getPrediction

getPredictionBytes

setPrediction

clearPrediction

setPredictionBytes

hasReference

getReference

getReferenceBytes

setReference

clearReference

setReferenceBytes

hasContext

getContext

getContextBytes

setContext

clearContext

setContextBytes

hasInstruction

getInstruction

getInstructionBytes

setInstruction

clearInstruction

setInstructionBytes