Package org.mlflow.api.proto

Class Service.TraceInfoV3

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Service.TraceInfoV3OrBuilder
    Enclosing class:
    Service
    public static final class Service.TraceInfoV3
extends com.google.protobuf.GeneratedMessageV3
implements Service.TraceInfoV3OrBuilder
    Protobuf type mlflow.TraceInfoV3
    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

      • hasTraceId

        public boolean hasTraceId()
         The primary key associated with the trace
        optional string trace_id = 1;
        Specified by:
        hasTraceId in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the traceId field is set.

      • getTraceId

        public java.lang.String getTraceId()
         The primary key associated with the trace
        optional string trace_id = 1;
        Specified by:
        getTraceId in interface Service.TraceInfoV3OrBuilder
        Returns:
        The traceId.

      • getTraceIdBytes

        public com.google.protobuf.ByteString getTraceIdBytes()
         The primary key associated with the trace
        optional string trace_id = 1;
        Specified by:
        getTraceIdBytes in interface Service.TraceInfoV3OrBuilder
        Returns:
        The bytes for traceId.

      • hasClientRequestId

        public 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;
        Specified by:
        hasClientRequestId in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the clientRequestId field is set.

      • getClientRequestId

        public 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;
        Specified by:
        getClientRequestId in interface Service.TraceInfoV3OrBuilder
        Returns:
        The clientRequestId.

      • getClientRequestIdBytes

        public 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;
        Specified by:
        getClientRequestIdBytes in interface Service.TraceInfoV3OrBuilder
        Returns:
        The bytes for clientRequestId.

      • hasTraceLocation

        public boolean hasTraceLocation()
        optional .mlflow.TraceLocation trace_location = 3;
        Specified by:
        hasTraceLocation in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the traceLocation field is set.

      • hasRequest

        public boolean hasRequest()
         [Deprecated, please use `request_preview` instead.]
 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;
        Specified by:
        hasRequest in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the request field is set.

      • getRequest

        public java.lang.String getRequest()
         [Deprecated, please use `request_preview` instead.]
 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;
        Specified by:
        getRequest in interface Service.TraceInfoV3OrBuilder
        Returns:
        The request.

      • getRequestBytes

        public com.google.protobuf.ByteString getRequestBytes()
         [Deprecated, please use `request_preview` instead.]
 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;
        Specified by:
        getRequestBytes in interface Service.TraceInfoV3OrBuilder
        Returns:
        The bytes for request.

      • hasResponse

        public boolean hasResponse()
         [Deprecated, please use `request_preview` instead.]
 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;
        Specified by:
        hasResponse in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the response field is set.

      • getResponse

        public java.lang.String getResponse()
         [Deprecated, please use `request_preview` instead.]
 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;
        Specified by:
        getResponse in interface Service.TraceInfoV3OrBuilder
        Returns:
        The response.

      • getResponseBytes

        public com.google.protobuf.ByteString getResponseBytes()
         [Deprecated, please use `request_preview` instead.]
 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;
        Specified by:
        getResponseBytes in interface Service.TraceInfoV3OrBuilder
        Returns:
        The bytes for response.

      • hasRequestPreview

        public boolean hasRequestPreview()
         A preview of the request to the model/agent represented as a JSON string. This is equivalent to the input of the root
 span. This preview value is truncated to 10KB while the full request is stored in the trace data in blob storage.
        optional string request_preview = 12;
        Specified by:
        hasRequestPreview in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the requestPreview field is set.

      • getRequestPreview

        public java.lang.String getRequestPreview()
         A preview of the request to the model/agent represented as a JSON string. This is equivalent to the input of the root
 span. This preview value is truncated to 10KB while the full request is stored in the trace data in blob storage.
        optional string request_preview = 12;
        Specified by:
        getRequestPreview in interface Service.TraceInfoV3OrBuilder
        Returns:
        The requestPreview.

      • getRequestPreviewBytes

        public com.google.protobuf.ByteString getRequestPreviewBytes()
         A preview of the request to the model/agent represented as a JSON string. This is equivalent to the input of the root
 span. This preview value is truncated to 10KB while the full request is stored in the trace data in blob storage.
        optional string request_preview = 12;
        Specified by:
        getRequestPreviewBytes in interface Service.TraceInfoV3OrBuilder
        Returns:
        The bytes for requestPreview.

      • hasResponsePreview

        public boolean hasResponsePreview()
         A preview of the request to the model/agent represented as a JSON string. This is equivalent to the output of the root
 span. This preview value is truncated to 10KB while the full response is stored in the trace data in blob storage.
        optional string response_preview = 13;
        Specified by:
        hasResponsePreview in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the responsePreview field is set.

      • getResponsePreview

        public java.lang.String getResponsePreview()
         A preview of the request to the model/agent represented as a JSON string. This is equivalent to the output of the root
 span. This preview value is truncated to 10KB while the full response is stored in the trace data in blob storage.
        optional string response_preview = 13;
        Specified by:
        getResponsePreview in interface Service.TraceInfoV3OrBuilder
        Returns:
        The responsePreview.

      • getResponsePreviewBytes

        public com.google.protobuf.ByteString getResponsePreviewBytes()
         A preview of the request to the model/agent represented as a JSON string. This is equivalent to the output of the root
 span. This preview value is truncated to 10KB while the full response is stored in the trace data in blob storage.
        optional string response_preview = 13;
        Specified by:
        getResponsePreviewBytes in interface Service.TraceInfoV3OrBuilder
        Returns:
        The bytes for responsePreview.

      • hasRequestTime

        public boolean hasRequestTime()
         Start time of the trace
        optional .google.protobuf.Timestamp request_time = 6;
        Specified by:
        hasRequestTime in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the requestTime field is set.

      • getRequestTime

        public com.google.protobuf.Timestamp getRequestTime()
         Start time of the trace
        optional .google.protobuf.Timestamp request_time = 6;
        Specified by:
        getRequestTime in interface Service.TraceInfoV3OrBuilder
        Returns:
        The requestTime.

      • getRequestTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getRequestTimeOrBuilder()
         Start time of the trace
        optional .google.protobuf.Timestamp request_time = 6;
        Specified by:
        getRequestTimeOrBuilder in interface Service.TraceInfoV3OrBuilder

      • hasExecutionDuration

        public boolean hasExecutionDuration()
         Execution time of the trace
        optional .google.protobuf.Duration execution_duration = 7;
        Specified by:
        hasExecutionDuration in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the executionDuration field is set.

      • getExecutionDuration

        public com.google.protobuf.Duration getExecutionDuration()
         Execution time of the trace
        optional .google.protobuf.Duration execution_duration = 7;
        Specified by:
        getExecutionDuration in interface Service.TraceInfoV3OrBuilder
        Returns:
        The executionDuration.

      • getExecutionDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getExecutionDurationOrBuilder()
         Execution time of the trace
        optional .google.protobuf.Duration execution_duration = 7;
        Specified by:
        getExecutionDurationOrBuilder in interface Service.TraceInfoV3OrBuilder

      • hasState

        public boolean hasState()
        optional .mlflow.TraceInfoV3.State state = 8;
        Specified by:
        hasState in interface Service.TraceInfoV3OrBuilder
        Returns:
        Whether the state field is set.

      • getTraceMetadataCount

        public int getTraceMetadataCount()
        Description copied from interface: Service.TraceInfoV3OrBuilder
         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;
        Specified by:
        getTraceMetadataCount in interface Service.TraceInfoV3OrBuilder

      • containsTraceMetadata

        public 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;
        Specified by:
        containsTraceMetadata in interface Service.TraceInfoV3OrBuilder

      • getTraceMetadataMap

        public 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;
        Specified by:
        getTraceMetadataMap in interface Service.TraceInfoV3OrBuilder

      • getTraceMetadataOrDefault

        public 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;
        Specified by:
        getTraceMetadataOrDefault in interface Service.TraceInfoV3OrBuilder

      • getTraceMetadataOrThrow

        public 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;
        Specified by:
        getTraceMetadataOrThrow in interface Service.TraceInfoV3OrBuilder

      • containsTags

        public boolean containsTags​(java.lang.String key)
         Mutable, user-defined tags for the trace, e.g. "question_topic": "DBSQL"
        map<string, string> tags = 11;
        Specified by:
        containsTags in interface Service.TraceInfoV3OrBuilder

      • getTagsMap

        public 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;
        Specified by:
        getTagsMap in interface Service.TraceInfoV3OrBuilder

      • getTagsOrDefault

        public 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;
        Specified by:
        getTagsOrDefault in interface Service.TraceInfoV3OrBuilder

      • getTagsOrThrow

        public 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;
        Specified by:
        getTagsOrThrow in interface Service.TraceInfoV3OrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Service.TraceInfoV3 parseFrom​(java.io.InputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static Service.TraceInfoV3 parseDelimitedFrom​(java.io.InputStream input)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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