Skip to main content

collections

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

Overview​

Namecollections
TypeResource
Idnvidia.catalog.collections

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringUnique name of the collection
display_namestringDisplay name (wire: displayName)
org_namestringName of the org that the collection belongs to (wire: orgName)
owner_namestringName of the user who owns this version (wire: ownerName)
team_namestringName of the team that the collection belongs to (wire: teamName)
access_typestring (LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
attributesarray
built_bystringOrganization that built the collection (wire: builtBy)
can_guest_downloadbooleanIndicates if a guest user can download (wire: canGuestDownload)
categorystring (HEALTHCARE, SMART_CITIES, RETAIL, MANUFACTURING, SUPERCOMPUTING, ROBOTICS, AUTOMOTIVE, TELECOMMUNICATIONS, FINANCE, OIL_AND_GAS, NATURAL_LANGUAGE_PROCESSING, AUTOMATIC_SPEECH_RECOGNITION, INTELLIGENT_VIDEO_ANALYTICS, OBJECT_DETECTION, IMAGE_CLASSIFICATION, ANNOTATION, IMAGE_SYNTHESIS, MACHINE_LEARNING, DEEP_LEARNING, INFRASTRUCTURE, HIGH_PERFORMANCE_COMPUTING, WINDOWS_RTX_ACCELERATED_MODELS, BEGINNER, ADVANCED)
created_datestringCreation 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)
descriptionstringDescription of the collection
is_publicbooleanDetermines if this collection is publicly accessible (wire: isPublic)
is_read_onlybooleanindicate if current user has read only permissions (deprecated) (wire: isReadOnly)
labelsarray
logostringURL for the logo image
policy_labelsarray (wire: policyLabels)
product_namesarray (wire: productNames)
publisherstringOrganization that published this collection
short_descriptionstringShort description of the collection (wire: shortDescription)
sizeinteger (int64)Total count of collection items
updated_datestringUpdated 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:

NameAccessible byRequired ParamsOptional ParamsDescription
get_by_teamselectorg_name, team_name, collection_nameresolve_labels, remove_unresolved_labelsGet collection details in team as guest
getselectorg_name, collection_nameresolve_labels, remove_unresolved_labelsGet collection details in org as guest
listselectpage_size, page_numberList public collections

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.

NameDatatypeDescription
collection_namestring (UTF-8)Collection name
org_namestring (UTF-8)Organization name
team_namestring (UTF-8)Team name
page_numberstring (UTF-8)Page number - zero based index
page_sizestring (UTF-8)Page size
remove_unresolved_labelsbooleanRemove unresolved labels
resolve_labelsbooleanResolve labels

SELECT examples​

Get collection details in team as guest

SELECT
name,
display_name,
org_name,
owner_name,
team_name,
access_type,
attributes,
built_by,
can_guest_download,
category,
created_date,
description,
is_public,
is_read_only,
labels,
logo,
policy_labels,
product_names,
publisher,
short_description,
size,
updated_date
FROM nvidia.catalog.collections
WHERE org_name = '{{ org_name }}' -- required
AND team_name = '{{ team_name }}' -- required
AND collection_name = '{{ collection_name }}' -- required
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;
Last updated on