capabilities_region_notebook_frameworks

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

Overview

Name	capabilities_region_notebook_frameworks
Type	Resource
Id	ovh.cloud_ai.capabilities_region_notebook_frameworks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the framework
name	string	Name of the framework
description	string	Short description of the framework
doc_url	string	URL of the framework documentation (wire: docUrl)
logo_url	string	URL of the logo of the framework (wire: logoUrl)
saved_paths	array	List of paths that are automatically saved (wire: savedPaths)
supported_qpus	array	List of the QPU flavors that are supported by this framework (wire: supportedQpus)
type	string	Type of given framework eg. ai, quantum, quantum-qpu
versions	array	List of available versions of this framework

list

AI Solutions Notebook framework object

Name	Datatype	Description
id	string	Unique identifier of the framework
name	string	Name of the framework
description	string	Short description of the framework
doc_url	string	URL of the framework documentation (wire: docUrl)
logo_url	string	URL of the logo of the framework (wire: logoUrl)
saved_paths	array	List of paths that are automatically saved (wire: savedPaths)
supported_qpus	array	List of the QPU flavors that are supported by this framework (wire: supportedQpus)
type	string	Type of given framework eg. ai, quantum, quantum-qpu
versions	array	List of available versions of this framework

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	framework_id, region, service_name		Get an AI Solutions Notebook framework
list	select	region, service_name	compatible_with_editor, type	List AI Solutions Notebook frameworks

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
framework_id	string	Framework ID (wire: frameworkId)
region	string	Region
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
compatible_with_editor	string	Only list frameworks compatible with this editor (wire: compatibleWithEditor)
type	string	Only list frameworks of this type

SELECT examples

get

Get an AI Solutions Notebook framework

SELECT
id,
name,
description,
doc_url,
logo_url,
saved_paths,
supported_qpus,
type,
versions
FROM ovh.cloud_ai.capabilities_region_notebook_frameworks
WHERE framework_id = '{{ framework_id }}' -- required
AND region = '{{ region }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List AI Solutions Notebook frameworks

SELECT
id,
name,
description,
doc_url,
logo_url,
saved_paths,
supported_qpus,
type,
versions
FROM ovh.cloud_ai.capabilities_region_notebook_frameworks
WHERE region = '{{ region }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND compatible_with_editor = '{{ compatible_with_editor }}'
AND type = '{{ type }}'
;