artifacts

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

Overview

Name	`artifacts`
Type	Resource
Id	`nvidia.catalog.artifacts`

Fields

The following fields are returned by SELECT queries:

get_by_team
get
list

Name	Datatype	Description
`name`	`string`	Unique name of the helm chart
`encryption_key_id`	`string`	ID of the customer managed encryption key associated with this artifact (wire: encryptionKeyId)
`latest_version_id`	`string`	ID of the latest version (wire: latestVersionId)
`display_name`	`string`	Display name (wire: displayName)
`org_name`	`string`	Name of the org that the helm chart belongs to (wire: orgName)
`owner_name`	`string`	Name of the user who owns this version (wire: ownerName)
`team_name`	`string`	Name of the team that the helm chart belongs to (wire: teamName)
`access_type`	`string`	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
`artifact_type`	`string`	Artifact type (MODEL, MODEL_SCRIPT, HELM_CHART, REPOSITORY, COLLECTION, ENDPOINT, BLUEPRINT, PLAYBOOK, AGENT, API, SKILL) (wire: artifactType)
`attributes`	`array`
`bias`	`string`	Text describing bias in the artifact
`built_by`	`string`	Organization that built the helm chart (wire: builtBy)
`can_guest_download`	`boolean`	Indicates if a guest user can download (wire: canGuestDownload)
`created_date`	`string`	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
`description`	`string`	Description of the helm chart
`explainability`	`string`	Text describing the explainability for this artifact
`has_signed_version`	`boolean`	Indicates if the artifact has any signed versions (wire: hasSignedVersion)
`is_favourite`	`boolean`	Flag indicating if helm chart is user's favorite (wire: isFavourite)
`is_public`	`boolean`	Determines if this helm chart is publicly accessible (wire: isPublic)
`is_read_only`	`boolean`	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
`labels`	`array`
`latest_version_size_in_bytes`	`integer (int64)`	Size of the latest version in bytes (wire: latestVersionSizeInBytes)
`license_terms`	`array`	(wire: licenseTerms)
`logo`	`string`	URL for the logo image
`policy_labels`	`array`	(wire: policyLabels)
`privacy`	`string`	Text describing the privacy for this artifact
`product_names`	`array`	(wire: productNames)
`publisher`	`string`	Organization that published this helm chart
`safety_and_security`	`string`	Text for describing the safety and security in the artifact (wire: safetyAndSecurity)
`short_description`	`string`	Short description of the helm chart (wire: shortDescription)
`updated_date`	`string`	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

Name	Datatype	Description
`name`	`string`	Unique name of the helm chart
`encryption_key_id`	`string`	ID of the customer managed encryption key associated with this artifact (wire: encryptionKeyId)
`latest_version_id`	`string`	ID of the latest version (wire: latestVersionId)
`display_name`	`string`	Display name (wire: displayName)
`org_name`	`string`	Name of the org that the helm chart belongs to (wire: orgName)
`owner_name`	`string`	Name of the user who owns this version (wire: ownerName)
`team_name`	`string`	Name of the team that the helm chart belongs to (wire: teamName)
`access_type`	`string`	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
`artifact_type`	`string`	Artifact type (MODEL, MODEL_SCRIPT, HELM_CHART, REPOSITORY, COLLECTION, ENDPOINT, BLUEPRINT, PLAYBOOK, AGENT, API, SKILL) (wire: artifactType)
`attributes`	`array`
`bias`	`string`	Text describing bias in the artifact
`built_by`	`string`	Organization that built the helm chart (wire: builtBy)
`can_guest_download`	`boolean`	Indicates if a guest user can download (wire: canGuestDownload)
`created_date`	`string`	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
`description`	`string`	Description of the helm chart
`explainability`	`string`	Text describing the explainability for this artifact
`has_signed_version`	`boolean`	Indicates if the artifact has any signed versions (wire: hasSignedVersion)
`is_favourite`	`boolean`	Flag indicating if helm chart is user's favorite (wire: isFavourite)
`is_public`	`boolean`	Determines if this helm chart is publicly accessible (wire: isPublic)
`is_read_only`	`boolean`	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
`labels`	`array`
`latest_version_size_in_bytes`	`integer (int64)`	Size of the latest version in bytes (wire: latestVersionSizeInBytes)
`license_terms`	`array`	(wire: licenseTerms)
`logo`	`string`	URL for the logo image
`policy_labels`	`array`	(wire: policyLabels)
`privacy`	`string`	Text describing the privacy for this artifact
`product_names`	`array`	(wire: productNames)
`publisher`	`string`	Organization that published this helm chart
`safety_and_security`	`string`	Text for describing the safety and security in the artifact (wire: safetyAndSecurity)
`short_description`	`string`	Short description of the helm chart (wire: shortDescription)
`updated_date`	`string`	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

Name	Datatype	Description
`name`	`string`	Unique name of the helm chart
`encryption_key_id`	`string`	ID of the customer managed encryption key associated with this artifact (wire: encryptionKeyId)
`latest_version_id`	`string`	ID of the latest version (wire: latestVersionId)
`display_name`	`string`	Display name (wire: displayName)
`org_name`	`string`	Name of the org that the helm chart belongs to (wire: orgName)
`owner_name`	`string`	Name of the user who owns this version (wire: ownerName)
`team_name`	`string`	Name of the team that the helm chart belongs to (wire: teamName)
`access_type`	`string`	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
`artifact_type`	`string`	Artifact type (MODEL, MODEL_SCRIPT, HELM_CHART, REPOSITORY, COLLECTION, ENDPOINT, BLUEPRINT, PLAYBOOK, AGENT, API, SKILL) (wire: artifactType)
`attributes`	`array`
`bias`	`string`	Text describing bias in the artifact
`built_by`	`string`	Organization that built the helm chart (wire: builtBy)
`can_guest_download`	`boolean`	Indicates if a guest user can download (wire: canGuestDownload)
`created_date`	`string`	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
`description`	`string`	Description of the helm chart
`explainability`	`string`	Text describing the explainability for this artifact
`has_signed_version`	`boolean`	Indicates if the artifact has any signed versions (wire: hasSignedVersion)
`is_favourite`	`boolean`	Flag indicating if helm chart is user's favorite (wire: isFavourite)
`is_public`	`boolean`	Determines if this helm chart is publicly accessible (wire: isPublic)
`is_read_only`	`boolean`	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
`labels`	`array`
`latest_version_size_in_bytes`	`integer (int64)`	Size of the latest version in bytes (wire: latestVersionSizeInBytes)
`license_terms`	`array`	(wire: licenseTerms)
`logo`	`string`	URL for the logo image
`policy_labels`	`array`	(wire: policyLabels)
`privacy`	`string`	Text describing the privacy for this artifact
`product_names`	`array`	(wire: productNames)
`publisher`	`string`	Organization that published this helm chart
`safety_and_security`	`string`	Text for describing the safety and security in the artifact (wire: safetyAndSecurity)
`short_description`	`string`	Short description of the helm chart (wire: shortDescription)
`updated_date`	`string`	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_by_team`	`select`	`artifact_type`, `org_name`, `team_name`, `artifact_name`	`resolve_labels`, `remove_unresolved_labels`	Get artifact details in team as guest
`get`	`select`	`org_name`, `artifact_type`, `artifact_name`	`resolve_labels`, `remove_unresolved_labels`	Get artifact details in org as guest
`list`	`select`	`artifact_type`	`page_size`, `page_number`	List public artifacts

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
`artifact_name`	`string (UTF-8)`	Artifact name
`artifact_type`	`string (UTF-8)`	Artifact type
`org_name`	`string (UTF-8)`	Organization name
`team_name`	`string (UTF-8)`	Team name
`page_number`	`string (UTF-8)`	Page number - zero based index
`page_size`	`string (UTF-8)`	Page size
`remove_unresolved_labels`	`boolean`	Remove unresolved labels
`resolve_labels`	`boolean`	Resolve labels

`SELECT` examples

get_by_team
get
list

Get artifact details in team as guest

SELECT
name,
encryption_key_id,
latest_version_id,
display_name,
org_name,
owner_name,
team_name,
access_type,
artifact_type,
attributes,
bias,
built_by,
can_guest_download,
created_date,
description,
explainability,
has_signed_version,
is_favourite,
is_public,
is_read_only,
labels,
latest_version_size_in_bytes,
license_terms,
logo,
policy_labels,
privacy,
product_names,
publisher,
safety_and_security,
short_description,
updated_date
FROM nvidia.catalog.artifacts
WHERE artifact_type = '{{ artifact_type }}' -- required
AND org_name = '{{ org_name }}' -- required
AND team_name = '{{ team_name }}' -- required
AND artifact_name = '{{ artifact_name }}' -- required
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

Get artifact details in org as guest

SELECT
name,
encryption_key_id,
latest_version_id,
display_name,
org_name,
owner_name,
team_name,
access_type,
artifact_type,
attributes,
bias,
built_by,
can_guest_download,
created_date,
description,
explainability,
has_signed_version,
is_favourite,
is_public,
is_read_only,
labels,
latest_version_size_in_bytes,
license_terms,
logo,
policy_labels,
privacy,
product_names,
publisher,
safety_and_security,
short_description,
updated_date
FROM nvidia.catalog.artifacts
WHERE org_name = '{{ org_name }}' -- required
AND artifact_type = '{{ artifact_type }}' -- required
AND artifact_name = '{{ artifact_name }}' -- required
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

List public artifacts

SELECT
name,
encryption_key_id,
latest_version_id,
display_name,
org_name,
owner_name,
team_name,
access_type,
artifact_type,
attributes,
bias,
built_by,
can_guest_download,
created_date,
description,
explainability,
has_signed_version,
is_favourite,
is_public,
is_read_only,
labels,
latest_version_size_in_bytes,
license_terms,
logo,
policy_labels,
privacy,
product_names,
publisher,
safety_and_security,
short_description,
updated_date
FROM nvidia.catalog.artifacts
WHERE artifact_type = '{{ artifact_type }}' -- required
AND page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

Overview

Fields

Methods

Parameters

`SELECT` examples