Package org.mlflow.api.proto

Class Assessments.Assessment

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Assessments.AssessmentOrBuilder
    Enclosing class:
    Assessments
    public static final class Assessments.Assessment
extends com.google.protobuf.GeneratedMessageV3
implements Assessments.AssessmentOrBuilder
     Data and metadata for an assessment of a trace.
    Protobuf type mlflow.assessments.Assessment
    See Also:
    Serialized Form

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasAssessmentId

        public boolean hasAssessmentId()
         Unique ID of the assessment.
 NB: This is not marked as required field via "validate_required", because the message is
  used in the context of creating a new assessment, where the ID is not known.
        optional string assessment_id = 1;
        Specified by:
        hasAssessmentId in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the assessmentId field is set.

      • getAssessmentId

        public java.lang.String getAssessmentId()
         Unique ID of the assessment.
 NB: This is not marked as required field via "validate_required", because the message is
  used in the context of creating a new assessment, where the ID is not known.
        optional string assessment_id = 1;
        Specified by:
        getAssessmentId in interface Assessments.AssessmentOrBuilder
        Returns:
        The assessmentId.

      • getAssessmentIdBytes

        public com.google.protobuf.ByteString getAssessmentIdBytes()
         Unique ID of the assessment.
 NB: This is not marked as required field via "validate_required", because the message is
  used in the context of creating a new assessment, where the ID is not known.
        optional string assessment_id = 1;
        Specified by:
        getAssessmentIdBytes in interface Assessments.AssessmentOrBuilder
        Returns:
        The bytes for assessmentId.

      • hasAssessmentName

        public boolean hasAssessmentName()
         Name of the assessment. The name must not contain ".".
        optional string assessment_name = 2 [(.mlflow.validate_required) = true];
        Specified by:
        hasAssessmentName in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the assessmentName field is set.

      • getAssessmentName

        public java.lang.String getAssessmentName()
         Name of the assessment. The name must not contain ".".
        optional string assessment_name = 2 [(.mlflow.validate_required) = true];
        Specified by:
        getAssessmentName in interface Assessments.AssessmentOrBuilder
        Returns:
        The assessmentName.

      • getAssessmentNameBytes

        public com.google.protobuf.ByteString getAssessmentNameBytes()
         Name of the assessment. The name must not contain ".".
        optional string assessment_name = 2 [(.mlflow.validate_required) = true];
        Specified by:
        getAssessmentNameBytes in interface Assessments.AssessmentOrBuilder
        Returns:
        The bytes for assessmentName.

      • hasTraceId

        public boolean hasTraceId()
         ID of the trace this assessment is associated with.
        optional string trace_id = 3;
        Specified by:
        hasTraceId in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the traceId field is set.

      • getTraceId

        public java.lang.String getTraceId()
         ID of the trace this assessment is associated with.
        optional string trace_id = 3;
        Specified by:
        getTraceId in interface Assessments.AssessmentOrBuilder
        Returns:
        The traceId.

      • getTraceIdBytes

        public com.google.protobuf.ByteString getTraceIdBytes()
         ID of the trace this assessment is associated with.
        optional string trace_id = 3;
        Specified by:
        getTraceIdBytes in interface Assessments.AssessmentOrBuilder
        Returns:
        The bytes for traceId.

      • hasSpanId

        public boolean hasSpanId()
         ID of the span if the assessment is for a particular span (optional).
        optional string span_id = 4;
        Specified by:
        hasSpanId in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the spanId field is set.

      • getSpanId

        public java.lang.String getSpanId()
         ID of the span if the assessment is for a particular span (optional).
        optional string span_id = 4;
        Specified by:
        getSpanId in interface Assessments.AssessmentOrBuilder
        Returns:
        The spanId.

      • getSpanIdBytes

        public com.google.protobuf.ByteString getSpanIdBytes()
         ID of the span if the assessment is for a particular span (optional).
        optional string span_id = 4;
        Specified by:
        getSpanIdBytes in interface Assessments.AssessmentOrBuilder
        Returns:
        The bytes for spanId.

      • hasSource

        public boolean hasSource()
         The source this assessment came from.
        optional .mlflow.assessments.AssessmentSource source = 5;
        Specified by:
        hasSource in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the source field is set.

      • hasCreateTime

        public boolean hasCreateTime()
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;
        Specified by:
        hasCreateTime in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;
        Specified by:
        getCreateTime in interface Assessments.AssessmentOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;
        Specified by:
        getCreateTimeOrBuilder in interface Assessments.AssessmentOrBuilder

      • hasLastUpdateTime

        public boolean hasLastUpdateTime()
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;
        Specified by:
        hasLastUpdateTime in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the lastUpdateTime field is set.

      • getLastUpdateTime

        public com.google.protobuf.Timestamp getLastUpdateTime()
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;
        Specified by:
        getLastUpdateTime in interface Assessments.AssessmentOrBuilder
        Returns:
        The lastUpdateTime.

      • getLastUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getLastUpdateTimeOrBuilder()
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;
        Specified by:
        getLastUpdateTimeOrBuilder in interface Assessments.AssessmentOrBuilder

      • hasFeedback

        public boolean hasFeedback()
         The feedback on the trace from this assessment.
        .mlflow.assessments.Feedback feedback = 9;
        Specified by:
        hasFeedback in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the feedback field is set.

      • hasExpectation

        public boolean hasExpectation()
         A representation of the guidelines and/or expected response from the agent.
        .mlflow.assessments.Expectation expectation = 10;
        Specified by:
        hasExpectation in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the expectation field is set.

      • hasRationale

        public boolean hasRationale()
         Justification for the assessment.
        optional string rationale = 11;
        Specified by:
        hasRationale in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the rationale field is set.

      • getRationale

        public java.lang.String getRationale()
         Justification for the assessment.
        optional string rationale = 11;
        Specified by:
        getRationale in interface Assessments.AssessmentOrBuilder
        Returns:
        The rationale.

      • getRationaleBytes

        public com.google.protobuf.ByteString getRationaleBytes()
         Justification for the assessment.
        optional string rationale = 11;
        Specified by:
        getRationaleBytes in interface Assessments.AssessmentOrBuilder
        Returns:
        The bytes for rationale.

      • hasError

        @Deprecated
public boolean hasError()
        Deprecated.
         [Deprecated, use the ``error`` field in ``feedback`` instead]
 An error encountered while computing the assessment.
        optional .mlflow.assessments.AssessmentError error = 12 [deprecated = true];
        Specified by:
        hasError in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the error field is set.

      • getError

        @Deprecated
public Assessments.AssessmentError getError()
        Deprecated.
         [Deprecated, use the ``error`` field in ``feedback`` instead]
 An error encountered while computing the assessment.
        optional .mlflow.assessments.AssessmentError error = 12 [deprecated = true];
        Specified by:
        getError in interface Assessments.AssessmentOrBuilder
        Returns:
        The error.

      • getMetadataCount

        public int getMetadataCount()
        Description copied from interface: Assessments.AssessmentOrBuilder
         Additional metadata describing the assessment and store additional information,
 such as the chunk relevance chunk_index. This metadata is required to be JSON-serializable.
        map<string, string> metadata = 13;
        Specified by:
        getMetadataCount in interface Assessments.AssessmentOrBuilder

      • containsMetadata

        public boolean containsMetadata​(java.lang.String key)
         Additional metadata describing the assessment and store additional information,
 such as the chunk relevance chunk_index. This metadata is required to be JSON-serializable.
        map<string, string> metadata = 13;
        Specified by:
        containsMetadata in interface Assessments.AssessmentOrBuilder

      • getMetadataMap

        public java.util.Map<java.lang.String,​java.lang.String> getMetadataMap()
         Additional metadata describing the assessment and store additional information,
 such as the chunk relevance chunk_index. This metadata is required to be JSON-serializable.
        map<string, string> metadata = 13;
        Specified by:
        getMetadataMap in interface Assessments.AssessmentOrBuilder

      • getMetadataOrDefault

        public java.lang.String getMetadataOrDefault​(java.lang.String key,
                                             java.lang.String defaultValue)
         Additional metadata describing the assessment and store additional information,
 such as the chunk relevance chunk_index. This metadata is required to be JSON-serializable.
        map<string, string> metadata = 13;
        Specified by:
        getMetadataOrDefault in interface Assessments.AssessmentOrBuilder

      • getMetadataOrThrow

        public java.lang.String getMetadataOrThrow​(java.lang.String key)
         Additional metadata describing the assessment and store additional information,
 such as the chunk relevance chunk_index. This metadata is required to be JSON-serializable.
        map<string, string> metadata = 13;
        Specified by:
        getMetadataOrThrow in interface Assessments.AssessmentOrBuilder

      • hasOverrides

        public boolean hasOverrides()
         The ID of the assessment which this assessment overrides.
        optional string overrides = 14;
        Specified by:
        hasOverrides in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the overrides field is set.

      • getOverrides

        public java.lang.String getOverrides()
         The ID of the assessment which this assessment overrides.
        optional string overrides = 14;
        Specified by:
        getOverrides in interface Assessments.AssessmentOrBuilder
        Returns:
        The overrides.

      • getOverridesBytes

        public com.google.protobuf.ByteString getOverridesBytes()
         The ID of the assessment which this assessment overrides.
        optional string overrides = 14;
        Specified by:
        getOverridesBytes in interface Assessments.AssessmentOrBuilder
        Returns:
        The bytes for overrides.

      • hasValid

        public boolean hasValid()
         Whether this assessment is valid (i.e. has not been superseded)
 defaults to true, and is set to false if a new superseding assessment
 is created.
        optional bool valid = 15 [default = true];
        Specified by:
        hasValid in interface Assessments.AssessmentOrBuilder
        Returns:
        Whether the valid field is set.

      • getValid

        public boolean getValid()
         Whether this assessment is valid (i.e. has not been superseded)
 defaults to true, and is set to false if a new superseding assessment
 is created.
        optional bool valid = 15 [default = true];
        Specified by:
        getValid in interface Assessments.AssessmentOrBuilder
        Returns:
        The valid.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Assessments.Assessment 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.Assessment parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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