capabilities_region_notebook_editors

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

Overview

Name	capabilities_region_notebook_editors
Type	Resource
Id	ovh.cloud_ai.capabilities_region_notebook_editors

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the editor
name	string	Name of the editor
description	string	Short description of the editor
doc_url	string	URL of the editor documentation (wire: docUrl)
logo_url	string	URL of the logo of the editor (wire: logoUrl)
versions	array	List of available versions of this editor

list

AI Solutions Notebook editor object

Name	Datatype	Description
id	string	Unique identifier of the editor
name	string	Name of the editor
description	string	Short description of the editor
doc_url	string	URL of the editor documentation (wire: docUrl)
logo_url	string	URL of the logo of the editor (wire: logoUrl)
versions	array	List of available versions of this editor

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	editor_id, region, service_name		Get an AI Solutions Notebook editor
list	select	region, service_name	compatible_with_framework	List AI Solutions Notebook editors

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"}})
editor_id	string	Editor ID (wire: editorId)
region	string	Region
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
compatible_with_framework	string	Only list editors compatible with this framework (wire: compatibleWithFramework)

SELECT examples

get

Get an AI Solutions Notebook editor

SELECT
id,
name,
description,
doc_url,
logo_url,
versions
FROM ovh.cloud_ai.capabilities_region_notebook_editors
WHERE editor_id = '{{ editor_id }}' -- required
AND region = '{{ region }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List AI Solutions Notebook editors

SELECT
id,
name,
description,
doc_url,
logo_url,
versions
FROM ovh.cloud_ai.capabilities_region_notebook_editors
WHERE region = '{{ region }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND compatible_with_framework = '{{ compatible_with_framework }}'
;