Class SummarizationQualityInstance (3.42.0)

public final class SummarizationQualityInstance extends GeneratedMessageV3 implements SummarizationQualityInstanceOrBuilder

Spec for summarization quality instance.

Protobuf type google.cloud.aiplatform.v1beta1.SummarizationQualityInstance

Static Fields

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

INSTRUCTION_FIELD_NUMBER

public static final int INSTRUCTION_FIELD_NUMBER
Field Value
Type Description
int

PREDICTION_FIELD_NUMBER

public static final int PREDICTION_FIELD_NUMBER
Field Value
Type Description
int

REFERENCE_FIELD_NUMBER

public static final int REFERENCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SummarizationQualityInstance getDefaultInstance()
Returns
Type Description
SummarizationQualityInstance

getDescriptor()

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

newBuilder()

public static SummarizationQualityInstance.Builder newBuilder()
Returns
Type Description
SummarizationQualityInstance.Builder

newBuilder(SummarizationQualityInstance prototype)

public static SummarizationQualityInstance.Builder newBuilder(SummarizationQualityInstance prototype)
Parameter
Name Description
prototype SummarizationQualityInstance
Returns
Type Description
SummarizationQualityInstance.Builder

parseDelimitedFrom(InputStream input)

public static SummarizationQualityInstance parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizationQualityInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SummarizationQualityInstance parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SummarizationQualityInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SummarizationQualityInstance parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SummarizationQualityInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SummarizationQualityInstance parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizationQualityInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SummarizationQualityInstance parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizationQualityInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SummarizationQualityInstance parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SummarizationQualityInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizationQualityInstance
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SummarizationQualityInstance> parser()
Returns
Type Description
Parser<SummarizationQualityInstance>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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 SummarizationQualityInstance getDefaultInstanceForType()
Returns
Type Description
SummarizationQualityInstance

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.

getParserForType()

public Parser<SummarizationQualityInstance> getParserForType()
Returns
Type Description
Parser<SummarizationQualityInstance>
Overrides

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.

getSerializedSize()

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SummarizationQualityInstance.Builder newBuilderForType()
Returns
Type Description
SummarizationQualityInstance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SummarizationQualityInstance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SummarizationQualityInstance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SummarizationQualityInstance.Builder toBuilder()
Returns
Type Description
SummarizationQualityInstance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException