Package com.google.cloud.aiplatform.v1beta1

Class CustomCodeExecutionSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.CustomCodeExecutionSpec
All Implemented Interfaces:
CustomCodeExecutionSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CustomCodeExecutionSpec extends com.google.protobuf.GeneratedMessage implements CustomCodeExecutionSpecOrBuilder
 Specificies a metric that is populated by evaluating user-defined Python
 code.
Protobuf type google.cloud.aiplatform.v1beta1.CustomCodeExecutionSpec
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CustomCodeExecutionSpec.Builder
    Specificies a metric that is populated by evaluating user-defined Python code.

    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
    EVALUATION_FUNCTION_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)
     
    static CustomCodeExecutionSpec
    getDefaultInstance()
     
    CustomCodeExecutionSpec
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEvaluationFunction()
    Required.
    com.google.protobuf.ByteString
    getEvaluationFunctionBytes()
    Required.
    com.google.protobuf.Parser<CustomCodeExecutionSpec>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasEvaluationFunction()
    Required.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CustomCodeExecutionSpec.Builder
    newBuilder()
     
    static CustomCodeExecutionSpec.Builder
    newBuilder(CustomCodeExecutionSpec prototype)
     
    CustomCodeExecutionSpec.Builder
    newBuilderForType()
     
    protected CustomCodeExecutionSpec.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CustomCodeExecutionSpec
    parseDelimitedFrom(InputStream input)
     
    static CustomCodeExecutionSpec
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomCodeExecutionSpec
    parseFrom(byte[] data)
     
    static CustomCodeExecutionSpec
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomCodeExecutionSpec
    parseFrom(com.google.protobuf.ByteString data)
     
    static CustomCodeExecutionSpec
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomCodeExecutionSpec
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CustomCodeExecutionSpec
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomCodeExecutionSpec
    parseFrom(InputStream input)
     
    static CustomCodeExecutionSpec
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomCodeExecutionSpec
    parseFrom(ByteBuffer data)
     
    static CustomCodeExecutionSpec
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CustomCodeExecutionSpec>
    parser()
     
    CustomCodeExecutionSpec.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

    • EVALUATION_FUNCTION_FIELD_NUMBER

      public static final int EVALUATION_FUNCTION_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

    • hasEvaluationFunction

      public boolean hasEvaluationFunction()
       Required. Python function.
 Expected user to define the following function, e.g.:
 def evaluate(instance: dict[str, Any]) -> float:
 Please include this function signature in the code snippet.
 Instance is the evaluation instance, any fields populated in the instance
 are available to the function as instance[field_name].

 Example:
 Example input:
 ```
 instance= EvaluationInstance(
 response=EvaluationInstance.InstanceData(text="The answer is 4."),
 reference=EvaluationInstance.InstanceData(text="4")
 )
 ```

 Example converted input:
 ```
 {
 'response': {'text': 'The answer is 4.'},
 'reference': {'text': '4'}
 }
 ```

 Example python function:
 ```
 def evaluate(instance: dict[str, Any]) -> float:
 if instance['response']['text'] == instance['reference']['text']:
 return 1.0
 return 0.0
 ```

 CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset
 RPC) and Tuning Evaluation. Each line in the input jsonl file will be
 converted to dict[str, Any] and passed to the evaluation function.
      optional string evaluation_function = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasEvaluationFunction in interface CustomCodeExecutionSpecOrBuilder
      Returns:
      Whether the evaluationFunction field is set.

    • getEvaluationFunction

      public String getEvaluationFunction()
       Required. Python function.
 Expected user to define the following function, e.g.:
 def evaluate(instance: dict[str, Any]) -> float:
 Please include this function signature in the code snippet.
 Instance is the evaluation instance, any fields populated in the instance
 are available to the function as instance[field_name].

 Example:
 Example input:
 ```
 instance= EvaluationInstance(
 response=EvaluationInstance.InstanceData(text="The answer is 4."),
 reference=EvaluationInstance.InstanceData(text="4")
 )
 ```

 Example converted input:
 ```
 {
 'response': {'text': 'The answer is 4.'},
 'reference': {'text': '4'}
 }
 ```

 Example python function:
 ```
 def evaluate(instance: dict[str, Any]) -> float:
 if instance['response']['text'] == instance['reference']['text']:
 return 1.0
 return 0.0
 ```

 CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset
 RPC) and Tuning Evaluation. Each line in the input jsonl file will be
 converted to dict[str, Any] and passed to the evaluation function.
      optional string evaluation_function = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEvaluationFunction in interface CustomCodeExecutionSpecOrBuilder
      Returns:
      The evaluationFunction.

    • getEvaluationFunctionBytes

      public com.google.protobuf.ByteString getEvaluationFunctionBytes()
       Required. Python function.
 Expected user to define the following function, e.g.:
 def evaluate(instance: dict[str, Any]) -> float:
 Please include this function signature in the code snippet.
 Instance is the evaluation instance, any fields populated in the instance
 are available to the function as instance[field_name].

 Example:
 Example input:
 ```
 instance= EvaluationInstance(
 response=EvaluationInstance.InstanceData(text="The answer is 4."),
 reference=EvaluationInstance.InstanceData(text="4")
 )
 ```

 Example converted input:
 ```
 {
 'response': {'text': 'The answer is 4.'},
 'reference': {'text': '4'}
 }
 ```

 Example python function:
 ```
 def evaluate(instance: dict[str, Any]) -> float:
 if instance['response']['text'] == instance['reference']['text']:
 return 1.0
 return 0.0
 ```

 CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset
 RPC) and Tuning Evaluation. Each line in the input jsonl file will be
 converted to dict[str, Any] and passed to the evaluation function.
      optional string evaluation_function = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEvaluationFunctionBytes in interface CustomCodeExecutionSpecOrBuilder
      Returns:
      The bytes for evaluationFunction.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CustomCodeExecutionSpec.Builder newBuilder()

    • newBuilder

      public static CustomCodeExecutionSpec.Builder newBuilder(CustomCodeExecutionSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CustomCodeExecutionSpec getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CustomCodeExecutionSpec> 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 CustomCodeExecutionSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder