Comment

View as Markdown

Post a commentPOST /api/2.0/mlflow/comments/createUpdate a commentPATCH /api/2.0/mlflow/comments/updateDelete a commentDELETE /api/2.0/mlflow/comments/delete

Post a comment GA

POST /api/2.0/mlflow/comments/create

Posts a comment on a model version. A comment can be submitted either by a user or programmatically to display relevant information about the model. For example, test results or deployment errors.

API scopes: mlflow

Request body

namestring[ 1 .. 100 ] charactersRequired

Name of the model.

Example: search_ads_model

versionstringRequired

Version of the model.

Example: 1

commentstring[ 1 .. 65535 ] charactersRequired

User-provided comment on the action.

Example: This version is great!

Response

commentobject

New comment object

Show child attributesHide child attributes

creation_timestampint64

Creation time of the object, as a Unix timestamp in milliseconds.

Example: 1594437249910

user_idstringemail

The username of the user that created the object.

Example: jane.doe@example.com

activity_typestring

Type of activity. Valid values are:

• APPLIED_TRANSITION: User applied the corresponding stage transition.

• REQUESTED_TRANSITION: User requested the corresponding stage transition.

• CANCELLED_REQUEST: User cancelled an existing transition request.

• APPROVED_REQUEST: User approved the corresponding stage transition.

• REJECTED_REQUEST: User rejected the coressponding stage transition.

• SYSTEM_TRANSITION: For events performed as a side effect, such as archiving existing model versions in a stage.

Values:

• APPLIED_TRANSITION
• REQUESTED_TRANSITION
• CANCELLED_REQUEST
• APPROVED_REQUEST
• REJECTED_REQUEST
• NEW_COMMENT
• SYSTEM_TRANSITION

commentstring[ 1 .. 65535 ] characters

User-provided comment associated with the activity, comment, or transition request.

Example: This version is great!

last_updated_timestampint64

Time of the object at last update, as a Unix timestamp in milliseconds.

Example: 1594437549910

from_stagestring

Source stage of the transition (if the activity is stage transition related). Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

to_stagestring

Target stage of the transition (if the activity is stage transition related). Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

system_commentstring

Comment made by system, for example explaining an activity of type SYSTEM_TRANSITION. It usually describes a side effect, such as a version being archived as part of another version's stage transition, and may not be returned for some activity types.

available_actionsarray of string

Array of actions on the activity allowed for the current viewer.

Values:

• APPROVE_TRANSITION_REQUEST
• REJECT_TRANSITION_REQUEST
• CANCEL_TRANSITION_REQUEST
• EDIT_COMMENT
• DELETE_COMMENT

idstringuuid

Unique identifier for the object.

Example: 6fc74c92704341aaa49e74dcc6031057

View as Markdown

Request

{
  "name": "search_ads_model",
  "version": "1",
  "comment": "This version is great!"
}

Response

{
  "comment": {
    "available_actions": [
      "EDIT_COMMENT"
    ],
    "comment": "This version is great!",
    "creation_timestamp": 1594437249910,
    "id": "6fc74c92704341aaa49e74dcc6031057",
    "last_updated_timestamp": 1594437549910,
    "user_id": "jane.doe@example.com"
  }
}

Update a comment GA

PATCH /api/2.0/mlflow/comments/update

Post an edit to a comment on a model version.

API scopes: mlflow

Request body

idstringuuidRequired

Unique identifier of an activity

Example: 6fc74c92704341aaa49e74dcc6031057

commentstring[ 1 .. 65535 ] charactersRequired

User-provided comment on the action.

Example: This version is great!

Response

commentobject

Updated comment object

Show child attributesHide child attributes

creation_timestampint64

Creation time of the object, as a Unix timestamp in milliseconds.

Example: 1594437249910

user_idstringemail

The username of the user that created the object.

Example: jane.doe@example.com

activity_typestring

Type of activity. Valid values are:

• APPLIED_TRANSITION: User applied the corresponding stage transition.

• REQUESTED_TRANSITION: User requested the corresponding stage transition.

• CANCELLED_REQUEST: User cancelled an existing transition request.

• APPROVED_REQUEST: User approved the corresponding stage transition.

• REJECTED_REQUEST: User rejected the coressponding stage transition.

• SYSTEM_TRANSITION: For events performed as a side effect, such as archiving existing model versions in a stage.

Values:

• APPLIED_TRANSITION
• REQUESTED_TRANSITION
• CANCELLED_REQUEST
• APPROVED_REQUEST
• REJECTED_REQUEST
• NEW_COMMENT
• SYSTEM_TRANSITION

commentstring[ 1 .. 65535 ] characters

User-provided comment associated with the activity, comment, or transition request.

Example: This version is great!

last_updated_timestampint64

Time of the object at last update, as a Unix timestamp in milliseconds.

Example: 1594437549910

from_stagestring

Source stage of the transition (if the activity is stage transition related). Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

to_stagestring

Target stage of the transition (if the activity is stage transition related). Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

system_commentstring

Comment made by system, for example explaining an activity of type SYSTEM_TRANSITION. It usually describes a side effect, such as a version being archived as part of another version's stage transition, and may not be returned for some activity types.

available_actionsarray of string

Array of actions on the activity allowed for the current viewer.

Values:

• APPROVE_TRANSITION_REQUEST
• REJECT_TRANSITION_REQUEST
• CANCEL_TRANSITION_REQUEST
• EDIT_COMMENT
• DELETE_COMMENT

idstringuuid

Unique identifier for the object.

Example: 6fc74c92704341aaa49e74dcc6031057

View as Markdown

Request

{
  "id": "6fc74c92704341aaa49e74dcc6031057",
  "comment": "This version is great!"
}

Response

{
  "comment": {
    "available_actions": [
      "EDIT_COMMENT"
    ],
    "comment": "This version is great!",
    "creation_timestamp": 1594437249910,
    "id": "6fc74c92704341aaa49e74dcc6031057",
    "last_updated_timestamp": 1594437549910,
    "user_id": "jane.doe@example.com"
  }
}

Delete a comment GA

DELETE /api/2.0/mlflow/comments/delete

Deletes a comment on a model version.

API scopes: mlflow

Parameters

idstringuuidRequiredquery

Unique identifier of an activity

Example: 6fc74c92704341aaa49e74dcc6031057

View as Markdown

Response

{}