Class SummarizationHelpfulnessInstance (3.56.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 3.56.0keyboard_arrow_down
public final class SummarizationHelpfulnessInstance extends GeneratedMessageV3 implements SummarizationHelpfulnessInstanceOrBuilder
Spec for summarization helpfulness instance.
Protobuf type google.cloud.aiplatform.v1beta1.SummarizationHelpfulnessInstance
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONTEXT_FIELD_NUMBER
public static final int CONTEXT_FIELD_NUMBER
Field Value
Type Description
int
public static final int INSTRUCTION_FIELD_NUMBER
Field Value
Type Description
int
public static final int PREDICTION_FIELD_NUMBER
Field Value
Type Description
int
public static final int REFERENCE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static SummarizationHelpfulnessInstance getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static SummarizationHelpfulnessInstance . Builder newBuilder ()
public static SummarizationHelpfulnessInstance . Builder newBuilder ( SummarizationHelpfulnessInstance prototype )
public static SummarizationHelpfulnessInstance parseDelimitedFrom ( InputStream input )
public static SummarizationHelpfulnessInstance parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static SummarizationHelpfulnessInstance parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static SummarizationHelpfulnessInstance parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static SummarizationHelpfulnessInstance parseFrom ( ByteString data )
public static SummarizationHelpfulnessInstance parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static SummarizationHelpfulnessInstance parseFrom ( CodedInputStream input )
public static SummarizationHelpfulnessInstance parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static SummarizationHelpfulnessInstance parseFrom ( InputStream input )
public static SummarizationHelpfulnessInstance parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static SummarizationHelpfulnessInstance parseFrom ( ByteBuffer data )
public static SummarizationHelpfulnessInstance parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<SummarizationHelpfulnessInstance> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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.
public SummarizationHelpfulnessInstance getDefaultInstanceForType ()
public String getInstruction ()
Optional. Summarization prompt for LLM.
optional string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The instruction.
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.
public Parser<SummarizationHelpfulnessInstance> getParserForType ()
Overrides
public String getPrediction ()
Required. Output of the evaluated model.
optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The prediction.
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.
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.
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.
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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.
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.
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.
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.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public SummarizationHelpfulnessInstance . Builder newBuilderForType ()
protected SummarizationHelpfulnessInstance . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public SummarizationHelpfulnessInstance . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
