com.google.cloud.aiplatform.v1beta1

Class PointwiseMetricSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec

All Implemented Interfaces:

PointwiseMetricSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class PointwiseMetricSpec
extends com.google.protobuf.GeneratedMessageV3
implements PointwiseMetricSpecOrBuilder

 Spec for pointwise metric.
 

Protobuf type google.cloud.aiplatform.v1beta1.PointwiseMetricSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PointwiseMetricSpec.Builder Spec for pointwise metric.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CUSTOM_OUTPUT_FORMAT_CONFIG_FIELD_NUMBER
static int	METRIC_PROMPT_TEMPLATE_FIELD_NUMBER
static int	SYSTEM_INSTRUCTION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
CustomOutputFormatConfig	getCustomOutputFormatConfig() Optional.
CustomOutputFormatConfigOrBuilder	getCustomOutputFormatConfigOrBuilder() Optional.
static PointwiseMetricSpec	getDefaultInstance()
PointwiseMetricSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getMetricPromptTemplate() Required.
com.google.protobuf.ByteString	getMetricPromptTemplateBytes() Required.
com.google.protobuf.Parser<PointwiseMetricSpec>	getParserForType()
int	getSerializedSize()
String	getSystemInstruction() Optional.
com.google.protobuf.ByteString	getSystemInstructionBytes() Optional.
boolean	hasCustomOutputFormatConfig() Optional.
int	hashCode()
boolean	hasMetricPromptTemplate() Required.
boolean	hasSystemInstruction() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PointwiseMetricSpec.Builder	newBuilder()
static PointwiseMetricSpec.Builder	newBuilder(PointwiseMetricSpec prototype)
PointwiseMetricSpec.Builder	newBuilderForType()
protected PointwiseMetricSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PointwiseMetricSpec	parseDelimitedFrom(InputStream input)
static PointwiseMetricSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PointwiseMetricSpec	parseFrom(byte[] data)
static PointwiseMetricSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PointwiseMetricSpec	parseFrom(ByteBuffer data)
static PointwiseMetricSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PointwiseMetricSpec	parseFrom(com.google.protobuf.ByteString data)
static PointwiseMetricSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PointwiseMetricSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static PointwiseMetricSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PointwiseMetricSpec	parseFrom(InputStream input)
static PointwiseMetricSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PointwiseMetricSpec>	parser()
PointwiseMetricSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

METRIC_PROMPT_TEMPLATE_FIELD_NUMBER

public static final int METRIC_PROMPT_TEMPLATE_FIELD_NUMBER

See Also:

Constant Field Values

SYSTEM_INSTRUCTION_FIELD_NUMBER

public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOM_OUTPUT_FORMAT_CONFIG_FIELD_NUMBER

public static final int CUSTOM_OUTPUT_FORMAT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasMetricPromptTemplate

public boolean hasMetricPromptTemplate()

 Required. Metric prompt template for pointwise metric.
 

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

Specified by:

hasMetricPromptTemplate in interface PointwiseMetricSpecOrBuilder

Returns:

Whether the metricPromptTemplate field is set.

getMetricPromptTemplate

public String getMetricPromptTemplate()

 Required. Metric prompt template for pointwise metric.
 

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

Specified by:

getMetricPromptTemplate in interface PointwiseMetricSpecOrBuilder

Returns:

The metricPromptTemplate.

getMetricPromptTemplateBytes

public com.google.protobuf.ByteString getMetricPromptTemplateBytes()

 Required. Metric prompt template for pointwise metric.
 

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

Specified by:

getMetricPromptTemplateBytes in interface PointwiseMetricSpecOrBuilder

Returns:

The bytes for metricPromptTemplate.

hasSystemInstruction

public boolean hasSystemInstruction()

 Optional. System instructions for pointwise metric.
 

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

Specified by:

hasSystemInstruction in interface PointwiseMetricSpecOrBuilder

Returns:

Whether the systemInstruction field is set.

getSystemInstruction

public String getSystemInstruction()

 Optional. System instructions for pointwise metric.
 

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

Specified by:

getSystemInstruction in interface PointwiseMetricSpecOrBuilder

Returns:

The systemInstruction.

getSystemInstructionBytes

public com.google.protobuf.ByteString getSystemInstructionBytes()

 Optional. System instructions for pointwise metric.
 

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

Specified by:

getSystemInstructionBytes in interface PointwiseMetricSpecOrBuilder

Returns:

The bytes for systemInstruction.

hasCustomOutputFormatConfig

public boolean hasCustomOutputFormatConfig()

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasCustomOutputFormatConfig in interface PointwiseMetricSpecOrBuilder

Returns:

Whether the customOutputFormatConfig field is set.

getCustomOutputFormatConfig

public CustomOutputFormatConfig getCustomOutputFormatConfig()

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomOutputFormatConfig in interface PointwiseMetricSpecOrBuilder

Returns:

The customOutputFormatConfig.

getCustomOutputFormatConfigOrBuilder

public CustomOutputFormatConfigOrBuilder getCustomOutputFormatConfigOrBuilder()

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomOutputFormatConfigOrBuilder in interface PointwiseMetricSpecOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static PointwiseMetricSpec parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PointwiseMetricSpec parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PointwiseMetricSpec parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PointwiseMetricSpec parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PointwiseMetricSpec parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PointwiseMetricSpec parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PointwiseMetricSpec parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static PointwiseMetricSpec parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static PointwiseMetricSpec parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static PointwiseMetricSpec parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static PointwiseMetricSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static PointwiseMetricSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public PointwiseMetricSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PointwiseMetricSpec.Builder newBuilder()

newBuilder

public static PointwiseMetricSpec.Builder newBuilder(PointwiseMetricSpec prototype)

toBuilder

public PointwiseMetricSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PointwiseMetricSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PointwiseMetricSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<PointwiseMetricSpec> parser()

getParserForType

public com.google.protobuf.Parser<PointwiseMetricSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public PointwiseMetricSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder