Skip to main content

Issue

View as Markdown

A quality or operational problem found in an experiment's traces.

Issue object​

A quality or operational problem found in an experiment's traces.

namestringBetaIDImmutable

experiments/{experiment}/issues/{issue}

issue_idstringBetaOutput only

The last segment of name. Issue assessments on traces reference the Issue by this ID.

titlestringBeta

Non-empty, at most 250 UTF-8 bytes.

descriptionstringBeta

Markdown, at most 32 KiB.

statusstringBeta

Defaults to PENDING on create, and can't be cleared.

Values:

  • PENDING
  • RESOLVED
  • REJECTED
severitystringBeta

Cannot be cleared: an Issue without a severity would match no severity filter.

Values:

  • LOW
  • MEDIUM
  • HIGH
categoriesarray of stringBeta

At most 10 values of at most 64 UTF-8 bytes each, unique case-insensitively. Leading and trailing whitespace is trimmed.

tagsobjectBeta

Caller-owned; the server never writes system values here. At most 10 entries. Keys match ^[A-Za-z0-9_.:/-]+$ and are at most 128 UTF-8 bytes; values are at most 256 UTF-8 bytes.

last_seen_timestringBeta

The request time of the latest trace the Issue affects. Required, and can't be cleared, unless source_type is MANUAL. A MANUAL Issue without one returns its create_time.

source_typestringBeta

Set once at create. Defaults to MANUAL.

Values:

  • ADHOC_RUN
  • SCHEDULED_RUN
  • SINGLE_TRACE_ANALYSIS
  • MANUAL
source_idstringBeta

Set once at create. For ADHOC_RUN and SCHEDULED_RUN, the ID of the issue detection run in the same experiment that created the Issue. Absent for MANUAL.

created_bystringBetaOutput only

The email of the user whose request created the Issue. source_type tells whether issue detection created it.

create_timestringBetaOutput only

When the Issue was created.

last_updated_bystringBetaOutput only

The email of the user whose request last updated the Issue.

update_timestringBetaOutput only

When the Issue was last updated.

metadataobjectBeta

Additional details about the Issue, such as how issue detection observed it. Not a stable contract: keys and values can change without notice, so clients must tolerate unknown and missing keys. At most 20 entries, with keys of at most 64 UTF-8 bytes.

Get an issue Beta​

GET /api/2.0/mlflow/{name=experiments/*/issues/*}

Gets an issue.

API scopes: mlflow

Parameters​

namestringRequiredpath

experiments/{experiment}/issues/{issue}

Response​

Returns the Issue object.

Create an issue Beta​

POST /api/2.0/mlflow/{parent=experiments/*}/issues

Creates an issue in an experiment.

API scopes: mlflow

Parameters​

parentstringRequiredpath

experiments/{experiment}

issue_idstringquery

Optional client-chosen ID: iss- followed by 32 lowercase hex digits. A retry with the same ID fails with ALREADY_EXISTS rather than making a duplicate. The server generates one if unset.

Request body​

Output-only fields are ignored.

namestringIDImmutable

experiments/{experiment}/issues/{issue}

titlestringRequired

Non-empty, at most 250 UTF-8 bytes.

descriptionstring

Markdown, at most 32 KiB.

statusstring

Defaults to PENDING on create, and can't be cleared.

Values:

  • PENDING
  • RESOLVED
  • REJECTED
severitystringRequired

Cannot be cleared: an Issue without a severity would match no severity filter.

Values:

  • LOW
  • MEDIUM
  • HIGH
categoriesarray of string

At most 10 values of at most 64 UTF-8 bytes each, unique case-insensitively. Leading and trailing whitespace is trimmed.

tagsobject

Caller-owned; the server never writes system values here. At most 10 entries. Keys match ^[A-Za-z0-9_.:/-]+$ and are at most 128 UTF-8 bytes; values are at most 256 UTF-8 bytes.

last_seen_timestring

The request time of the latest trace the Issue affects. Required, and can't be cleared, unless source_type is MANUAL. A MANUAL Issue without one returns its create_time.

source_typestring

Set once at create. Defaults to MANUAL.

Values:

  • ADHOC_RUN
  • SCHEDULED_RUN
  • SINGLE_TRACE_ANALYSIS
  • MANUAL
source_idstring

Set once at create. For ADHOC_RUN and SCHEDULED_RUN, the ID of the issue detection run in the same experiment that created the Issue. Absent for MANUAL.

metadataobject

Additional details about the Issue, such as how issue detection observed it. Not a stable contract: keys and values can change without notice, so clients must tolerate unknown and missing keys. At most 20 entries, with keys of at most 64 UTF-8 bytes.

Response​

Returns the Issue object.

Update an issue Beta​

PATCH /api/2.0/mlflow/{name=experiments/*/issues/*}

Updates the fields of an issue named in update_mask.

API scopes: mlflow

Parameters​

namestringRequiredIDImmutablepath

experiments/{experiment}/issues/{issue}

update_maskstringRequiredquery

Accepts title, description, status, severity, categories, tags, last_seen_time, and metadata.<key>. A path with an empty value clears the field, except that title, status, and severity can't be cleared, and last_seen_time can be cleared only when source_type is MANUAL. categories and tags are replaced whole. metadata is updated per key: a metadata.<key> path sets that key from issue.metadata, or removes it when issue.metadata lacks it, and leaves the other keys alone. A bare metadata path is rejected.

Request body​

issue.name identifies the target.

titlestringRequired

Non-empty, at most 250 UTF-8 bytes.

descriptionstring

Markdown, at most 32 KiB.

statusstring

Defaults to PENDING on create, and can't be cleared.

Values:

  • PENDING
  • RESOLVED
  • REJECTED
severitystringRequired

Cannot be cleared: an Issue without a severity would match no severity filter.

Values:

  • LOW
  • MEDIUM
  • HIGH
categoriesarray of string

At most 10 values of at most 64 UTF-8 bytes each, unique case-insensitively. Leading and trailing whitespace is trimmed.

tagsobject

Caller-owned; the server never writes system values here. At most 10 entries. Keys match ^[A-Za-z0-9_.:/-]+$ and are at most 128 UTF-8 bytes; values are at most 256 UTF-8 bytes.

last_seen_timestring

The request time of the latest trace the Issue affects. Required, and can't be cleared, unless source_type is MANUAL. A MANUAL Issue without one returns its create_time.

source_typestring

Set once at create. Defaults to MANUAL.

Values:

  • ADHOC_RUN
  • SCHEDULED_RUN
  • SINGLE_TRACE_ANALYSIS
  • MANUAL
source_idstring

Set once at create. For ADHOC_RUN and SCHEDULED_RUN, the ID of the issue detection run in the same experiment that created the Issue. Absent for MANUAL.

metadataobject

Additional details about the Issue, such as how issue detection observed it. Not a stable contract: keys and values can change without notice, so clients must tolerate unknown and missing keys. At most 20 entries, with keys of at most 64 UTF-8 bytes.

Response​

Returns the Issue object.

Search issues in an experiment Beta​

POST /api/2.0/mlflow/{parent=experiments/*}/issues:search

Searches the issues in an experiment, filtered and sorted.

API scopes: mlflow

Parameters​

parentstringRequiredpath

experiments/{experiment}

Request body​

querystring

Case-insensitive substring match on title.

statusesarray of string

Matches Issues with any of these statuses. Different filters AND together, and an empty filter matches every Issue.

Values:

  • PENDING
  • RESOLVED
  • REJECTED
severitiesarray of string

Matches Issues with any of these severities.

Values:

  • LOW
  • MEDIUM
  • HIGH
categoriesarray of string

Matches Issues with any of these categories, case-insensitively.

tag_filtersarray of object

Matches Issues that satisfy every filter. At most 10 filters of 20 values each.

Show child attributesHide child attributes
keystringRequired

Matched exactly.

valuesarray of string

Matched exactly, and ORed together. Empty matches any Issue carrying the key.

sort_keystring

Defaults to SEVERITY.

Values:

  • SEVERITY
  • LAST_SEEN_TIME
  • UPDATE_TIME
  • CREATE_TIME
sort_orderstring

Defaults to DESCENDING.

Values:

  • DESCENDING
  • ASCENDING
page_sizeint32

Defaults to 20; values above 100 are clamped.

page_tokenstring

Expires after 15 minutes. Every other argument except view must match the request that returned the token.

viewstring

Defaults to BASIC.

Values:

  • BASIC
  • FULL

Response​

Returns a list of Issue objects.