artifact_specs

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

Overview

Name	artifact_specs
Type	Resource
Id	nvidia.private_registry.artifact_specs

Fields

The following fields are returned by SELECT queries:

get_by_team

Name	Datatype	Description
nvcf_function_id	string	NVCF function id for the model playground (wire: nvcfFunctionId)
artifact_name	string	Unique name of the model (wire: artifactName)
artifact_type	string	ArtifactTypeEnum of the artifact (wire: artifactType)
attributes	string	Metadata json string
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)
namespace	string	org/team of the model
nvcf_inference_path	string	NVCF inference path (invocation route) for the model playground (wire: nvcfInferencePath)
open_api_spec	string	OpenAPI specification for this model (wire: openAPISpec)
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)

get

Name	Datatype	Description
nvcf_function_id	string	NVCF function id for the model playground (wire: nvcfFunctionId)
artifact_name	string	Unique name of the model (wire: artifactName)
artifact_type	string	ArtifactTypeEnum of the artifact (wire: artifactType)
attributes	string	Metadata json string
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)
namespace	string	org/team of the model
nvcf_inference_path	string	NVCF inference path (invocation route) for the model playground (wire: nvcfInferencePath)
open_api_spec	string	OpenAPI specification for this model (wire: openAPISpec)
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	team_name, artifact_type, artifact_name		Get AI Playground for artifactType
get	select	artifact_type, artifact_name		Get AI Playground for artifactType
create_by_team	insert	team_name, artifact_type, artifact_name, nvcf_function_id		Create AI Playground for artifactType
create	insert	artifact_type, artifact_name, nvcf_function_id		Create AI Playground for artifactType
update_by_team	update	team_name, artifact_type, artifact_name		Update AI Playground for artifactType
update	update	artifact_type, artifact_name		Update AI Playground for artifactType
delete_by_team	delete	team_name, artifact_type, artifact_name		Delete AI Playground for artifactType
delete	delete	artifact_type, artifact_name		Delete AI Playground for artifactType

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)	Model name
artifact_type	string (UTF-8)	Artifact type
team_name	string (UTF-8)	Team name

SELECT examples

get_by_team

Get AI Playground for artifactType

SELECT
nvcf_function_id,
artifact_name,
artifact_type,
attributes,
created_date,
namespace,
nvcf_inference_path,
open_api_spec,
updated_date
FROM nvidia.private_registry.artifact_specs
WHERE team_name = '{{ team_name }}' -- required
AND artifact_type = '{{ artifact_type }}' -- required
AND artifact_name = '{{ artifact_name }}' -- required
;

get

Get AI Playground for artifactType

SELECT
nvcf_function_id,
artifact_name,
artifact_type,
attributes,
created_date,
namespace,
nvcf_inference_path,
open_api_spec,
updated_date
FROM nvidia.private_registry.artifact_specs
WHERE artifact_type = '{{ artifact_type }}' -- required
AND artifact_name = '{{ artifact_name }}' -- required
;

INSERT examples

create_by_team

Create AI Playground for artifactType

INSERT INTO nvidia.private_registry.artifact_specs (
artifact_name,
attributes,
nvcf_function_id,
nvcf_inference_path,
open_api_spec,
team_name,
artifact_type
)
SELECT 
'{{ artifact_name }}' /* required */,
'{{ attributes }}',
'{{ nvcf_function_id }}' /* required */,
'{{ nvcf_inference_path }}',
'{{ open_api_spec }}',
'{{ team_name }}',
'{{ artifact_type }}'
RETURNING
nvcf_function_id,
artifact_name,
artifact_type,
attributes,
created_date,
namespace,
nvcf_inference_path,
open_api_spec,
updated_date
;

create

Create AI Playground for artifactType

INSERT INTO nvidia.private_registry.artifact_specs (
artifact_name,
attributes,
nvcf_function_id,
nvcf_inference_path,
open_api_spec,
artifact_type
)
SELECT 
'{{ artifact_name }}' /* required */,
'{{ attributes }}',
'{{ nvcf_function_id }}' /* required */,
'{{ nvcf_inference_path }}',
'{{ open_api_spec }}',
'{{ artifact_type }}'
RETURNING
nvcf_function_id,
artifact_name,
artifact_type,
attributes,
created_date,
namespace,
nvcf_inference_path,
open_api_spec,
updated_date
;

Manifest

# Description fields are for documentation purposes
- name: artifact_specs
props:
  - name: team_name
    value: "{{ team_name }}"
    description: Required parameter for the artifact_specs resource.
  - name: artifact_type
    value: "{{ artifact_type }}"
    description: Required parameter for the artifact_specs resource.
  - name: artifact_name
    value: "{{ artifact_name }}"
    description: |
      Unique name of the model
  - name: attributes
    value: "{{ attributes }}"
    description: |
      Metadata json string
  - name: nvcf_function_id
    value: "{{ nvcf_function_id }}"
    description: |
      NVCF function id for the model playground
  - name: nvcf_inference_path
    value: "{{ nvcf_inference_path }}"
    description: |
      NVCF inference path (invocation route) for the model playground
  - name: open_api_spec
    value: "{{ open_api_spec }}"
    description: |
      OpenAPI specification for this model

UPDATE examples

update_by_team

Update AI Playground for artifactType

UPDATE nvidia.private_registry.artifact_specs
SET 
attributes = '{{ attributes }}',
nvcf_function_id = '{{ nvcf_function_id }}',
nvcf_inference_path = '{{ nvcf_inference_path }}',
open_api_spec = '{{ open_api_spec }}'
WHERE 
team_name = '{{ team_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
RETURNING
nvcf_function_id,
artifact_name,
artifact_type,
attributes,
created_date,
namespace,
nvcf_inference_path,
open_api_spec,
updated_date;

update

Update AI Playground for artifactType

UPDATE nvidia.private_registry.artifact_specs
SET 
attributes = '{{ attributes }}',
nvcf_function_id = '{{ nvcf_function_id }}',
nvcf_inference_path = '{{ nvcf_inference_path }}',
open_api_spec = '{{ open_api_spec }}'
WHERE 
artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
RETURNING
nvcf_function_id,
artifact_name,
artifact_type,
attributes,
created_date,
namespace,
nvcf_inference_path,
open_api_spec,
updated_date;

DELETE examples

delete_by_team

Delete AI Playground for artifactType

DELETE FROM nvidia.private_registry.artifact_specs
WHERE team_name = '{{ team_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
;

delete

Delete AI Playground for artifactType

DELETE FROM nvidia.private_registry.artifact_specs
WHERE artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
;