Class QuestionAnsweringHelpfulnessInstance (3.41.0)

public final class QuestionAnsweringHelpfulnessInstance extends GeneratedMessageV3 implements QuestionAnsweringHelpfulnessInstanceOrBuilder

Spec for question answering helpfulness instance.

Protobuf type google.cloud.aiplatform.v1beta1.QuestionAnsweringHelpfulnessInstance

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > QuestionAnsweringHelpfulnessInstance

Static Fields

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER
Field Value
TypeDescription
int

INSTRUCTION_FIELD_NUMBER

public static final int INSTRUCTION_FIELD_NUMBER
Field Value
TypeDescription
int

PREDICTION_FIELD_NUMBER

public static final int PREDICTION_FIELD_NUMBER
Field Value
TypeDescription
int

REFERENCE_FIELD_NUMBER

public static final int REFERENCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static QuestionAnsweringHelpfulnessInstance getDefaultInstance()
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static QuestionAnsweringHelpfulnessInstance.Builder newBuilder()
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance.Builder

newBuilder(QuestionAnsweringHelpfulnessInstance prototype)

public static QuestionAnsweringHelpfulnessInstance.Builder newBuilder(QuestionAnsweringHelpfulnessInstance prototype)
Parameter
NameDescription
prototypeQuestionAnsweringHelpfulnessInstance
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance.Builder

parseDelimitedFrom(InputStream input)

public static QuestionAnsweringHelpfulnessInstance parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuestionAnsweringHelpfulnessInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static QuestionAnsweringHelpfulnessInstance parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QuestionAnsweringHelpfulnessInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QuestionAnsweringHelpfulnessInstance parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QuestionAnsweringHelpfulnessInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QuestionAnsweringHelpfulnessInstance parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QuestionAnsweringHelpfulnessInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static QuestionAnsweringHelpfulnessInstance parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuestionAnsweringHelpfulnessInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static QuestionAnsweringHelpfulnessInstance parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QuestionAnsweringHelpfulnessInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<QuestionAnsweringHelpfulnessInstance> parser()
Returns
TypeDescription
Parser<QuestionAnsweringHelpfulnessInstance>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContext()

public String getContext()

Optional. Text provided as context to answer the question.

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

Returns
TypeDescription
String

The context.

getContextBytes()

public ByteString getContextBytes()

Optional. Text provided as context to answer the question.

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

Returns
TypeDescription
ByteString

The bytes for context.

getDefaultInstanceForType()

public QuestionAnsweringHelpfulnessInstance getDefaultInstanceForType()
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance

getInstruction()

public String getInstruction()

Required. The question asked and other instruction in the inference prompt.

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

Returns
TypeDescription
String

The instruction.

getInstructionBytes()

public ByteString getInstructionBytes()

Required. The question asked and other instruction in the inference prompt.

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

Returns
TypeDescription
ByteString

The bytes for instruction.

getParserForType()

public Parser<QuestionAnsweringHelpfulnessInstance> getParserForType()
Returns
TypeDescription
Parser<QuestionAnsweringHelpfulnessInstance>
Overrides

getPrediction()

public String getPrediction()

Required. Output of the evaluated model.

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

Returns
TypeDescription
String

The prediction.

getPredictionBytes()

public ByteString getPredictionBytes()

Required. Output of the evaluated model.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for reference.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasContext()

public boolean hasContext()

Optional. Text provided as context to answer the question.

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

Returns
TypeDescription
boolean

Whether the context field is set.

hasInstruction()

public boolean hasInstruction()

Required. The question asked and other instruction in the inference prompt.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the reference field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public QuestionAnsweringHelpfulnessInstance.Builder newBuilderForType()
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QuestionAnsweringHelpfulnessInstance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public QuestionAnsweringHelpfulnessInstance.Builder toBuilder()
Returns
TypeDescription
QuestionAnsweringHelpfulnessInstance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException