Package org.mlflow.api.proto

Class Service.Assessment.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, Service.AssessmentOrBuilder
    Enclosing class:
    Service.Assessment
    public static final class Service.Assessment.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>
implements Service.AssessmentOrBuilder
     Data and metadata for an assessment of a trace.
    Protobuf type mlflow.Assessment

    • Method Detail

      • 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.Builder<Service.Assessment.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • clear

        public Service.Assessment.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Service.Assessment.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • setField

        public Service.Assessment.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • clearField

        public Service.Assessment.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • clearOneof

        public Service.Assessment.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • setRepeatedField

        public Service.Assessment.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • addRepeatedField

        public Service.Assessment.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • mergeFrom

        public Service.Assessment.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Service.Assessment.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • mergeFrom

        public Service.Assessment.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Service.Assessment.Builder>
        Throws:
        java.io.IOException

      • 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 Service.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 Service.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 Service.AssessmentOrBuilder
        Returns:
        The bytes for assessmentId.

      • setAssessmentId

        public Service.Assessment.Builder setAssessmentId​(java.lang.String value)
         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;
        Parameters:
        value - The assessmentId to set.
        Returns:
        This builder for chaining.

      • clearAssessmentId

        public Service.Assessment.Builder clearAssessmentId()
         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:
        This builder for chaining.

      • setAssessmentIdBytes

        public Service.Assessment.Builder setAssessmentIdBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for assessmentId to set.
        Returns:
        This builder for chaining.

      • 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 Service.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 Service.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 Service.AssessmentOrBuilder
        Returns:
        The bytes for assessmentName.

      • setAssessmentName

        public Service.Assessment.Builder setAssessmentName​(java.lang.String value)
         Name of the assessment. The name must not contain ".".
        optional string assessment_name = 2 [(.mlflow.validate_required) = true];
        Parameters:
        value - The assessmentName to set.
        Returns:
        This builder for chaining.

      • clearAssessmentName

        public Service.Assessment.Builder clearAssessmentName()
         Name of the assessment. The name must not contain ".".
        optional string assessment_name = 2 [(.mlflow.validate_required) = true];
        Returns:
        This builder for chaining.

      • setAssessmentNameBytes

        public Service.Assessment.Builder setAssessmentNameBytes​(com.google.protobuf.ByteString value)
         Name of the assessment. The name must not contain ".".
        optional string assessment_name = 2 [(.mlflow.validate_required) = true];
        Parameters:
        value - The bytes for assessmentName to set.
        Returns:
        This builder for chaining.

      • hasTraceId

        public boolean hasTraceId()
         ID of the trace this assessment is associated with.
        optional string trace_id = 3;
        Specified by:
        hasTraceId in interface Service.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 Service.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 Service.AssessmentOrBuilder
        Returns:
        The bytes for traceId.

      • setTraceId

        public Service.Assessment.Builder setTraceId​(java.lang.String value)
         ID of the trace this assessment is associated with.
        optional string trace_id = 3;
        Parameters:
        value - The traceId to set.
        Returns:
        This builder for chaining.

      • clearTraceId

        public Service.Assessment.Builder clearTraceId()
         ID of the trace this assessment is associated with.
        optional string trace_id = 3;
        Returns:
        This builder for chaining.

      • setTraceIdBytes

        public Service.Assessment.Builder setTraceIdBytes​(com.google.protobuf.ByteString value)
         ID of the trace this assessment is associated with.
        optional string trace_id = 3;
        Parameters:
        value - The bytes for traceId to set.
        Returns:
        This builder for chaining.

      • 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 Service.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 Service.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 Service.AssessmentOrBuilder
        Returns:
        The bytes for spanId.

      • setSpanId

        public Service.Assessment.Builder setSpanId​(java.lang.String value)
         ID of the span if the assessment is for a particular span (optional).
        optional string span_id = 4;
        Parameters:
        value - The spanId to set.
        Returns:
        This builder for chaining.

      • clearSpanId

        public Service.Assessment.Builder clearSpanId()
         ID of the span if the assessment is for a particular span (optional).
        optional string span_id = 4;
        Returns:
        This builder for chaining.

      • setSpanIdBytes

        public Service.Assessment.Builder setSpanIdBytes​(com.google.protobuf.ByteString value)
         ID of the span if the assessment is for a particular span (optional).
        optional string span_id = 4;
        Parameters:
        value - The bytes for spanId to set.
        Returns:
        This builder for chaining.

      • hasSource

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

      • clearSource

        public Service.Assessment.Builder clearSource()
         The source this assessment came from.
        optional .mlflow.AssessmentSource source = 5;

      • getSourceBuilder

        public Service.AssessmentSource.Builder getSourceBuilder()
         The source this assessment came from.
        optional .mlflow.AssessmentSource source = 5;

      • hasCreateTime

        public boolean hasCreateTime()
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;
        Specified by:
        hasCreateTime in interface Service.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 Service.AssessmentOrBuilder
        Returns:
        The createTime.

      • setCreateTime

        public Service.Assessment.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;

      • setCreateTime

        public Service.Assessment.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;

      • mergeCreateTime

        public Service.Assessment.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;

      • clearCreateTime

        public Service.Assessment.Builder clearCreateTime()
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;

      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         The creation time of this assessment.
        optional .google.protobuf.Timestamp create_time = 6;

      • 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 Service.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 Service.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 Service.AssessmentOrBuilder
        Returns:
        The lastUpdateTime.

      • setLastUpdateTime

        public Service.Assessment.Builder setLastUpdateTime​(com.google.protobuf.Timestamp value)
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;

      • setLastUpdateTime

        public Service.Assessment.Builder setLastUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;

      • mergeLastUpdateTime

        public Service.Assessment.Builder mergeLastUpdateTime​(com.google.protobuf.Timestamp value)
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;

      • clearLastUpdateTime

        public Service.Assessment.Builder clearLastUpdateTime()
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;

      • getLastUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getLastUpdateTimeBuilder()
         The last update time of this assessment.
        optional .google.protobuf.Timestamp last_update_time = 7;

      • 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 Service.AssessmentOrBuilder

      • hasFeedback

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

      • clearFeedback

        public Service.Assessment.Builder clearFeedback()
         The feedback on the trace from this assessment.
        .mlflow.Feedback feedback = 9;

      • getFeedbackBuilder

        public Service.Feedback.Builder getFeedbackBuilder()
         The feedback on the trace from this assessment.
        .mlflow.Feedback feedback = 9;

      • hasExpectation

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

      • clearExpectation

        public Service.Assessment.Builder clearExpectation()
         A representation of the guidelines and/or expected response from the agent.
        .mlflow.Expectation expectation = 10;

      • getExpectationBuilder

        public Service.Expectation.Builder getExpectationBuilder()
         A representation of the guidelines and/or expected response from the agent.
        .mlflow.Expectation expectation = 10;

      • hasRationale

        public boolean hasRationale()
         Justification for the assessment.
        optional string rationale = 11;
        Specified by:
        hasRationale in interface Service.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 Service.AssessmentOrBuilder
        Returns:
        The rationale.

      • getRationaleBytes

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

      • setRationale

        public Service.Assessment.Builder setRationale​(java.lang.String value)
         Justification for the assessment.
        optional string rationale = 11;
        Parameters:
        value - The rationale to set.
        Returns:
        This builder for chaining.

      • clearRationale

        public Service.Assessment.Builder clearRationale()
         Justification for the assessment.
        optional string rationale = 11;
        Returns:
        This builder for chaining.

      • setRationaleBytes

        public Service.Assessment.Builder setRationaleBytes​(com.google.protobuf.ByteString value)
         Justification for the assessment.
        optional string rationale = 11;
        Parameters:
        value - The bytes for rationale to set.
        Returns:
        This builder for chaining.

      • hasError

        public boolean hasError()
         An error encountered while computing the assessment.
        optional .mlflow.AssessmentError error = 12;
        Specified by:
        hasError in interface Service.AssessmentOrBuilder
        Returns:
        Whether the error field is set.

      • clearError

        public Service.Assessment.Builder clearError()
         An error encountered while computing the assessment.
        optional .mlflow.AssessmentError error = 12;

      • getErrorBuilder

        public Service.AssessmentError.Builder getErrorBuilder()
         An error encountered while computing the assessment.
        optional .mlflow.AssessmentError error = 12;

      • getMetadataCount

        public int getMetadataCount()
        Description copied from interface: Service.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 Service.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 Service.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 Service.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 Service.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 Service.AssessmentOrBuilder

      • removeMetadata

        public Service.Assessment.Builder removeMetadata​(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;

      • getMutableMetadata

        @Deprecated
public java.util.Map<java.lang.String,​java.lang.String> getMutableMetadata()
        Deprecated.
        Use alternate mutation accessors instead.

      • putMetadata

        public Service.Assessment.Builder putMetadata​(java.lang.String key,
                                              java.lang.String value)
         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;

      • putAllMetadata

        public Service.Assessment.Builder putAllMetadata​(java.util.Map<java.lang.String,​java.lang.String> values)
         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;

      • setUnknownFields

        public final Service.Assessment.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>

      • mergeUnknownFields

        public final Service.Assessment.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.Assessment.Builder>