Package org.mlflow.api.proto

Interface Assessments.AssessmentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Assessments.Assessment, Assessments.Assessment.Builder
    Enclosing class:
    Assessments
    public static interface Assessments.AssessmentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasAssessmentId

        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;
        Returns:
        Whether the assessmentId field is set.

      • getAssessmentId

        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;
        Returns:
        The assessmentId.

      • getAssessmentIdBytes

        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;
        Returns:
        The bytes for assessmentId.

      • hasAssessmentName

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

      • getAssessmentName

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

      • getAssessmentNameBytes

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

      • hasTraceId

        boolean hasTraceId()
         ID of the trace this assessment is associated with.
        optional string trace_id = 3;
        Returns:
        Whether the traceId field is set.

      • getTraceId

        java.lang.String getTraceId()
         ID of the trace this assessment is associated with.
        optional string trace_id = 3;
        Returns:
        The traceId.

      • getTraceIdBytes

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

      • hasSpanId

        boolean hasSpanId()
         ID of the span if the assessment is for a particular span (optional).
        optional string span_id = 4;
        Returns:
        Whether the spanId field is set.

      • getSpanId

        java.lang.String getSpanId()
         ID of the span if the assessment is for a particular span (optional).
        optional string span_id = 4;
        Returns:
        The spanId.

      • getSpanIdBytes

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

      • hasSource

        boolean hasSource()
         The source this assessment came from.
        optional .mlflow.assessments.AssessmentSource source = 5;
        Returns:
        Whether the source field is set.

      • getSource

        Assessments.AssessmentSource getSource()
         The source this assessment came from.
        optional .mlflow.assessments.AssessmentSource source = 5;
        Returns:
        The source.

      • hasCreateTime

        boolean hasCreateTime()
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;

      • hasLastUpdateTime

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

      • getLastUpdateTime

        com.google.protobuf.Timestamp getLastUpdateTime()
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;
        Returns:
        The lastUpdateTime.

      • getLastUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getLastUpdateTimeOrBuilder()
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;

      • hasFeedback

        boolean hasFeedback()
         The feedback on the trace from this assessment.
        .mlflow.assessments.Feedback feedback = 9;
        Returns:
        Whether the feedback field is set.

      • getFeedback

        Assessments.Feedback getFeedback()
         The feedback on the trace from this assessment.
        .mlflow.assessments.Feedback feedback = 9;
        Returns:
        The feedback.

      • getFeedbackOrBuilder

        Assessments.FeedbackOrBuilder getFeedbackOrBuilder()
         The feedback on the trace from this assessment.
        .mlflow.assessments.Feedback feedback = 9;

      • hasExpectation

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

      • getExpectation

        Assessments.Expectation getExpectation()
         A representation of the guidelines and/or expected response from the agent.
        .mlflow.assessments.Expectation expectation = 10;
        Returns:
        The expectation.

      • getExpectationOrBuilder

        Assessments.ExpectationOrBuilder getExpectationOrBuilder()
         A representation of the guidelines and/or expected response from the agent.
        .mlflow.assessments.Expectation expectation = 10;

      • hasRationale

        boolean hasRationale()
         Justification for the assessment.
        optional string rationale = 11;
        Returns:
        Whether the rationale field is set.

      • getRationale

        java.lang.String getRationale()
         Justification for the assessment.
        optional string rationale = 11;
        Returns:
        The rationale.

      • getRationaleBytes

        com.google.protobuf.ByteString getRationaleBytes()
         Justification for the assessment.
        optional string rationale = 11;
        Returns:
        The bytes for rationale.

      • hasError

        @Deprecated
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];
        Returns:
        Whether the error field is set.

      • getError

        @Deprecated
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];
        Returns:
        The error.

      • getErrorOrBuilder

        @Deprecated
Assessments.AssessmentErrorOrBuilder getErrorOrBuilder()
        Deprecated.
         [Deprecated, use the ``error`` field in ``feedback`` instead]
 An error encountered while computing the assessment.
        optional .mlflow.assessments.AssessmentError error = 12 [deprecated = true];

      • getMetadataCount

        int getMetadataCount()
         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;

      • containsMetadata

        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;

      • getMetadata

        @Deprecated
java.util.Map<java.lang.String,​java.lang.String> getMetadata()
        Deprecated.
        Use getMetadataMap() instead.

      • getMetadataMap

        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;

      • getMetadataOrDefault

        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;

      • getMetadataOrThrow

        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;

      • hasOverrides

        boolean hasOverrides()
         The ID of the assessment which this assessment overrides.
        optional string overrides = 14;
        Returns:
        Whether the overrides field is set.

      • getOverrides

        java.lang.String getOverrides()
         The ID of the assessment which this assessment overrides.
        optional string overrides = 14;
        Returns:
        The overrides.

      • getOverridesBytes

        com.google.protobuf.ByteString getOverridesBytes()
         The ID of the assessment which this assessment overrides.
        optional string overrides = 14;
        Returns:
        The bytes for overrides.

      • hasValid

        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];
        Returns:
        Whether the valid field is set.

      • getValid

        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];
        Returns:
        The valid.