experiment_run_artifacts

Creates, updates, deletes, gets or lists an experiment_run_artifacts resource.

Overview

Name	experiment_run_artifacts
Type	Resource
Id	databricks_workspace.ml.experiment_run_artifacts

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
file_size	integer	The size in bytes of the file. Unset for directories.
is_dir	boolean	Whether the path is a directory.
path	string	The path relative to the root artifact directory run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	deployment_name	page_token, path, run_id, run_uuid	List artifacts for a run. Takes an optional artifact_path prefix which if specified, the response

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)
page_token	string	The token indicating the page of artifact results to fetch. page_token is not supported when listing artifacts in UC Volumes. A maximum of 1000 artifacts will be retrieved for UC Volumes. Please call /api/2.0/fs/directories{directory_path} for listing artifacts in UC Volumes, which supports pagination. See List directory contents | Files API.
path	string	Filter artifacts matching this path (a relative path from the root artifact directory).
run_id	string	ID of the run whose artifacts to list. Must be provided.
run_uuid	string	[Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will be removed in a future MLflow version.

SELECT examples

list

List artifacts for a run. Takes an optional artifact_path prefix which if specified, the response

SELECT
file_size,
is_dir,
path
FROM databricks_workspace.ml.experiment_run_artifacts
WHERE deployment_name = '{{ deployment_name }}' -- required
AND page_token = '{{ page_token }}'
AND path = '{{ path }}'
AND run_id = '{{ run_id }}'
AND run_uuid = '{{ run_uuid }}'
;