Package com.google.cloud.aiplatform.v1

Class AutoraterConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.AutoraterConfig
All Implemented Interfaces:
AutoraterConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AutoraterConfig extends com.google.protobuf.GeneratedMessage implements AutoraterConfigOrBuilder
 The configs for autorater. This is applicable to both EvaluateInstances and
 EvaluateDataset.
Protobuf type google.cloud.aiplatform.v1.AutoraterConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AutoraterConfig.Builder
    The configs for autorater.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AUTORATER_MODEL_FIELD_NUMBER
     
    static final int
    FLIP_ENABLED_FIELD_NUMBER
     
    static final int
    GENERATION_CONFIG_FIELD_NUMBER
     
    static final int
    SAMPLING_COUNT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    String
    getAutoraterModel()
    Optional.
    com.google.protobuf.ByteString
    getAutoraterModelBytes()
    Optional.
    static AutoraterConfig
    getDefaultInstance()
     
    AutoraterConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getFlipEnabled()
    Optional.
    GenerationConfig
    getGenerationConfig()
    Optional.
    GenerationConfigOrBuilder
    getGenerationConfigOrBuilder()
    Optional.
    com.google.protobuf.Parser<AutoraterConfig>
    getParserForType()
     
    int
    getSamplingCount()
    Optional.
    int
    getSerializedSize()
     
    boolean
    hasFlipEnabled()
    Optional.
    boolean
    hasGenerationConfig()
    Optional.
    int
    hashCode()
     
    boolean
    hasSamplingCount()
    Optional.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static AutoraterConfig.Builder
    newBuilder()
     
    static AutoraterConfig.Builder
    newBuilder(AutoraterConfig prototype)
     
    AutoraterConfig.Builder
    newBuilderForType()
     
    protected AutoraterConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static AutoraterConfig
    parseDelimitedFrom(InputStream input)
     
    static AutoraterConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutoraterConfig
    parseFrom(byte[] data)
     
    static AutoraterConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutoraterConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static AutoraterConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutoraterConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AutoraterConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutoraterConfig
    parseFrom(InputStream input)
     
    static AutoraterConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutoraterConfig
    parseFrom(ByteBuffer data)
     
    static AutoraterConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AutoraterConfig>
    parser()
     
    AutoraterConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • SAMPLING_COUNT_FIELD_NUMBER

      public static final int SAMPLING_COUNT_FIELD_NUMBER
      See Also:

    • FLIP_ENABLED_FIELD_NUMBER

      public static final int FLIP_ENABLED_FIELD_NUMBER
      See Also:

    • AUTORATER_MODEL_FIELD_NUMBER

      public static final int AUTORATER_MODEL_FIELD_NUMBER
      See Also:

    • GENERATION_CONFIG_FIELD_NUMBER

      public static final int GENERATION_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • 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

    • hasSamplingCount

      public boolean hasSamplingCount()
       Optional. Number of samples for each instance in the dataset.
 If not specified, the default is 4. Minimum value is 1, maximum value
 is 32.
      optional int32 sampling_count = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSamplingCount in interface AutoraterConfigOrBuilder
      Returns:
      Whether the samplingCount field is set.

    • getSamplingCount

      public int getSamplingCount()
       Optional. Number of samples for each instance in the dataset.
 If not specified, the default is 4. Minimum value is 1, maximum value
 is 32.
      optional int32 sampling_count = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSamplingCount in interface AutoraterConfigOrBuilder
      Returns:
      The samplingCount.

    • hasFlipEnabled

      public boolean hasFlipEnabled()
       Optional. Default is true. Whether to flip the candidate and baseline
 responses. This is only applicable to the pairwise metric. If enabled, also
 provide PairwiseMetricSpec.candidate_response_field_name and
 PairwiseMetricSpec.baseline_response_field_name. When rendering
 PairwiseMetricSpec.metric_prompt_template, the candidate and baseline
 fields will be flipped for half of the samples to reduce bias.
      optional bool flip_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasFlipEnabled in interface AutoraterConfigOrBuilder
      Returns:
      Whether the flipEnabled field is set.

    • getFlipEnabled

      public boolean getFlipEnabled()
       Optional. Default is true. Whether to flip the candidate and baseline
 responses. This is only applicable to the pairwise metric. If enabled, also
 provide PairwiseMetricSpec.candidate_response_field_name and
 PairwiseMetricSpec.baseline_response_field_name. When rendering
 PairwiseMetricSpec.metric_prompt_template, the candidate and baseline
 fields will be flipped for half of the samples to reduce bias.
      optional bool flip_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFlipEnabled in interface AutoraterConfigOrBuilder
      Returns:
      The flipEnabled.

    • getAutoraterModel

      public String getAutoraterModel()
       Optional. The fully qualified name of the publisher model or tuned
 autorater endpoint to use.

 Publisher model format:
 `projects/{project}/locations/{location}/publishers/*/models/*`

 Tuned model endpoint format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string autorater_model = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoraterModel in interface AutoraterConfigOrBuilder
      Returns:
      The autoraterModel.

    • getAutoraterModelBytes

      public com.google.protobuf.ByteString getAutoraterModelBytes()
       Optional. The fully qualified name of the publisher model or tuned
 autorater endpoint to use.

 Publisher model format:
 `projects/{project}/locations/{location}/publishers/*/models/*`

 Tuned model endpoint format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string autorater_model = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoraterModelBytes in interface AutoraterConfigOrBuilder
      Returns:
      The bytes for autoraterModel.

    • hasGenerationConfig

      public boolean hasGenerationConfig()
       Optional. Configuration options for model generation and outputs.
      .google.cloud.aiplatform.v1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasGenerationConfig in interface AutoraterConfigOrBuilder
      Returns:
      Whether the generationConfig field is set.

    • getGenerationConfig

      public GenerationConfig getGenerationConfig()
       Optional. Configuration options for model generation and outputs.
      .google.cloud.aiplatform.v1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGenerationConfig in interface AutoraterConfigOrBuilder
      Returns:
      The generationConfig.

    • getGenerationConfigOrBuilder

      public GenerationConfigOrBuilder getGenerationConfigOrBuilder()
       Optional. Configuration options for model generation and outputs.
      .google.cloud.aiplatform.v1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGenerationConfigOrBuilder in interface AutoraterConfigOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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 AutoraterConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static AutoraterConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static AutoraterConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static AutoraterConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static AutoraterConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static AutoraterConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public AutoraterConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AutoraterConfig.Builder newBuilder()

    • newBuilder

      public static AutoraterConfig.Builder newBuilder(AutoraterConfig prototype)

    • toBuilder

      public AutoraterConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AutoraterConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AutoraterConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<AutoraterConfig> 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.GeneratedMessage

    • getDefaultInstanceForType

      public AutoraterConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder