model_version_comments

Creates, updates, deletes, gets or lists a model_version_comments resource.

Overview

Name	model_version_comments
Type	Resource
Id	databricks_workspace.machinelearning.model_version_comments

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
createcomment	insert	deployment_name		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.
updatecomment	update	deployment_name		Post an edit to a comment on a model version.
deletecomment	delete	deployment_name		Deletes a comment on a model version.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

INSERT examples

createcomment

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.

INSERT INTO databricks_workspace.machinelearning.model_version_comments (
data__name,
data__version,
data__comment,
deployment_name
)
SELECT 
'{{ name }}',
'{{ version }}',
'{{ comment }}',
'{{ deployment_name }}'
RETURNING
comment
;

Manifest

# Description fields are for documentation purposes
- name: model_version_comments
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the model_version_comments resource.
    - name: name
      value: required
    - name: version
      value: string
    - name: comment
      value: required

UPDATE examples

updatecomment

Post an edit to a comment on a model version.

UPDATE databricks_workspace.machinelearning.model_version_comments
SET 
data__id = '{{ id }}',
data__comment = '{{ comment }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
comment;

DELETE examples

deletecomment

Deletes a comment on a model version.

DELETE FROM databricks_workspace.machinelearning.model_version_comments
WHERE deployment_name = '{{ deployment_name }}' --required;