Package org.mlflow.api.proto

Interface Service.TraceInfoV3OrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Service.TraceInfoV3, Service.TraceInfoV3.Builder
    Enclosing class:
    Service
    public static interface Service.TraceInfoV3OrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasTraceId

        boolean hasTraceId()
         The primary key associated with the trace
        optional string trace_id = 1;
        Returns:
        Whether the traceId field is set.

      • getTraceId

        java.lang.String getTraceId()
         The primary key associated with the trace
        optional string trace_id = 1;
        Returns:
        The traceId.

      • getTraceIdBytes

        com.google.protobuf.ByteString getTraceIdBytes()
         The primary key associated with the trace
        optional string trace_id = 1;
        Returns:
        The bytes for traceId.

      • hasClientRequestId

        boolean hasClientRequestId()
         Client supplied request ID associated with the trace. This could be used to identify the trace/request from an
 external system that produced the trace.
        optional string client_request_id = 2;
        Returns:
        Whether the clientRequestId field is set.

      • getClientRequestId

        java.lang.String getClientRequestId()
         Client supplied request ID associated with the trace. This could be used to identify the trace/request from an
 external system that produced the trace.
        optional string client_request_id = 2;
        Returns:
        The clientRequestId.

      • getClientRequestIdBytes

        com.google.protobuf.ByteString getClientRequestIdBytes()
         Client supplied request ID associated with the trace. This could be used to identify the trace/request from an
 external system that produced the trace.
        optional string client_request_id = 2;
        Returns:
        The bytes for clientRequestId.

      • hasTraceLocation

        boolean hasTraceLocation()
        optional .mlflow.TraceLocation trace_location = 3;
        Returns:
        Whether the traceLocation field is set.

      • getTraceLocation

        Service.TraceLocation getTraceLocation()
        optional .mlflow.TraceLocation trace_location = 3;
        Returns:
        The traceLocation.

      • hasRequest

        boolean hasRequest()
         Request to the model/agent.
 Equivalent to the input of the root span but added for ease of access.
 Represented as a JSON string.
        optional string request = 4;
        Returns:
        Whether the request field is set.

      • getRequest

        java.lang.String getRequest()
         Request to the model/agent.
 Equivalent to the input of the root span but added for ease of access.
 Represented as a JSON string.
        optional string request = 4;
        Returns:
        The request.

      • getRequestBytes

        com.google.protobuf.ByteString getRequestBytes()
         Request to the model/agent.
 Equivalent to the input of the root span but added for ease of access.
 Represented as a JSON string.
        optional string request = 4;
        Returns:
        The bytes for request.

      • hasResponse

        boolean hasResponse()
         Response of the model/agent.
 Equivalent to the output of the root span but added for ease of access.
 Represented as a JSON string.
        optional string response = 5;
        Returns:
        Whether the response field is set.

      • getResponse

        java.lang.String getResponse()
         Response of the model/agent.
 Equivalent to the output of the root span but added for ease of access.
 Represented as a JSON string.
        optional string response = 5;
        Returns:
        The response.

      • getResponseBytes

        com.google.protobuf.ByteString getResponseBytes()
         Response of the model/agent.
 Equivalent to the output of the root span but added for ease of access.
 Represented as a JSON string.
        optional string response = 5;
        Returns:
        The bytes for response.

      • hasRequestTime

        boolean hasRequestTime()
         Start time of the trace
        optional .google.protobuf.Timestamp request_time = 6;
        Returns:
        Whether the requestTime field is set.

      • getRequestTime

        com.google.protobuf.Timestamp getRequestTime()
         Start time of the trace
        optional .google.protobuf.Timestamp request_time = 6;
        Returns:
        The requestTime.

      • getRequestTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getRequestTimeOrBuilder()
         Start time of the trace
        optional .google.protobuf.Timestamp request_time = 6;

      • hasExecutionDuration

        boolean hasExecutionDuration()
         Execution time of the trace
        optional .google.protobuf.Duration execution_duration = 7;
        Returns:
        Whether the executionDuration field is set.

      • getExecutionDuration

        com.google.protobuf.Duration getExecutionDuration()
         Execution time of the trace
        optional .google.protobuf.Duration execution_duration = 7;
        Returns:
        The executionDuration.

      • getExecutionDurationOrBuilder

        com.google.protobuf.DurationOrBuilder getExecutionDurationOrBuilder()
         Execution time of the trace
        optional .google.protobuf.Duration execution_duration = 7;

      • hasState

        boolean hasState()
        optional .mlflow.TraceInfoV3.State state = 8;
        Returns:
        Whether the state field is set.

      • getTraceMetadataCount

        int getTraceMetadataCount()
         Metadata associated with the trace.
 Examples include:
 - run_id: The ID of the mlflow Run (i.e. evaluation job) that produced the trace. May not be
           applicable in certain situations such as if the trace was created via interactive vibe checks)
 - model_id: The ID of the associated model that produced the trace.
 - dataset_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - dataset_record_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - session_id: The ID of the session (e.g. chat conversation) where the request came from
        map<string, string> trace_metadata = 9;

      • containsTraceMetadata

        boolean containsTraceMetadata​(java.lang.String key)
         Metadata associated with the trace.
 Examples include:
 - run_id: The ID of the mlflow Run (i.e. evaluation job) that produced the trace. May not be
           applicable in certain situations such as if the trace was created via interactive vibe checks)
 - model_id: The ID of the associated model that produced the trace.
 - dataset_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - dataset_record_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - session_id: The ID of the session (e.g. chat conversation) where the request came from
        map<string, string> trace_metadata = 9;

      • getTraceMetadata

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

      • getTraceMetadataMap

        java.util.Map<java.lang.String,​java.lang.String> getTraceMetadataMap()
         Metadata associated with the trace.
 Examples include:
 - run_id: The ID of the mlflow Run (i.e. evaluation job) that produced the trace. May not be
           applicable in certain situations such as if the trace was created via interactive vibe checks)
 - model_id: The ID of the associated model that produced the trace.
 - dataset_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - dataset_record_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - session_id: The ID of the session (e.g. chat conversation) where the request came from
        map<string, string> trace_metadata = 9;

      • getTraceMetadataOrDefault

        java.lang.String getTraceMetadataOrDefault​(java.lang.String key,
                                           java.lang.String defaultValue)
         Metadata associated with the trace.
 Examples include:
 - run_id: The ID of the mlflow Run (i.e. evaluation job) that produced the trace. May not be
           applicable in certain situations such as if the trace was created via interactive vibe checks)
 - model_id: The ID of the associated model that produced the trace.
 - dataset_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - dataset_record_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - session_id: The ID of the session (e.g. chat conversation) where the request came from
        map<string, string> trace_metadata = 9;

      • getTraceMetadataOrThrow

        java.lang.String getTraceMetadataOrThrow​(java.lang.String key)
         Metadata associated with the trace.
 Examples include:
 - run_id: The ID of the mlflow Run (i.e. evaluation job) that produced the trace. May not be
           applicable in certain situations such as if the trace was created via interactive vibe checks)
 - model_id: The ID of the associated model that produced the trace.
 - dataset_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - dataset_record_id: The ID of the mlflow Dataset (usually used together with dataset_record_id)
 - session_id: The ID of the session (e.g. chat conversation) where the request came from
        map<string, string> trace_metadata = 9;

      • getAssessmentsList

        java.util.List<Service.Assessment> getAssessmentsList()
        repeated .mlflow.Assessment assessments = 10;

      • getAssessments

        Service.Assessment getAssessments​(int index)
        repeated .mlflow.Assessment assessments = 10;

      • getAssessmentsCount

        int getAssessmentsCount()
        repeated .mlflow.Assessment assessments = 10;

      • getAssessmentsOrBuilderList

        java.util.List<? extends Service.AssessmentOrBuilder> getAssessmentsOrBuilderList()
        repeated .mlflow.Assessment assessments = 10;

      • getAssessmentsOrBuilder

        Service.AssessmentOrBuilder getAssessmentsOrBuilder​(int index)
        repeated .mlflow.Assessment assessments = 10;

      • getTagsCount

        int getTagsCount()
         Mutable, user-defined tags for the trace, e.g. “question_topic”: “DBSQL”
        map<string, string> tags = 11;

      • containsTags

        boolean containsTags​(java.lang.String key)
         Mutable, user-defined tags for the trace, e.g. “question_topic”: “DBSQL”
        map<string, string> tags = 11;

      • getTags

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

      • getTagsMap

        java.util.Map<java.lang.String,​java.lang.String> getTagsMap()
         Mutable, user-defined tags for the trace, e.g. “question_topic”: “DBSQL”
        map<string, string> tags = 11;

      • getTagsOrDefault

        java.lang.String getTagsOrDefault​(java.lang.String key,
                                  java.lang.String defaultValue)
         Mutable, user-defined tags for the trace, e.g. “question_topic”: “DBSQL”
        map<string, string> tags = 11;

      • getTagsOrThrow

        java.lang.String getTagsOrThrow​(java.lang.String key)
         Mutable, user-defined tags for the trace, e.g. “question_topic”: “DBSQL”
        map<string, string> tags = 11;