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 Details

    • hasTraceId

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

    • getTraceId

      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

      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.

    • getTraceLocationOrBuilder

      Service.TraceLocationOrBuilder getTraceLocationOrBuilder()
      optional .mlflow.TraceLocation trace_location = 3;

    • hasRequest

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

    • getRequest

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

    • getRequestBytes

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

    • hasResponse

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

    • getResponse

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

    • getResponseBytes

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

    • hasRequestPreview

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

    • getRequestPreview

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

    • getRequestPreviewBytes

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

    • hasResponsePreview

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

    • getResponsePreview

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

    • getResponsePreviewBytes

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

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

    • getState

      Service.TraceInfoV3.State getState()
      optional .mlflow.TraceInfoV3.State state = 8;
      Returns:
      The state.

    • 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(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 Map<String,String> getTraceMetadata()
      Deprecated.
      Use getTraceMetadataMap() instead.

    • getTraceMetadataMap

      Map<String,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

      String getTraceMetadataOrDefault(String key, 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

      String getTraceMetadataOrThrow(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

      List<Assessments.Assessment> getAssessmentsList()
      repeated .mlflow.assessments.Assessment assessments = 10;

    • getAssessments

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

    • getAssessmentsCount

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

    • getAssessmentsOrBuilderList

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

    • getAssessmentsOrBuilder

      Assessments.AssessmentOrBuilder getAssessmentsOrBuilder(int index)
      repeated .mlflow.assessments.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(String key)
       Mutable, user-defined tags for the trace, e.g. “question_topic”: “DBSQL”
      map<string, string> tags = 11;

    • getTags

      @Deprecated Map<String,String> getTags()
      Deprecated.
      Use getTagsMap() instead.

    • getTagsMap

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

    • getTagsOrDefault

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

    • getTagsOrThrow

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