Package org.mlflow.api.proto

Class Assessments.Expectation

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Assessments.ExpectationOrBuilder
    Enclosing class:
    Assessments
    public static final class Assessments.Expectation
extends com.google.protobuf.GeneratedMessageV3
implements Assessments.ExpectationOrBuilder
     An expectation for the values or guidelines for the outputs that a model or agent should produce
 from the inputs contained in the trace.
    Protobuf type mlflow.assessments.Expectation
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Assessments.Expectation.Builder
      An expectation for the values or guidelines for the outputs that a model or agent should produce from the inputs contained in the trace.
      static class  Assessments.Expectation.SerializedValue
      Protobuf type mlflow.assessments.Expectation.SerializedValue
      static interface  Assessments.Expectation.SerializedValueOrBuilder  

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 Description
      static com.google.protobuf.Parser<Assessments.Expectation> PARSER
      Deprecated.
      static int SERIALIZED_VALUE_FIELD_NUMBER  
      static int VALUE_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 Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasValue

        public boolean hasValue()
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;
        Specified by:
        hasValue in interface Assessments.ExpectationOrBuilder
        Returns:
        Whether the value field is set.

      • getValue

        public com.google.protobuf.Value getValue()
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;
        Specified by:
        getValue in interface Assessments.ExpectationOrBuilder
        Returns:
        The value.

      • getValueOrBuilder

        public com.google.protobuf.ValueOrBuilder getValueOrBuilder()
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;
        Specified by:
        getValueOrBuilder in interface Assessments.ExpectationOrBuilder

      • hasSerializedValue

        public boolean hasSerializedValue()
         The value of the expecation-based assessment serialized as a string in a specified format. Only one of either 
 ``serialized_value`` or ``value`` may be defined.
        optional .mlflow.assessments.Expectation.SerializedValue serialized_value = 3;
        Specified by:
        hasSerializedValue in interface Assessments.ExpectationOrBuilder
        Returns:
        Whether the serializedValue field is set.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 Assessments.Expectation parseFrom​(java.nio.ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Assessments.Expectation parseFrom​(java.nio.ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Assessments.Expectation parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Assessments.Expectation parseFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Assessments.Expectation parseFrom​(java.io.InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Assessments.Expectation parseDelimitedFrom​(java.io.InputStream input)
                                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Assessments.Expectation parseDelimitedFrom​(java.io.InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Assessments.Expectation parseFrom​(com.google.protobuf.CodedInputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Assessments.Expectation parseFrom​(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Assessments.Expectation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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