Notebooks¶
Endpoints for notebooks which offer an in-browser editor to create and execute code for data science analysis and modeling.
Retrieve Notebook Code Snippets¶
Operation path: GET /api/v2/notebookCodeSnippets/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ListSnippetsQuerySchema | query | ListSnippetsQuerySchema | false | Query schema for searching code nuggets. |
Example responses¶
200 Response
{
"description": "Response schema for the list of code snippets.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "A list of code snippets.",
"items": {
"description": "CodeSnippet represents a code snippet.",
"properties": {
"code": {
"description": "The code snippet code content.",
"title": "Code",
"type": "string"
},
"description": {
"description": "The description of the code snippet.",
"title": "Description",
"type": "string"
},
"id": {
"description": "The ID of the code snippet.",
"title": "Id",
"type": "string"
},
"language": {
"description": "The programming language of the code snippet.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version of the code snippet.",
"title": "Languageversion",
"type": "string"
},
"locale": {
"description": "The language locale of the code snippet.",
"title": "Locale",
"type": "string"
},
"tags": {
"description": "A comma separated list of snippet tags.",
"title": "Tags",
"type": "string"
},
"title": {
"description": "The title of the code snippet.",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"locale",
"title",
"description",
"code",
"language",
"languageVersion"
],
"title": "CodeSnippet",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ListCodeSnippetsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for the list of code snippets. | ListCodeSnippetsResponse |
Retrieve Tags¶
Operation path: GET /api/v2/notebookCodeSnippets/tags/
Authentication requirements: BearerAuth
Example responses¶
200 Response
{
"description": "Response schema for the list of code snippets tags.",
"properties": {
"tags": {
"description": "A list of tags for the code snippets.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
}
},
"title": "ListCodeSnippetsTagsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for the list of code snippets tags. | ListCodeSnippetsTagsResponse |
Retrieve Notebook Code Snippets by snippet ID¶
Operation path: GET /api/v2/notebookCodeSnippets/{snippetId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| snippetId | path | string | true | The ID of a code snippet to retrieve. |
Example responses¶
200 Response
{
"description": "CodeSnippet represents a code snippet.",
"properties": {
"code": {
"description": "The code snippet code content.",
"title": "Code",
"type": "string"
},
"description": {
"description": "The description of the code snippet.",
"title": "Description",
"type": "string"
},
"id": {
"description": "The ID of the code snippet.",
"title": "Id",
"type": "string"
},
"language": {
"description": "The programming language of the code snippet.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version of the code snippet.",
"title": "Languageversion",
"type": "string"
},
"locale": {
"description": "The language locale of the code snippet.",
"title": "Locale",
"type": "string"
},
"tags": {
"description": "A comma separated list of snippet tags.",
"title": "Tags",
"type": "string"
},
"title": {
"description": "The title of the code snippet.",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"locale",
"title",
"description",
"code",
"language",
"languageVersion"
],
"title": "CodeSnippet",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CodeSnippet represents a code snippet. | CodeSnippet |
Delete Notebook Environment Variables by notebook ID¶
Operation path: DELETE /api/v2/notebookEnvironmentVariables/{notebookId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to delete all environment variables for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Retrieve Notebook Environment Variables by notebook ID¶
Operation path: GET /api/v2/notebookEnvironmentVariables/{notebookId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to list environment variables for. |
Example responses¶
200 Response
{
"description": "List environment variables response schema.",
"properties": {
"data": {
"description": "List of environment variables",
"items": {
"description": "Environment variable schema.",
"properties": {
"assignedResourceId": {
"description": "The resource ID to which the environment variable is assigned.",
"title": "Assignedresourceid",
"type": "string"
},
"assignedResourceType": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"notebook"
],
"title": "EnvironmentVariableResourceType",
"type": "string"
}
],
"default": "notebook",
"description": "The resource type to which the environment variable is assigned."
},
"createdAt": {
"description": "The date and time when the environment variable was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the environment variable.",
"title": "Createdby",
"type": "string"
},
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"id": {
"description": "The environment variable ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"title": "Name",
"type": "string"
},
"updatedAt": {
"description": "The date and time when the environment variable was last updated.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the environment variable.",
"title": "Updatedby",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value",
"id",
"assignedResourceId",
"createdBy",
"createdAt"
],
"title": "EnvironmentVariableSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "EnvironmentVariablesResponseSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List environment variables response schema. | EnvironmentVariablesResponseSchema |
Create Notebook Environment Variables by notebook ID¶
Operation path: POST /api/v2/notebookEnvironmentVariables/{notebookId}/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Create environment variables request schema.",
"properties": {
"data": {
"description": "List of environment variables to create.",
"items": {
"description": "Schema for updating environment variables.",
"properties": {
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"pattern": "^[a-zA-Z_$][\\w$]*$",
"title": "Name",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "NewEnvironmentVariableSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "CreateEnvironmentVariablesRequestSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to create environment variables for. |
| body | body | CreateEnvironmentVariablesRequestSchema | false | none |
Example responses¶
201 Response
{
"description": "List environment variables response schema.",
"properties": {
"data": {
"description": "List of environment variables",
"items": {
"description": "Environment variable schema.",
"properties": {
"assignedResourceId": {
"description": "The resource ID to which the environment variable is assigned.",
"title": "Assignedresourceid",
"type": "string"
},
"assignedResourceType": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"notebook"
],
"title": "EnvironmentVariableResourceType",
"type": "string"
}
],
"default": "notebook",
"description": "The resource type to which the environment variable is assigned."
},
"createdAt": {
"description": "The date and time when the environment variable was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the environment variable.",
"title": "Createdby",
"type": "string"
},
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"id": {
"description": "The environment variable ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"title": "Name",
"type": "string"
},
"updatedAt": {
"description": "The date and time when the environment variable was last updated.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the environment variable.",
"title": "Updatedby",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value",
"id",
"assignedResourceId",
"createdBy",
"createdAt"
],
"title": "EnvironmentVariableSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "EnvironmentVariablesResponseSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | List environment variables response schema. | EnvironmentVariablesResponseSchema |
Delete notebook environment variables by id¶
Operation path: DELETE /api/v2/notebookEnvironmentVariables/{notebookId}/{envVarId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID that the environment variable belongs to. |
| envVarId | path | string | true | The ID of the environment variable to delete. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Modify Notebook Environment Variables by notebook ID¶
Operation path: PATCH /api/v2/notebookEnvironmentVariables/{notebookId}/{envVarId}/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Schema for updating environment variables.",
"properties": {
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"pattern": "^[a-zA-Z_$][\\w$]*$",
"title": "Name",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "NewEnvironmentVariableSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID that the environment variable belongs to. |
| envVarId | path | string | true | The ID of the environment variable to update. |
| body | body | NewEnvironmentVariableSchema | false | none |
Example responses¶
200 Response
{
"description": "Environment variable schema.",
"properties": {
"assignedResourceId": {
"description": "The resource ID to which the environment variable is assigned.",
"title": "Assignedresourceid",
"type": "string"
},
"assignedResourceType": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"notebook"
],
"title": "EnvironmentVariableResourceType",
"type": "string"
}
],
"default": "notebook",
"description": "The resource type to which the environment variable is assigned."
},
"createdAt": {
"description": "The date and time when the environment variable was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the environment variable.",
"title": "Createdby",
"type": "string"
},
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"id": {
"description": "The environment variable ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"title": "Name",
"type": "string"
},
"updatedAt": {
"description": "The date and time when the environment variable was last updated.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the environment variable.",
"title": "Updatedby",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value",
"id",
"assignedResourceId",
"createdBy",
"createdAt"
],
"title": "EnvironmentVariableSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Environment variable schema. | EnvironmentVariableSchema |
Retrieve Notebook Execution Environments¶
Operation path: GET /api/v2/notebookExecutionEnvironments/
Authentication requirements: BearerAuth
Example responses¶
200 Response
{
"description": "Response schema for listing execution environments.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of execution environments.",
"items": {
"properties": {
"created": {
"description": "The time the environment was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Execution environment description.",
"title": "Description",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the environment is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Execution environment ID.",
"title": "Id",
"type": "string"
},
"isBuiltIn": {
"default": false,
"description": "Whether the environment is a built-in environment supplied by DataRobot.",
"title": "Isbuiltin",
"type": "boolean"
},
"isDownloadable": {
"description": "Whether the environment is downloadable.",
"title": "Isdownloadable",
"type": "boolean"
},
"isPublic": {
"description": "Whether the environment is public.",
"title": "Ispublic",
"type": "boolean"
},
"latestSuccessfulVersion": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"latestVersion": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"name": {
"description": "Execution environment name.",
"title": "Name",
"type": "string"
},
"programmingLanguage": {
"description": "Programming language of the environment.",
"title": "Programminglanguage",
"type": "string"
},
"requiredMetadataKeys": {
"description": "Required metadata keys.",
"items": {
"description": "Define additional parameters required to assemble a model. Model versions using this environment must define values\nfor each fieldName in the requiredMetadata.",
"properties": {
"displayName": {
"description": "A human readable name for the required field.",
"title": "Displayname",
"type": "string"
},
"fieldName": {
"description": "The required field key. This value is added as an environment variable when running custom models.",
"title": "Fieldname",
"type": "string"
}
},
"required": [
"fieldName",
"displayName"
],
"title": "RequiredMetadataKey",
"type": "object"
},
"title": "Requiredmetadatakeys",
"type": "array"
},
"useCases": {
"description": "List of use cases for the environment. This includes 'notebooks', at a minimum .",
"items": {
"type": "string"
},
"title": "Usecases",
"type": "array"
},
"username": {
"description": "The username of the user who created the environment.",
"title": "Username",
"type": "string"
}
},
"required": [
"id",
"isDownloadable",
"isPublic",
"name",
"programmingLanguage",
"created",
"latestVersion",
"latestSuccessfulVersion",
"username"
],
"title": "ExecutionEnvironmentSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ExecutionEnvironmentsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing execution environments. | ExecutionEnvironmentsResponse |
Retrieve Machines¶
Operation path: GET /api/v2/notebookExecutionEnvironments/machines/
Authentication requirements: BearerAuth
Returns all available environment machine options for which to run the notebook.
Example responses¶
200 Response
{
"description": "Represents a list of machine types in the system.",
"properties": {
"machines": {
"description": "List of machine types.",
"items": {
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
},
"title": "Machines",
"type": "array"
}
},
"title": "MachinesPublic",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Represents a list of machine types in the system. | MachinesPublic |
Retrieve Notebooks by environment ID¶
Operation path: GET /api/v2/notebookExecutionEnvironments/{environmentId}/notebooks/
Authentication requirements: BearerAuth
Return list of notebooks that are using environment by environment ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| environmentId | path | string | true | Environment ID to get notebooks for. |
| ExecutionEnvironmentUsageByNotebooksQuery | query | ExecutionEnvironmentUsageByNotebooksQuery | false | Query parameters for listing notebooks using a specific execution environment. |
Example responses¶
200 Response
{
"description": "Response schema for listing notebooks using a specific execution environment.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebooks using the environment.",
"items": {
"description": "Notebook using a specific execution environment.",
"properties": {
"createdAt": {
"description": "The time the notebook was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created the notebook.",
"title": "Createdby",
"type": "string"
},
"environmentVersion": {
"description": "The version of the environment used by the notebook.",
"title": "Environmentversion",
"type": "string"
},
"notebookId": {
"description": "Notebook ID.",
"title": "Notebookid",
"type": "string"
},
"notebookLastSession": {
"description": "The last time the notebook was started.",
"format": "date-time",
"title": "Notebooklastsession",
"type": "string"
},
"notebookName": {
"description": "Notebook name.",
"title": "Notebookname",
"type": "string"
},
"useCaseId": {
"description": "The use case ID of the notebook.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"notebookId",
"notebookName",
"createdAt",
"environmentVersion"
],
"title": "ExecutionEnvironmentUsageByNotebooks",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ExecutionEnvironmentUsageByNotebooksResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing notebooks using a specific execution environment. | ExecutionEnvironmentUsageByNotebooksResponse |
List Notebook Execution Environments versions by environment ID¶
Operation path: GET /api/v2/notebookExecutionEnvironments/{environmentId}/versions/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| environmentId | path | string | true | Environment ID to get versions for. |
Example responses¶
200 Response
{
"description": "Response schema for listing execution environment versions.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of environment versions.",
"items": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ExecutionEnvironmentVersionsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing execution environment versions. | ExecutionEnvironmentVersionsResponse |
Retrieve Notebook Execution Environments by notebook ID¶
Operation path: GET /api/v2/notebookExecutionEnvironments/{notebookId}/
Authentication requirements: BearerAuth
Return assigned execution environment as an EnvironmentPublic entity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to get execution environment for. |
Example responses¶
200 Response
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The public representation of an execution environment. | EnvironmentPublic |
Modify Notebook Execution Environments by notebook ID¶
Operation path: PATCH /api/v2/notebookExecutionEnvironments/{notebookId}/
Authentication requirements: BearerAuth
Sets the environment configuration for the notebook.
Body parameter¶
{
"description": "Request schema for assigning an execution environment to a notebook.",
"properties": {
"environmentId": {
"description": "The execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"environmentSlug": {
"description": "The execution environment slug.",
"title": "Environmentslug",
"type": "string"
},
"language": {
"description": "The programming language of the environment.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version.",
"title": "Languageversion",
"type": "string"
},
"machineId": {
"description": "The machine ID.",
"title": "Machineid",
"type": "string"
},
"machineSlug": {
"description": "The machine slug.",
"title": "Machineslug",
"type": "string"
},
"timeToLive": {
"description": "Inactivity timeout limit.",
"maximum": 525600,
"minimum": 3,
"title": "Timetolive",
"type": "integer"
},
"versionId": {
"description": "The execution environment version ID.",
"title": "Versionid",
"type": "string"
}
},
"title": "ExecutionEnvironmentAssignRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to assign execution environment to. |
| body | body | ExecutionEnvironmentAssignRequest | false | none |
Example responses¶
200 Response
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The public representation of an execution environment. | EnvironmentPublic |
Delete Ports by notebook ID¶
Operation path: DELETE /api/v2/notebookExecutionEnvironments/{notebookId}/ports/
Authentication requirements: BearerAuth
Remove all exposed port for a given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to delete all exposed ports for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Retrieve Ports by notebook ID¶
Operation path: GET /api/v2/notebookExecutionEnvironments/{notebookId}/ports/
Authentication requirements: BearerAuth
List all exposed ports for a given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to get exposed ports for. |
Example responses¶
200 Response
{
"description": "List of exposed ports for a notebook.",
"properties": {
"data": {
"description": "List of exposed ports.",
"items": {
"description": "Exposed port schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"title": "Description",
"type": "string"
},
"id": {
"description": "Exposed port ID.",
"title": "Id",
"type": "string"
},
"notebookId": {
"description": "Notebook ID the exposed port belongs to.",
"title": "Notebookid",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
},
"url": {
"description": "URL to access the exposed port.",
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"notebookId",
"port",
"url"
],
"title": "ExposedPortSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "ExposedPortListSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of exposed ports for a notebook. | ExposedPortListSchema |
Create Ports by notebook ID¶
Operation path: POST /api/v2/notebookExecutionEnvironments/{notebookId}/ports/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Port creation schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "ExposePortSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to create exposed port for. |
| body | body | ExposePortSchema | false | none |
Example responses¶
201 Response
{
"description": "Exposed port schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"title": "Description",
"type": "string"
},
"id": {
"description": "Exposed port ID.",
"title": "Id",
"type": "string"
},
"notebookId": {
"description": "Notebook ID the exposed port belongs to.",
"title": "Notebookid",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
},
"url": {
"description": "URL to access the exposed port.",
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"notebookId",
"port",
"url"
],
"title": "ExposedPortSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Exposed port schema for a notebook. | ExposedPortSchema |
Delete ports by id¶
Operation path: DELETE /api/v2/notebookExecutionEnvironments/{notebookId}/ports/{portId}/
Authentication requirements: BearerAuth
Remove previously exposed port for a given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID for exposed port that is being deleted. |
| portId | path | string | true | Port ID that is being deleted. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Modify Ports by notebook ID¶
Operation path: PATCH /api/v2/notebookExecutionEnvironments/{notebookId}/ports/{portId}/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Port update schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
}
},
"title": "UpdateExposedPortSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID for exposed port that is being updated. |
| portId | path | string | true | Port ID that is being updated. |
| body | body | UpdateExposedPortSchema | false | none |
Example responses¶
200 Response
{
"description": "Exposed port schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"title": "Description",
"type": "string"
},
"id": {
"description": "Exposed port ID.",
"title": "Id",
"type": "string"
},
"notebookId": {
"description": "Notebook ID the exposed port belongs to.",
"title": "Notebookid",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
},
"url": {
"description": "URL to access the exposed port.",
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"notebookId",
"port",
"url"
],
"title": "ExposedPortSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Exposed port schema for a notebook. | ExposedPortSchema |
Retrieve Notebook jobs¶
Operation path: GET /api/v2/notebookJobs/
Authentication requirements: BearerAuth
Get scheduled jobs list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ListScheduledJobQuery | query | ListScheduledJobQuery | false | Query parameters for listing scheduled jobs. |
Example responses¶
200 Response
{
"description": "Paginated response for notebook schedule jobs.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebook schedule jobs.",
"items": {
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
},
"totalEnabledCount": {
"description": "Total number of enabled schedule jobs.",
"title": "Totalenabledcount",
"type": "integer"
}
},
"required": [
"totalEnabledCount"
],
"title": "NotebookScheduleJobsPaginated",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Paginated response for notebook schedule jobs. | NotebookScheduleJobsPaginated |
Create Notebook jobs¶
Operation path: POST /api/v2/notebookJobs/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request to create a new scheduled job.",
"properties": {
"enabled": {
"default": true,
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"notebookId": {
"description": "The ID of the notebook to schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule for the job.",
"title": "Schedule"
},
"title": {
"description": "The title of the scheduled job.",
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId",
"notebookId",
"schedule"
],
"title": "CreateScheduledJobRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateScheduledJobRequest | false | none |
Example responses¶
201 Response
{
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Notebook schedule definition. | NotebookScheduleDefinition |
Create Manual Run¶
Operation path: POST /api/v2/notebookJobs/manualRun/
Authentication requirements: BearerAuth
Create a manual run.
Body parameter¶
{
"description": "Request to create a manual run for a scheduled job.",
"properties": {
"manualRunType": {
"allOf": [
{
"description": "Intentionally a subset of RunTypes above - to be used in API schemas",
"enum": [
"manual",
"pipeline"
],
"title": "ManualRunTypes",
"type": "string"
}
],
"default": "manual",
"description": "The type of manual run. Possible values are 'manual' or 'pipeline'."
},
"notebookId": {
"description": "The ID of the notebook to schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"title": {
"description": "The title of the scheduled job.",
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"notebookId"
],
"title": "CreateManualRunRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateManualRunRequest | false | none |
Example responses¶
201 Response
{
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Notebook schedule definition. | NotebookScheduleDefinition |
Retrieve Run history¶
Operation path: GET /api/v2/notebookJobs/runHistory/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ListScheduledRunsHistoryQuery | query | ListScheduledRunsHistoryQuery | false | Query parameters for listing scheduled runs history. |
Example responses¶
200 Response
{
"description": "Paginated response for notebook scheduled runs history.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebook scheduled runs history.",
"items": {
"description": "Notebook scheduled run.",
"properties": {
"createdAt": {
"description": "The time the job was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"duration": {
"description": "The duration of the job in seconds.",
"title": "Duration",
"type": "integer"
},
"endTime": {
"description": "The time the job ended.",
"format": "date-time",
"title": "Endtime",
"type": "string"
},
"endTimeTs": {
"description": "The time the job ended.",
"format": "date-time",
"title": "Endtimets",
"type": "string"
},
"environment": {
"allOf": [
{
"description": "Supplemental metadata for an environment.",
"properties": {
"id": {
"description": "The ID of the environment.",
"title": "Id",
"type": "string"
},
"label": {
"description": "The label of the environment.",
"title": "Label",
"type": "string"
},
"name": {
"description": "The name of the environment.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"label"
],
"title": "EnvironmentSupplementalMetadata",
"type": "object"
}
],
"description": "Environment metadata.",
"title": "Environment"
},
"id": {
"description": "The ID of the job run.",
"title": "Id",
"type": "string"
},
"jobAbortedTs": {
"description": "The time the job was aborted.",
"format": "date-time",
"title": "Jobabortedts",
"type": "string"
},
"jobCompletedTs": {
"description": "The time the job completed.",
"format": "date-time",
"title": "Jobcompletedts",
"type": "string"
},
"jobCreatedBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Jobcreatedby"
},
"jobErrorTs": {
"description": "The time the job errored.",
"format": "date-time",
"title": "Joberrorts",
"type": "string"
},
"jobStartedTs": {
"description": "The time the job started.",
"format": "date-time",
"title": "Jobstartedts",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookDeleted": {
"default": false,
"description": "Whether the notebook was deleted.",
"title": "Notebookdeleted",
"type": "boolean"
},
"notebookEnvironmentId": {
"description": "The ID of the notebook environment.",
"title": "Notebookenvironmentid",
"type": "string"
},
"notebookEnvironmentImageId": {
"description": "The ID of the notebook environment image.",
"title": "Notebookenvironmentimageid",
"type": "string"
},
"notebookEnvironmentLabel": {
"description": "The label of the notebook environment.",
"title": "Notebookenvironmentlabel",
"type": "string"
},
"notebookEnvironmentName": {
"description": "The name of the notebook environment.",
"title": "Notebookenvironmentname",
"type": "string"
},
"notebookHadErrors": {
"default": false,
"description": "Whether the notebook had errors.",
"title": "Notebookhaderrors",
"type": "boolean"
},
"notebookId": {
"description": "The ID of the notebook associated with the run.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the run.",
"title": "Notebookname",
"type": "string"
},
"notebookRevisionId": {
"description": "The ID of the notebook revision.",
"title": "Notebookrevisionid",
"type": "string"
},
"notebookRevisionName": {
"description": "The name of the notebook revision.",
"title": "Notebookrevisionname",
"type": "string"
},
"notebookRunType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"payload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Payload"
},
"revision": {
"allOf": [
{
"description": "Supplemental metadata for a revision.",
"properties": {
"id": {
"description": "The ID of the revision.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the revision.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "RevisionSupplementalMetadata",
"type": "object"
}
],
"description": "Revision metadata.",
"title": "Revision"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"scheduledJobId": {
"description": "The ID of the scheduled job.",
"title": "Scheduledjobid",
"type": "string"
},
"startTime": {
"description": "The time the job started.",
"format": "date-time",
"title": "Starttime",
"type": "string"
},
"status": {
"description": "The status of the job.",
"title": "Status",
"type": "string"
},
"title": {
"description": "The name of the schedule.",
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"createdAt",
"useCaseId",
"userId",
"orgId",
"notebookId",
"scheduledJobId",
"title",
"status",
"payload",
"notebookName",
"notebookRunType"
],
"title": "NotebookScheduledRun",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "NotebookScheduledRunsHistoryPaginated",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Paginated response for notebook scheduled runs history. | NotebookScheduledRunsHistoryPaginated |
Delete Notebook jobs by notebook schedule ID¶
Operation path: DELETE /api/v2/notebookJobs/{notebookScheduleId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookScheduleId | path | string | true | Notebook Schedule ID to delete. |
| DeleteScheduledJobQuery | query | DeleteScheduledJobQuery | false | Query parameters for deleting a scheduled job. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Retrieve Notebook jobs by notebook schedule ID¶
Operation path: GET /api/v2/notebookJobs/{notebookScheduleId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookScheduleId | path | string | true | Notebook Schedule ID to fetch. |
| ScheduledJobQuery | query | ScheduledJobQuery | false | Query parameters for a scheduled job. |
Example responses¶
200 Response
{
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Notebook schedule definition. | NotebookScheduleDefinition |
Modify Notebook jobs by notebook schedule ID¶
Operation path: PATCH /api/v2/notebookJobs/{notebookScheduleId}/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request to update an existing scheduled job.",
"properties": {
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule for the job.",
"title": "Schedule"
},
"title": {
"description": "The title of the scheduled job.",
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId"
],
"title": "UpdateScheduledJobRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookScheduleId | path | string | true | Notebook Schedule ID to update. |
| body | body | UpdateScheduledJobRequest | false | none |
Example responses¶
200 Response
{
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Notebook schedule definition. | NotebookScheduleDefinition |
Cancel Notebook jobs by notebook schedule ID¶
Operation path: POST /api/v2/notebookJobs/{notebookScheduleId}/cancel/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookScheduleId | path | string | true | Notebook Schedule ID to cancel running jobs for. |
| CancelScheduledJobsQuery | query | CancelScheduledJobsQuery | false | Query parameters for canceling scheduled jobs. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Create Clone by notebook ID¶
Operation path: POST /api/v2/notebookRevisions/fromRevision/{notebookId}/{revisionId}/clone/
Authentication requirements: BearerAuth
Clone a notebook from a revision.
Body parameter¶
{
"description": "Request to clone a notebook from a revision.",
"properties": {
"isAuto": {
"default": false,
"description": "Whether the revision is autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Notebook revision name.",
"minLength": 1,
"title": "Name",
"type": "string"
},
"notebookPath": {
"description": "Path to the notebook file, if using Codespaces.",
"title": "Notebookpath",
"type": "string"
}
},
"title": "CloneNotebookFromRevisionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to clone as notebook. |
| body | body | CloneNotebookFromRevisionRequest | false | none |
Example responses¶
201 Response
{
"description": "Response schema for cloning a notebook from a revision.",
"properties": {
"notebookId": {
"description": "Newly cloned notebook ID.",
"title": "Notebookid",
"type": "string"
}
},
"required": [
"notebookId"
],
"title": "ClonedNotebookResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Response schema for cloning a notebook from a revision. | ClonedNotebookResponse |
Create Restore by notebook ID¶
Operation path: POST /api/v2/notebookRevisions/fromRevision/{notebookId}/{revisionId}/restore/
Authentication requirements: BearerAuth
Restore a notebook from a revision.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to restore notebook contents to. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
Delete Notebook Revisions by notebook ID¶
Operation path: DELETE /api/v2/notebookRevisions/{notebookId}/
Authentication requirements: BearerAuth
Delete all revisions for the given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to delete revisions for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Retrieve Notebook Revisions by notebook ID¶
Operation path: GET /api/v2/notebookRevisions/{notebookId}/
Authentication requirements: BearerAuth
List all revisions for the given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to list revisions for. |
| ListNotebookRevisionsQuerySchema | query | ListNotebookRevisionsQuerySchema | false | Query schema for listing notebook revisions. |
Example responses¶
200 Response
{
"description": "Response schema for listing notebook revisions.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebook revisions.",
"items": {
"description": "Notebook revision schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"notebookId": {
"description": "Notebook ID this revision belongs to.",
"title": "Notebookid",
"type": "string"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
}
},
"required": [
"revisionId",
"notebookId",
"name",
"isAuto",
"created"
],
"title": "NotebookRevisionSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ListNotebookRevisionsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing notebook revisions. | ListNotebookRevisionsResponse |
Create Notebook Revisions by notebook ID¶
Operation path: POST /api/v2/notebookRevisions/{notebookId}/
Authentication requirements: BearerAuth
Create a new revision from the given notebook's current state.
Body parameter¶
{
"description": "Request to create a new notebook revision.",
"properties": {
"isAuto": {
"default": false,
"description": "Whether the revision is autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Notebook revision name.",
"minLength": 1,
"title": "Name",
"type": "string"
},
"notebookPath": {
"description": "Path to the notebook file, if using Codespaces.",
"title": "Notebookpath",
"type": "string"
}
},
"title": "CreateNotebookRevisionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to create a revision for. |
| body | body | CreateNotebookRevisionRequest | false | none |
Example responses¶
201 Response
{
"description": "Notebook revision schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"notebookId": {
"description": "Notebook ID this revision belongs to.",
"title": "Notebookid",
"type": "string"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
}
},
"required": [
"revisionId",
"notebookId",
"name",
"isAuto",
"created"
],
"title": "NotebookRevisionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Notebook revision schema. | NotebookRevisionSchema |
Delete notebook revisions by id¶
Operation path: DELETE /api/v2/notebookRevisions/{notebookId}/{revisionId}/
Authentication requirements: BearerAuth
Delete single revision.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to delete. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Retrieve notebook revisions by id¶
Operation path: GET /api/v2/notebookRevisions/{notebookId}/{revisionId}/
Authentication requirements: BearerAuth
Get a specific revision for the given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to fetch. |
Example responses¶
200 Response
{
"description": "Versioned notebook schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"lastViewed": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision last viewed action information.",
"title": "Lastviewed"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "Organization ID.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "Notebook permissions.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "Notebook settings.",
"title": "Settings"
},
"tags": {
"description": "Notebook tags.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
},
"useCaseId": {
"description": "Use case ID.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"id",
"revisionId",
"name",
"isAuto",
"created",
"lastViewed"
],
"title": "VersionedNotebookSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Versioned notebook schema. | VersionedNotebookSchema |
Modify Notebook Revisions by notebook ID¶
Operation path: PATCH /api/v2/notebookRevisions/{notebookId}/{revisionId}/
Authentication requirements: BearerAuth
Update a revision's name.
Body parameter¶
{
"description": "Request",
"properties": {
"isAuto": {
"default": false,
"description": "Whether the revision is autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Notebook revision name.",
"minLength": 1,
"title": "Name",
"type": "string"
},
"notebookPath": {
"description": "Path to the notebook file, if using Codespaces.",
"title": "Notebookpath",
"type": "string"
}
},
"title": "UpdateNotebookRevisionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to update. |
| body | body | UpdateNotebookRevisionRequest | false | none |
Example responses¶
200 Response
{
"description": "Notebook revision schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"notebookId": {
"description": "Notebook ID this revision belongs to.",
"title": "Notebookid",
"type": "string"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
}
},
"required": [
"revisionId",
"notebookId",
"name",
"isAuto",
"created"
],
"title": "NotebookRevisionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Notebook revision schema. | NotebookRevisionSchema |
Retrieve Cells by notebook ID¶
Operation path: GET /api/v2/notebookRevisions/{notebookId}/{revisionId}/cells/
Authentication requirements: BearerAuth
Get cells for a specific revision version of the given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to fetch cells for. |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata"
],
"title": "NotebookCellCommonSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [NotebookCellCommonSchema] | false | [Schema for notebook cell.] | |
| » NotebookCellCommonSchema | NotebookCellCommonSchema | false | Schema for notebook cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
Retrieve To File by notebook ID¶
Operation path: GET /api/v2/notebookRevisions/{notebookId}/{revisionId}/toFile/
Authentication requirements: BearerAuth
Export Notebook Revision to file.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to export as file. |
Example responses¶
200 Response
{
"type": "string"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Export notebook revision to file JSON response. | string |
Create And Start Codespace¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/createAndStartCodespace/
Authentication requirements: BearerAuth
Creates the Codespace and starts a session.
Body parameter¶
{
"description": "Schema for creating and starting a codespace.",
"properties": {
"cloneRepository": {
"allOf": [
{
"description": "Schema for cloning a repository.",
"properties": {
"checkoutRef": {
"description": "The branch or commit to checkout.",
"title": "Checkoutref",
"type": "string"
},
"url": {
"description": "The URL of the repository to clone.",
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "CloneRepositorySchema",
"type": "object"
}
],
"description": "The repository to clone for the codespace.",
"title": "Clonerepository"
},
"description": {
"description": "The description of the codespace.",
"title": "Description",
"type": "string"
},
"environment": {
"allOf": [
{
"description": "Request schema for assigning an execution environment to a notebook.",
"properties": {
"environmentId": {
"description": "The execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"environmentSlug": {
"description": "The execution environment slug.",
"title": "Environmentslug",
"type": "string"
},
"language": {
"description": "The programming language of the environment.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version.",
"title": "Languageversion",
"type": "string"
},
"machineId": {
"description": "The machine ID.",
"title": "Machineid",
"type": "string"
},
"machineSlug": {
"description": "The machine slug.",
"title": "Machineslug",
"type": "string"
},
"timeToLive": {
"description": "Inactivity timeout limit.",
"maximum": 525600,
"minimum": 3,
"title": "Timetolive",
"type": "integer"
},
"versionId": {
"description": "The execution environment version ID.",
"title": "Versionid",
"type": "string"
}
},
"title": "ExecutionEnvironmentAssignRequest",
"type": "object"
}
],
"description": "The environment for the codespace.",
"title": "Environment"
},
"environmentVariables": {
"description": "The environment variables for the codespace.",
"items": {
"description": "Schema for updating environment variables.",
"properties": {
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"pattern": "^[a-zA-Z_$][\\w$]*$",
"title": "Name",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "NewEnvironmentVariableSchema",
"type": "object"
},
"title": "Environmentvariables",
"type": "array"
},
"exposedPorts": {
"description": "The exposed ports for the codespace.",
"items": {
"description": "Port creation schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "ExposePortSchema",
"type": "object"
},
"title": "Exposedports",
"type": "array"
},
"name": {
"default": "Untitled Codespace",
"description": "The name of the codespace.",
"title": "Name",
"type": "string"
},
"openFilePaths": {
"description": "The file paths to open in the codespace.",
"items": {
"type": "string"
},
"title": "Openfilepaths",
"type": "array"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"description": "The settings for the codespace.",
"title": "Settings"
},
"tags": {
"description": "The tags associated with the codespace.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"useCaseId": {
"description": "The ID of the use case associated with the codespace.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId"
],
"title": "CreateAndStartCodespaceSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateAndStartCodespaceSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the notebook session.",
"properties": {
"environment": {
"allOf": [
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
],
"description": "The environment of the notebook session.",
"title": "Environment"
},
"ephemeralSessionKey": {
"allOf": [
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
],
"description": "The key of the ephemeral session. None if not an ephemeral session.",
"title": "Ephemeralsessionkey"
},
"executionCount": {
"default": 0,
"description": "The execution count of the notebook session.",
"title": "Executioncount",
"type": "integer"
},
"machineStatus": {
"allOf": [
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
],
"description": "The status of the machine running the notebook session."
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runnerStatus": {
"allOf": [
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
],
"description": "The status of the runner for the notebook session."
},
"sessionId": {
"description": "The ID of the notebook session.",
"title": "Sessionid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"default": "interactive",
"description": "The type of the notebook session. Possible values are interactive and triggered."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"startedBy": {
"allOf": [
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
],
"description": "The user who started the notebook session.",
"title": "Startedby"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
},
"withNetworkPolicy": {
"description": "Whether the session is created with network policies.",
"title": "Withnetworkpolicy",
"type": "boolean"
}
},
"required": [
"status",
"notebookId",
"sessionId",
"environment",
"machineStatus",
"runnerStatus"
],
"title": "NotebookSessionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook session. | NotebookSessionSchema |
Retrieve Notebooks by notebook ID¶
Operation path: GET /api/v2/notebookRuntimes/notebooks/{notebookId}/
Authentication requirements: BearerAuth
Retrieves the notebook session or returns the one in the default state.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to get session data for. |
Example responses¶
200 Response
{
"description": "The schema for the notebook session.",
"properties": {
"environment": {
"allOf": [
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
],
"description": "The environment of the notebook session.",
"title": "Environment"
},
"ephemeralSessionKey": {
"allOf": [
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
],
"description": "The key of the ephemeral session. None if not an ephemeral session.",
"title": "Ephemeralsessionkey"
},
"executionCount": {
"default": 0,
"description": "The execution count of the notebook session.",
"title": "Executioncount",
"type": "integer"
},
"machineStatus": {
"allOf": [
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
],
"description": "The status of the machine running the notebook session."
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runnerStatus": {
"allOf": [
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
],
"description": "The status of the runner for the notebook session."
},
"sessionId": {
"description": "The ID of the notebook session.",
"title": "Sessionid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"default": "interactive",
"description": "The type of the notebook session. Possible values are interactive and triggered."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"startedBy": {
"allOf": [
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
],
"description": "The user who started the notebook session.",
"title": "Startedby"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
},
"withNetworkPolicy": {
"description": "Whether the session is created with network policies.",
"title": "Withnetworkpolicy",
"type": "boolean"
}
},
"required": [
"status",
"notebookId",
"sessionId",
"environment",
"machineStatus",
"runnerStatus"
],
"title": "NotebookSessionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook session. | NotebookSessionSchema |
Create Autocomplete by notebook ID¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/{notebookId}/autocomplete/
Authentication requirements: BearerAuth
Autocompletes code.
Body parameter¶
{
"description": "The schema for the code completion request.",
"properties": {
"code": {
"description": "The code to complete.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition"
],
"title": "CodeCompletionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to run autocomplete for. |
| body | body | CodeCompletionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the code completion result.",
"properties": {
"cursorEnd": {
"description": "The end position of the cursor in the code.",
"title": "Cursorend",
"type": "integer"
},
"cursorStart": {
"description": "The start position of the cursor in the code.",
"title": "Cursorstart",
"type": "integer"
},
"matches": {
"description": "The list of code completions.",
"items": {
"type": "string"
},
"title": "Matches",
"type": "array"
}
},
"required": [
"matches",
"cursorStart",
"cursorEnd"
],
"title": "CodeCompletionResultSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the code completion result. | CodeCompletionResultSchema |
Cancel Notebooks by notebook ID¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/{notebookId}/cancel/
Authentication requirements: BearerAuth
Cancels execution.
Body parameter¶
{
"description": "Request schema for canceling the execution of cells in a notebook session.",
"properties": {
"cellIds": {
"description": "List of cell IDs to cancel execution.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"title": "CancelExecutionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to cancel execution for. |
| body | body | CancelExecutionRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
Retrieve Dataframe by notebook ID¶
Operation path: GET /api/v2/notebookRuntimes/notebooks/{notebookId}/cells/{cellId}/dataframe/{referenceId}/
Authentication requirements: BearerAuth
Gets a dataframe from a cell execution.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID the dataframe belongs to. |
| cellId | path | string | true | The cell ID the dataframe belongs to. |
| referenceId | path | integer | true | The reference ID for the dataframe. |
| SortedPaginationQuerySchema | query | SortedPaginationQuerySchema | false | Schema for query parameters for paginated requests. |
Example responses¶
200 Response
{
"description": "Response schema for getting a dataframe from a notebook session.",
"properties": {
"dataframe": {
"description": "The requested dataframe in the notebook session.",
"title": "Dataframe",
"type": "string"
}
},
"required": [
"dataframe"
],
"title": "GetDataframeResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for getting a dataframe from a notebook session. | GetDataframeResponse |
Create Client Activity by notebook ID¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/{notebookId}/clientActivity/
Authentication requirements: BearerAuth
Reset session TTL from client, when there is a user activity.
Body parameter¶
{
"description": "Empty payload used when updating the client activity for a notebook session.",
"properties": {},
"title": "UpdateClientActivityRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID for which client activity is being acknowledged. |
| body | body | UpdateClientActivityRequest | false | none |
Example responses¶
202 Response
{
"description": "Response schema indicating successful or failed operation.",
"properties": {
"success": {
"description": "Indicates whether the operation was successful.",
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Response schema indicating success of an operation. | SuccessResponse |
Retrieve Dataframe List by notebook ID¶
Operation path: GET /api/v2/notebookRuntimes/notebooks/{notebookId}/dataframeList/
Authentication requirements: BearerAuth
Lists all dataframes for a notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to list dataframes for. |
Example responses¶
200 Response
{
"description": "Response schema for listing DataFrames in a notebook session.",
"properties": {
"dataframes": {
"description": "List of DataFrames in the notebook session.",
"items": {
"description": "Interactive variables schema. For use with results from IPython's magic `%who_ls` command.",
"properties": {
"name": {
"description": "The name of the variable.",
"title": "Name",
"type": "string"
},
"type": {
"description": "The type of the variable.",
"title": "Type",
"type": "string"
}
},
"required": [
"name",
"type"
],
"title": "InteractiveVariablesSchema",
"type": "object"
},
"title": "Dataframes",
"type": "array"
}
},
"title": "ListDataframesResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing DataFrames in a notebook session. | ListDataframesResponse |
Execute Notebooks by notebook ID¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/{notebookId}/execute/
Authentication requirements: BearerAuth
Executes specific cells or the entire notebook.
Body parameter¶
{
"description": "Request payload values for executing notebook cells.",
"properties": {
"cellIds": {
"description": "List of cell IDs to execute.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"cells": {
"description": "List of cells to execute.",
"items": {
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType",
"source"
],
"title": "NotebookCellExecData",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"generation",
"cells"
],
"title": "ExecuteCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to execute cells for. |
| body | body | ExecuteCellsRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | No content. | None |
Retrieve Execution Status by notebook ID¶
Operation path: GET /api/v2/notebookRuntimes/notebooks/{notebookId}/executionStatus/
Authentication requirements: BearerAuth
Gets execution status.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to get execution status for. |
Example responses¶
200 Response
{
"description": "Schema for the execution status of a notebook session.",
"properties": {
"cellId": {
"description": "The ID of the cell currently being executed.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Info related to when the execution was completed.",
"title": "Executed"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
},
"status": {
"allOf": [
{
"description": "Kernel execution status.",
"enum": [
"busy",
"idle"
],
"title": "KernelExecutionStatus",
"type": "string"
}
],
"description": "The status of the kernel execution. Possible values are 'busy' or 'idle'."
},
"submitted": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Info related to when the execution request was submitted.",
"title": "Submitted"
}
},
"required": [
"status",
"notebookId"
],
"title": "ExecutionStatusSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the execution status of a notebook session. | ExecutionStatusSchema |
Create Input Reply by notebook ID¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/{notebookId}/inputReply/
Authentication requirements: BearerAuth
Endpoint used in response to when the kernel requests input from the user.
Body parameter¶
{
"description": "The schema for the input reply request.",
"properties": {
"value": {
"description": "The value to send as a reply after kernel has requested input.",
"title": "Value",
"type": "string"
}
},
"required": [
"value"
],
"title": "InputReplySchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID receiving a user's reply to a corresponding request for input. |
| body | body | InputReplySchema | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
Create Inspect by notebook ID¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/{notebookId}/inspect/
Authentication requirements: BearerAuth
Inspects code.
Body parameter¶
{
"description": "The schema for the code inspection request.",
"properties": {
"code": {
"description": "The code to inspect.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
},
"detailLevel": {
"description": "The detail level of the inspection. Possible values are 0 and 1.",
"title": "Detaillevel",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition",
"detailLevel"
],
"title": "CodeInspectionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to run code inspection for. |
| body | body | CodeInspectionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the code inspection result.",
"properties": {
"data": {
"additionalProperties": {
"type": "string"
},
"description": "The inspection result.",
"title": "Data",
"type": "object"
},
"found": {
"description": "True if an object was found, false otherwise.",
"title": "Found",
"type": "boolean"
}
},
"required": [
"data",
"found"
],
"title": "CodeInspectionResultSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the code inspection result. | CodeInspectionResultSchema |
Create Restart Kernel by notebook ID¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/{notebookId}/restartKernel/
Authentication requirements: BearerAuth
Restarts kernel.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to restart kernel for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
Start Notebooks by notebook ID¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/{notebookId}/start/
Authentication requirements: BearerAuth
Starts a new notebook session.
Body parameter¶
{
"description": "Schema for starting a notebook session.",
"properties": {
"cloneRepository": {
"allOf": [
{
"description": "Schema for cloning a repository.",
"properties": {
"checkoutRef": {
"description": "The branch or commit to checkout.",
"title": "Checkoutref",
"type": "string"
},
"url": {
"description": "The URL of the repository to clone.",
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "CloneRepositorySchema",
"type": "object"
}
],
"description": "Automatically tells the runner to clone remote repository if it's supported as part of its environment setup flow.",
"title": "Clonerepository"
},
"isTriggeredRun": {
"default": false,
"description": "Indicates if the session is a triggered run versus an interactive run.",
"title": "Istriggeredrun",
"type": "boolean"
},
"openFilePaths": {
"description": "List of file paths to open in the notebook session.",
"items": {
"type": "string"
},
"title": "Openfilepaths",
"type": "array"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
}
},
"title": "StartNotebookSessionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to start a session for. |
| body | body | StartNotebookSessionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the notebook session.",
"properties": {
"environment": {
"allOf": [
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
],
"description": "The environment of the notebook session.",
"title": "Environment"
},
"ephemeralSessionKey": {
"allOf": [
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
],
"description": "The key of the ephemeral session. None if not an ephemeral session.",
"title": "Ephemeralsessionkey"
},
"executionCount": {
"default": 0,
"description": "The execution count of the notebook session.",
"title": "Executioncount",
"type": "integer"
},
"machineStatus": {
"allOf": [
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
],
"description": "The status of the machine running the notebook session."
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runnerStatus": {
"allOf": [
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
],
"description": "The status of the runner for the notebook session."
},
"sessionId": {
"description": "The ID of the notebook session.",
"title": "Sessionid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"default": "interactive",
"description": "The type of the notebook session. Possible values are interactive and triggered."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"startedBy": {
"allOf": [
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
],
"description": "The user who started the notebook session.",
"title": "Startedby"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
},
"withNetworkPolicy": {
"description": "Whether the session is created with network policies.",
"title": "Withnetworkpolicy",
"type": "boolean"
}
},
"required": [
"status",
"notebookId",
"sessionId",
"environment",
"machineStatus",
"runnerStatus"
],
"title": "NotebookSessionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook session. | NotebookSessionSchema |
Stop Notebooks by notebook ID¶
Operation path: POST /api/v2/notebookRuntimes/notebooks/{notebookId}/stop/
Authentication requirements: BearerAuth
Stops the notebook session.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to stop session for. |
Example responses¶
200 Response
{
"description": "The schema for the notebook session.",
"properties": {
"environment": {
"allOf": [
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
],
"description": "The environment of the notebook session.",
"title": "Environment"
},
"ephemeralSessionKey": {
"allOf": [
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
],
"description": "The key of the ephemeral session. None if not an ephemeral session.",
"title": "Ephemeralsessionkey"
},
"executionCount": {
"default": 0,
"description": "The execution count of the notebook session.",
"title": "Executioncount",
"type": "integer"
},
"machineStatus": {
"allOf": [
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
],
"description": "The status of the machine running the notebook session."
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runnerStatus": {
"allOf": [
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
],
"description": "The status of the runner for the notebook session."
},
"sessionId": {
"description": "The ID of the notebook session.",
"title": "Sessionid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"default": "interactive",
"description": "The type of the notebook session. Possible values are interactive and triggered."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"startedBy": {
"allOf": [
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
],
"description": "The user who started the notebook session.",
"title": "Startedby"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
},
"withNetworkPolicy": {
"description": "Whether the session is created with network policies.",
"title": "Withnetworkpolicy",
"type": "boolean"
}
},
"required": [
"status",
"notebookId",
"sessionId",
"environment",
"machineStatus",
"runnerStatus"
],
"title": "NotebookSessionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook session. | NotebookSessionSchema |
Retrieve Download by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/filesystem/download/
Authentication requirements: BearerAuth
Download entire file system as an archive.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download entire file system as an archive. | string |
Retrieve Objects by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/filesystem/objects/
Authentication requirements: BearerAuth
Get paginated list of objects for a given path in the filesystem.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| ListFilesystemObjectsRequest | query | ListFilesystemObjectsRequest | false | We have set the limit max value to one thousand |
Example responses¶
200 Response
{
"description": "Response schema for listing filesystem objects.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of filesystem objects.",
"items": {
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"datarobotMetadata": {
"additionalProperties": {
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
},
"description": "Metadata for DataRobot files.",
"title": "Datarobotmetadata",
"type": "object"
},
"directoryHierarchy": {
"description": "List of directories respective names and paths.",
"items": {
"description": "These are only directories\n\nThe name property can be any string or the constant/sentinel \"root\"",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"root"
],
"type": "string"
}
],
"description": "Name of the directory.",
"title": "Name"
},
"path": {
"description": "Path to the directory.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path"
],
"title": "DirHierarchyObjectSchema",
"type": "object"
},
"title": "Directoryhierarchy",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"required": [
"data",
"directoryHierarchy",
"datarobotMetadata"
],
"title": "ListFilesystemObjectsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing filesystem objects. | ListFilesystemObjectsResponse |
Create Copy by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/copy/
Authentication requirements: BearerAuth
Copy a filesystem object at a given path to a specific destination.
Body parameter¶
{
"description": "Copy filesystem object request schema.",
"properties": {
"operations": {
"description": "List of source-destination pairs.",
"items": {
"description": "Source and destination schema for filesystem object operations.",
"properties": {
"destination": {
"description": "Destination path.",
"title": "Destination",
"type": "string"
},
"source": {
"description": "Source path.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"destination"
],
"title": "SourceDestinationSchema",
"type": "object"
},
"title": "Operations",
"type": "array"
},
"overrideExisting": {
"default": false,
"description": "Whether to override existing files or directories.",
"title": "Overrideexisting",
"type": "boolean"
}
},
"title": "CopyFilesystemObjectRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CopyFilesystemObjectRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | This schema is used for filesystem objects (files and directories) in the filesystem. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [FilesystemObjectSchema] | false | [This schema is used for filesystem objects (files and directories) in the filesystem.] | |
| » FilesystemObjectSchema | FilesystemObjectSchema | false | This schema is used for filesystem objects (files and directories) in the filesystem. | |
| »» lastUpdatedAt | string(date-time) | false | Last updated time of the filesystem object. | |
| »» mediaType | string | false | Media type of the filesystem object. | |
| »» name | string | true | Name of the filesystem object. | |
| »» path | string | true | Path to the filesystem object. | |
| »» sizeInBytes | integer | false | Size of the filesystem object in bytes. | |
| »» type | FilesystemObjectType | true | Type of the filesystem object. Possible values include 'dir', 'file'. |
Enumerated Values¶
| Property | Value |
|---|---|
| type | [dir, file] |
Delete Delete by notebook ID¶
Operation path: DELETE /api/v2/notebookSessions/{notebookId}/filesystem/objects/delete/
Authentication requirements: BearerAuth
Delete a filesystem object(s) from a list of paths.
Body parameter¶
{
"description": "Delete filesystem object request schema.",
"properties": {
"paths": {
"description": "List of paths to delete.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "DeleteFilesystemObjectsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | DeleteFilesystemObjectsRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Retrieve download by id¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/filesystem/objects/download/
Authentication requirements: BearerAuth
Download many files or directories from the notebook session.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| DownloadFilesystemObjectsQuery | query | DownloadFilesystemObjectsQuery | false | Query schema for downloading filesystem objects. |
Example responses¶
200 Response
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download many files or directories from the notebook session. | string |
Create Download by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/download/
Authentication requirements: BearerAuth
Download a file or directory from the notebook session.
Body parameter¶
{
"description": "Query schema for downloading filesystem objects.",
"properties": {
"paths": {
"description": "List of paths to download.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "DownloadFilesystemObjectsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | DownloadFilesystemObjectsRequest | false | none |
Example responses¶
200 Response
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download a file or directory from the notebook session. | string |
Retrieve Metadata by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/filesystem/objects/metadata/
Authentication requirements: BearerAuth
Get the filesystem's metadata.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| GetFilesystemObjectMetadataRequest | query | GetFilesystemObjectMetadataRequest | false | Request payload values for getting filesystem object metadata. |
Example responses¶
200 Response
{
"description": "Response schema for DataRobot filesystem metadata.",
"properties": {
"datarobotMetadata": {
"additionalProperties": {
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
},
"description": "Metadata for the files.",
"title": "Datarobotmetadata",
"type": "object"
}
},
"required": [
"datarobotMetadata"
],
"title": "DRFilesystemMetadataResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for DataRobot filesystem metadata. | DRFilesystemMetadataResponse |
Modify Metadata by notebook ID¶
Operation path: PATCH /api/v2/notebookSessions/{notebookId}/filesystem/objects/metadata/
Authentication requirements: BearerAuth
Update a filesystem object's metadata.
Body parameter¶
{
"description": "Request payload values for updating filesystem object metadata.",
"properties": {
"updates": {
"description": "List of updates to apply.",
"items": {
"description": "Update filesystem object metadata path and values.",
"properties": {
"metadata": {
"allOf": [
{
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
}
],
"description": "Metadata to update.",
"title": "Metadata"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"metadata"
],
"title": "UpdateFilesystemObjectMetadata",
"type": "object"
},
"title": "Updates",
"type": "array"
}
},
"title": "UpdateFilesystemObjectsMetadataRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | UpdateFilesystemObjectsMetadataRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Metadata for DataRobot files. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [DRFileMetadata] | false | [Metadata for DataRobot files.] | |
| » DRFileMetadata | DRFileMetadata | false | Metadata for DataRobot files. | |
| »» commandArgs | string | false | Command arguments for the file. |
Create Move by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/move/
Authentication requirements: BearerAuth
Move a filesystem object at a given path.
Body parameter¶
{
"description": "Move filesystem object request schema.",
"properties": {
"operations": {
"description": "List of source-destination pairs.",
"items": {
"description": "Source and destination schema for filesystem object operations.",
"properties": {
"destination": {
"description": "Destination path.",
"title": "Destination",
"type": "string"
},
"source": {
"description": "Source path.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"destination"
],
"title": "SourceDestinationSchema",
"type": "object"
},
"title": "Operations",
"type": "array"
}
},
"title": "MoveFilesystemObjectRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | MoveFilesystemObjectRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | This schema is used for filesystem objects (files and directories) in the filesystem. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [FilesystemObjectSchema] | false | [This schema is used for filesystem objects (files and directories) in the filesystem.] | |
| » FilesystemObjectSchema | FilesystemObjectSchema | false | This schema is used for filesystem objects (files and directories) in the filesystem. | |
| »» lastUpdatedAt | string(date-time) | false | Last updated time of the filesystem object. | |
| »» mediaType | string | false | Media type of the filesystem object. | |
| »» name | string | true | Name of the filesystem object. | |
| »» path | string | true | Path to the filesystem object. | |
| »» sizeInBytes | integer | false | Size of the filesystem object in bytes. | |
| »» type | FilesystemObjectType | true | Type of the filesystem object. Possible values include 'dir', 'file'. |
Enumerated Values¶
| Property | Value |
|---|---|
| type | [dir, file] |
New by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/new/
Authentication requirements: BearerAuth
Create a new filesystem object (file or directory) at the given path.
Body parameter¶
{
"description": "Create a new filesystem object request schema.",
"properties": {
"isDirectory": {
"description": "Whether the filesystem object is a directory or not.",
"title": "Isdirectory",
"type": "boolean"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"isDirectory"
],
"title": "CreateFilesystemObjectRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CreateFilesystemObjectRequest | false | none |
Example responses¶
201 Response
{
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | This schema is used for filesystem objects (files and directories) in the filesystem. | FilesystemObjectSchema |
Create Upload by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/upload/
Authentication requirements: BearerAuth
Upload a file or directory into the notebook session and save it under given path. If file exists by given path, it will be overridden.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"items": {
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | This schema is used for filesystem objects (files and directories) in the filesystem. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [FilesystemObjectSchema] | false | [This schema is used for filesystem objects (files and directories) in the filesystem.] | |
| » FilesystemObjectSchema | FilesystemObjectSchema | false | This schema is used for filesystem objects (files and directories) in the filesystem. | |
| »» lastUpdatedAt | string(date-time) | false | Last updated time of the filesystem object. | |
| »» mediaType | string | false | Media type of the filesystem object. | |
| »» name | string | true | Name of the filesystem object. | |
| »» path | string | true | Path to the filesystem object. | |
| »» sizeInBytes | integer | false | Size of the filesystem object in bytes. | |
| »» type | FilesystemObjectType | true | Type of the filesystem object. Possible values include 'dir', 'file'. |
Enumerated Values¶
| Property | Value |
|---|---|
| type | [dir, file] |
Retrieve objects by id¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/filesystem/objects/{subpath}/{path}/
Authentication requirements: BearerAuth
Preview a file. The file path is passed as a parameter. For example: filesystem/objects/home/usr/storage/img.png/.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| subpath | path | string | true | See method level description for details. |
| path | path | string | true | See method level description for details. |
Example responses¶
200 Response
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Preview a file. | string |
Create Clone by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/git/clone/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for cloning a Git repository.",
"properties": {
"url": {
"description": "URL of the Git repository to clone.",
"format": "uri",
"maxLength": 65536,
"minLength": 1,
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "GitCloneRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | GitCloneRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | No content. | None |
Cancel Clone by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/git/clone/cancel/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | No content. | None |
Retrieve Status by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/git/clone/status/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"description": "Response schema for the status of a Git clone operation.",
"properties": {
"errorMsg": {
"description": "Error message if the clone operation failed.",
"title": "Errormsg",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Status of the VCS command.",
"enum": [
"not_inited",
"running",
"finished",
"error"
],
"title": "VCSCommandStatus",
"type": "string"
}
],
"description": "Status of the Git clone operation."
}
},
"required": [
"status"
],
"title": "GitCloneStatusResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for the status of a Git clone operation. | GitCloneStatusResponse |
Retrieve Kernels by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/kernels/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"items": {
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook kernel. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KernelSchema] | false | [The schema for the notebook kernel.] | |
| » KernelSchema | KernelSchema | false | The schema for the notebook kernel. | |
| »» executionState | KernelState | true | The execution state of the kernel. | |
| »» id | string | true | The ID of the kernel. | |
| »» language | RuntimeLanguage | true | The programming language of the kernel. Possible values include 'python', 'r'. | |
| »» name | string | true | The name of the kernel. Possible values include 'python3', 'ir'. | |
| »» running | boolean | false | Whether the kernel is running. |
Enumerated Values¶
| Property | Value |
|---|---|
| executionState | [connecting, disconnected, connected, starting, idle, busy, interrupting, restarting, not_running] |
| language | [python, r, shell, markdown] |
Create Kernels by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/kernels/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request payload values for starting a kernel.",
"properties": {
"spec": {
"description": "Name of the kernel to start. Possible values include 'python3', 'ir'.",
"title": "Spec",
"type": "string"
}
},
"required": [
"spec"
],
"title": "StartKernelRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | StartKernelRequest | false | none |
Example responses¶
201 Response
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The schema for the notebook kernel. | KernelSchema |
Delete Kernels by notebook ID¶
Operation path: DELETE /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to stop. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Retrieve kernels by id¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to retrieve. |
Example responses¶
200 Response
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook kernel. | KernelSchema |
Create Completion by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/completion/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "The schema for the code completion request.",
"properties": {
"code": {
"description": "The code to complete.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition"
],
"title": "CodeCompletionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to use when requesting code completion. |
| body | body | CodeCompletionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the code completion result.",
"properties": {
"cursorEnd": {
"description": "The end position of the cursor in the code.",
"title": "Cursorend",
"type": "integer"
},
"cursorStart": {
"description": "The start position of the cursor in the code.",
"title": "Cursorstart",
"type": "integer"
},
"matches": {
"description": "The list of code completions.",
"items": {
"type": "string"
},
"title": "Matches",
"type": "array"
}
},
"required": [
"matches",
"cursorStart",
"cursorEnd"
],
"title": "CodeCompletionResultSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the code completion result. | CodeCompletionResultSchema |
Execute Kernels by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/execute/
Authentication requirements: BearerAuth
Body parameter¶
{
"properties": {
"code": {
"description": "The code to execute.",
"title": "Code",
"type": "string"
}
},
"required": [
"code"
],
"title": "ExecuteCodeRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to use when executing code. |
| body | body | ExecuteCodeRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
Create Input Reply by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/inputReply/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "The schema for the input reply request.",
"properties": {
"value": {
"description": "The value to send as a reply after kernel has requested input.",
"title": "Value",
"type": "string"
}
},
"required": [
"value"
],
"title": "InputReplySchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to send input request reply to. |
| body | body | InputReplySchema | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
Create Inspect by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/inspect/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "The schema for the code inspection request.",
"properties": {
"code": {
"description": "The code to inspect.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
},
"detailLevel": {
"description": "The detail level of the inspection. Possible values are 0 and 1.",
"title": "Detaillevel",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition",
"detailLevel"
],
"title": "CodeInspectionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to inspect. |
| body | body | CodeInspectionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the code inspection result.",
"properties": {
"data": {
"additionalProperties": {
"type": "string"
},
"description": "The inspection result.",
"title": "Data",
"type": "object"
},
"found": {
"description": "True if an object was found, false otherwise.",
"title": "Found",
"type": "boolean"
}
},
"required": [
"data",
"found"
],
"title": "CodeInspectionResultSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the code inspection result. | CodeInspectionResultSchema |
Create Interrupt by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/interrupt/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to interrupt. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
Create Restart by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/restart/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to restart. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
Retrieve Kernelspecs by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/kernelspecs/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"description": "Schema for the Codespace's kernel information.",
"properties": {
"default": {
"description": "The default kernel. Possible values include 'python3', 'ir'.",
"title": "Default",
"type": "string"
},
"kernels": {
"description": "List of available kernels.",
"items": {
"properties": {
"displayName": {
"description": "Display name of the kernel. Possible values include 'R', 'Python 3 (ipykernel)'.",
"title": "Displayname",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "Runtime language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "Name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"displayName",
"language"
],
"title": "KernelSpecSchema",
"type": "object"
},
"title": "Kernels",
"type": "array"
}
},
"required": [
"default"
],
"title": "KernelSpecsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the Codespace's kernel information. | KernelSpecsResponse |
Retrieve Notebook by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/notebook/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| NotebookOperationQuery | query | NotebookOperationQuery | false | Base query schema for notebook operations. |
Example responses¶
200 Response
{
"description": "The schema for a .ipynb notebook as part of a Codespace.",
"properties": {
"cells": {
"description": "List of cells in the notebook.",
"items": {
"anyOf": [
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
},
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
},
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
]
},
"title": "Cells",
"type": "array"
},
"executionState": {
"allOf": [
{
"description": "Notebook execution state model",
"properties": {
"executingCellId": {
"description": "The ID of the cell currently being executed.",
"title": "Executingcellid",
"type": "string"
},
"executionFinishedAt": {
"description": "The time the execution finished. This is based on the finish time of the last cell.",
"format": "date-time",
"title": "Executionfinishedat",
"type": "string"
},
"executionStartedAt": {
"description": "The time the execution started.",
"format": "date-time",
"title": "Executionstartedat",
"type": "string"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"kernelId": {
"description": "The ID of the kernel used for execution.",
"title": "Kernelid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
}
},
"title": "NotebookExecutionState",
"type": "object"
}
],
"description": "Execution state of the notebook.",
"title": "Executionstate"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"kernelId": {
"description": "Kernel ID assigned to the notebook.",
"title": "Kernelid",
"type": "string"
},
"lastExecuted": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Last executed information.",
"title": "Lastexecuted"
},
"metadata": {
"description": "Metadata for the notebook.",
"title": "Metadata",
"type": "object"
},
"name": {
"description": "Name of the notebook.",
"title": "Name",
"type": "string"
},
"nbformat": {
"description": "The notebook format version.",
"title": "Nbformat",
"type": "integer"
},
"nbformatMinor": {
"description": "The notebook format minor version.",
"title": "Nbformatminor",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path",
"generation",
"nbformat",
"nbformatMinor",
"metadata"
],
"title": "NotebookFileSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for a .ipynb notebook as part of a Codespace. | NotebookFileSchema |
Create Notebook by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/notebook/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Base schema for notebook operations.",
"properties": {
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "NotebookOperationSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | NotebookOperationSchema | false | none |
Example responses¶
201 Response
{
"description": "The schema for the newly created notebook.",
"properties": {
"cells": {
"description": "List of cells in the notebook.",
"items": {
"anyOf": [
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
},
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
},
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
]
},
"title": "Cells",
"type": "array"
},
"metadata": {
"description": "Metadata for the notebook.",
"title": "Metadata",
"type": "object"
},
"name": {
"description": "Name of the notebook.",
"title": "Name",
"type": "string"
},
"nbformat": {
"description": "The notebook format version.",
"title": "Nbformat",
"type": "integer"
},
"nbformatMinor": {
"description": "The notebook format minor version.",
"title": "Nbformatminor",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path",
"nbformat",
"nbformatMinor",
"metadata"
],
"title": "NewNotebookFileSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The schema for the newly created notebook. | NewNotebookFileSchema |
Create Activity by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/notebook/activity/
Authentication requirements: BearerAuth
Reports that the client is still working with these notebooks. UI uses it to report notebooks that are open and potentially viewed by the user. Knowing this information helps to shut down inactive notebook reconcilers/executors.
Body parameter¶
{
"description": "Request payload values for updating notebook activity.",
"properties": {
"paths": {
"description": "List of paths to update activity for.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "NotebookActivityRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | NotebookActivityRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Delete Cells by notebook ID¶
Operation path: DELETE /api/v2/notebookSessions/{notebookId}/notebook/cells/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| BatchCellQuery | query | BatchCellQuery | false | Base schema for batch cell queries. |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
Retrieve Cells by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/notebook/cells/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| GetCellsQuery | query | GetCellsQuery | false | Base query schema for getting notebook cells. |
Example responses¶
200 Response
{
"description": "The schema for the notebook cells.",
"properties": {
"cells": {
"description": "List of cells in the notebook.",
"items": {
"anyOf": [
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
},
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
},
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
]
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
}
},
"required": [
"generation",
"cells"
],
"title": "NotebookCellsSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook cells. | NotebookCellsSchema |
Modify Cells by notebook ID¶
Operation path: PATCH /api/v2/notebookSessions/{notebookId}/notebook/cells/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request payload values for updating notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cells": {
"description": "List of updated notebook cells.",
"items": {
"description": "The schema for the updated notebook cell.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "UpdateNotebookCellSchema",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cells"
],
"title": "UpdateCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | UpdateCellsRequest | false | none |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
Create Cells by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/notebook/cells/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request payload values for creating notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cells": {
"description": "List of cells to create.",
"items": {
"description": "The schema for the cells to be inserted into a notebook.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "ID of the cell after which to insert the new cell.",
"title": "Aftercellid"
},
"data": {
"allOf": [
{
"description": "The schema for the notebook cell to be created.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell to create."
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"cellType"
],
"title": "CreateNotebookCellSchema",
"type": "object"
}
],
"description": "The cell data to insert.",
"title": "Data"
}
},
"required": [
"afterCellId",
"data"
],
"title": "InsertCellsSchema",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cells"
],
"title": "CreateCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CreateCellsRequest | false | none |
Example responses¶
202 Response
{
"description": "Response schema for creating notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
},
"cellIds": {
"description": "List of cell IDs of the created cells.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"required": [
"actionId",
"cellIds"
],
"title": "CreateCellsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Response schema for creating notebook cells. | CreateCellsResponse |
Cancel Cells by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/notebook/cells/cancel/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request payload values for canceling notebook cells execution.",
"properties": {
"cellIds": {
"description": "List of cell IDs to cancel execution for.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cellIds"
],
"title": "CancelCellsExecutionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CancelCellsExecutionRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
Delete Output by notebook ID¶
Operation path: DELETE /api/v2/notebookSessions/{notebookId}/notebook/cells/output/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| BatchCellQuery | query | BatchCellQuery | false | Base schema for batch cell queries. |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
Create Reorder by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/notebook/cells/reorder/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request payload values for reordering notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cellIds": {
"description": "List of cell IDs to reorder.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cellIds"
],
"title": "ReorderCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | ReorderCellsRequest | false | none |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
Create move by id¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/notebook/cells/{cellId}/move/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request payload values for moving a notebook cell.",
"properties": {
"actionId": {
"description": "Action ID of notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "ID of the cell after which to move the cell.",
"title": "Aftercellid"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"afterCellId"
],
"title": "MoveCellRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| cellId | path | string | true | The cell ID to move. |
| body | body | MoveCellRequest | false | none |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
Retrieve Dataframes by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/notebook/dataframes/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| NotebookOperationQuery | query | NotebookOperationQuery | false | Base query schema for notebook operations. |
Example responses¶
200 Response
{
"description": "Schema for the list of DataFrames in a notebook.",
"properties": {
"dataframes": {
"description": "List of DataFrames information.",
"items": {
"description": "Schema for a single DataFrame entry.",
"properties": {
"name": {
"description": "Name of the DataFrame.",
"title": "Name",
"type": "string"
},
"type": {
"description": "Type of the DataFrame.",
"title": "Type",
"type": "string"
}
},
"required": [
"name",
"type"
],
"title": "DataFrameEntrySchema",
"type": "object"
},
"title": "Dataframes",
"type": "array"
}
},
"title": "ListDataFrameResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the list of DataFrames in a notebook. | ListDataFrameResponse |
Retrieve dataframes by id¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/notebook/dataframes/{referenceId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| referenceId | path | string | true | The reference ID for the DataFrame. |
| PaginatedDataframeQuery | query | PaginatedDataframeQuery | false | Query schema for paginated dataframe requests. |
Example responses¶
200 Response
{
"description": "Schema for the DataFrame response.",
"properties": {
"dataframe": {
"description": "The DataFrame as a string.",
"title": "Dataframe",
"type": "string"
}
},
"required": [
"dataframe"
],
"title": "DataFrameResponseSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the DataFrame response. | DataFrameResponseSchema |
Execute Notebook by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/notebook/execute/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request payload values for executing notebook cells.",
"properties": {
"cellIds": {
"description": "List of cell IDs to execute.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"cells": {
"description": "List of cells to execute.",
"items": {
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType",
"source"
],
"title": "NotebookCellExecData",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"generation",
"cells"
],
"title": "ExecuteCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | ExecuteCellsRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | No content. | None |
Retrieve Execution by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/notebook/execution/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| MultiNotebookOperationQuery | query | MultiNotebookOperationQuery | false | Base query schema for multiple notebook operations. |
Example responses¶
200 Response
{
"description": "Response schema for the notebooks execution state.",
"properties": {
"states": {
"description": "List of notebooks execution states.",
"items": {
"description": "The schema for the notebook execution state.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Notebook execution state model",
"properties": {
"executingCellId": {
"description": "The ID of the cell currently being executed.",
"title": "Executingcellid",
"type": "string"
},
"executionFinishedAt": {
"description": "The time the execution finished. This is based on the finish time of the last cell.",
"format": "date-time",
"title": "Executionfinishedat",
"type": "string"
},
"executionStartedAt": {
"description": "The time the execution started.",
"format": "date-time",
"title": "Executionstartedat",
"type": "string"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"kernelId": {
"description": "The ID of the kernel used for execution.",
"title": "Kernelid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
}
},
"title": "NotebookExecutionState",
"type": "object"
}
],
"description": "Execution state of the notebook.",
"title": "Executionstate"
},
"kernel": {
"allOf": [
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
],
"description": "Kernel assigned to the notebook.",
"title": "Kernel"
},
"kernelId": {
"description": "Kernel ID assigned to the notebook.",
"title": "Kernelid",
"type": "string"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "NotebookExecutionStateSchema",
"type": "object"
},
"title": "States",
"type": "array"
}
},
"required": [
"states"
],
"title": "NotebooksExecutionStateResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for the notebooks execution state. | NotebooksExecutionStateResponse |
Create Kernel by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/notebook/kernel/
Authentication requirements: BearerAuth
Sets kernel for a given notebook.
Body parameter¶
{
"description": "Request payload values for assigning a kernel to a notebook.",
"properties": {
"kernelId": {
"description": "ID of the kernel to assign to the notebook.",
"title": "Kernelid",
"type": "string"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "AssignNotebookKernelRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | AssignNotebookKernelRequest | false | none |
Example responses¶
200 Response
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook kernel. | KernelSchema |
Create Trigger Execution by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/notebook/triggerExecution/
Authentication requirements: BearerAuth
A variation of execute_notebook that automatically prepares, assigns kernel and executes the notebook in its entirety.
Body parameter¶
{
"description": "Request payload values for executing a notebook with parameters.",
"properties": {
"parameters": {
"description": "List of parameters to use as environment variables during execution.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "TriggeredNotebookExecutionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | TriggeredNotebookExecutionRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | No content. | None |
Execute scripts by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/scripts/execute/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request payload values for running a file.",
"properties": {
"commandArgs": {
"description": "Arguments and/or flags to pass to a file execution command. For example: '--filename foo.txt -r'",
"title": "Commandargs",
"type": "string"
},
"commandType": {
"allOf": [
{
"description": "These are the command types/languages we support running files for.",
"enum": [
"python",
"bash"
],
"title": "RunnableCommandType",
"type": "string"
}
],
"description": "The type of command to be run. For example 'python'"
},
"filePath": {
"description": "Path to the file to execute.",
"title": "Filepath",
"type": "string"
}
},
"required": [
"filePath"
],
"title": "RunFileRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | RunFileRequest | false | none |
Example responses¶
200 Response
{
"description": "Response schema for executing a file.",
"properties": {
"kernelId": {
"description": "ID of the kernel assigned to the file.",
"title": "Kernelid",
"type": "string"
}
},
"required": [
"kernelId"
],
"title": "ExecuteFileResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for executing a file. | ExecuteFileResponse |
Retrieve Executing by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/scripts/executing/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"description": "Response schema for listing executing files.",
"properties": {
"executingFiles": {
"description": "List of executing files with their kernel IDs.",
"items": {
"description": "Schema for executing file information.",
"properties": {
"filePath": {
"description": "Path to the file being executed.",
"title": "Filepath",
"type": "string"
},
"kernelId": {
"description": "ID of the kernel assigned to the file.",
"title": "Kernelid",
"type": "string"
}
},
"required": [
"kernelId",
"filePath"
],
"title": "ExecutingFileData",
"type": "object"
},
"title": "Executingfiles",
"type": "array"
}
},
"required": [
"executingFiles"
],
"title": "ExecutingFilesResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing executing files. | ExecutingFilesResponse |
Retrieve Terminals by notebook ID¶
Operation path: GET /api/v2/notebookSessions/{notebookId}/terminals/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"description": "Schema for the list of terminals in a notebook.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of terminals in a notebook.",
"items": {
"description": "Schema for a terminal.",
"properties": {
"createdAt": {
"description": "Creation time of the terminal.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
},
"terminalId": {
"description": "ID of the terminal.",
"title": "Terminalid",
"type": "string"
}
},
"required": [
"terminalId",
"name",
"createdAt"
],
"title": "TerminalSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "TerminalsResponseSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the list of terminals in a notebook. | TerminalsResponseSchema |
Create Terminals by notebook ID¶
Operation path: POST /api/v2/notebookSessions/{notebookId}/terminals/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Schema for creating a terminal.",
"properties": {
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "CreateTerminalSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CreateTerminalSchema | false | none |
Example responses¶
201 Response
{
"description": "Schema for a terminal.",
"properties": {
"createdAt": {
"description": "Creation time of the terminal.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
},
"terminalId": {
"description": "ID of the terminal.",
"title": "Terminalid",
"type": "string"
}
},
"required": [
"terminalId",
"name",
"createdAt"
],
"title": "TerminalSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Schema for a terminal. | TerminalSchema |
Delete Terminals by notebook ID¶
Operation path: DELETE /api/v2/notebookSessions/{notebookId}/terminals/{terminalId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| terminalId | path | string | true | The terminal ID to delete. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Modify Terminals by notebook ID¶
Operation path: PATCH /api/v2/notebookSessions/{notebookId}/terminals/{terminalId}/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Schema for updating a terminal.",
"properties": {
"name": {
"description": "Name to update the terminal with.",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "UpdateTerminalSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| terminalId | path | string | true | The terminal ID to update. |
| body | body | UpdateTerminalSchema | false | none |
Example responses¶
200 Response
{
"description": "Schema for a terminal.",
"properties": {
"createdAt": {
"description": "Creation time of the terminal.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
},
"terminalId": {
"description": "ID of the terminal.",
"title": "Terminalid",
"type": "string"
}
},
"required": [
"terminalId",
"name",
"createdAt"
],
"title": "TerminalSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for a terminal. | TerminalSchema |
Retrieve Notebooks¶
Operation path: GET /api/v2/notebooks/
Authentication requirements: BearerAuth
Return list of notebooks.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ListNotebooksQuery | query | ListNotebooksQuery | false | Query options for listing notebooks in the notebooks directory. |
Example responses¶
200 Response
{
"description": "Response schema for listing notebooks.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "A list of notebooks.",
"items": {
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ListNotebooksResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing notebooks. | ListNotebooksResponse |
Create Notebooks¶
Operation path: POST /api/v2/notebooks/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for creating a notebook.",
"properties": {
"createInitialCell": {
"default": true,
"description": "Whether to create an initial cell.",
"title": "Createinitialcell",
"type": "boolean"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"name": {
"default": "Untitled Notebook",
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"title": "CreateNotebookRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateNotebookRequest | false | none |
Example responses¶
201 Response
{
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Schema for notebook metadata with additional fields. | NotebookSchema |
Create Bulk Link Use Case¶
Operation path: POST /api/v2/notebooks/bulkLinkUseCase/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request payload schema for bulk linking notebooks to a use case.",
"properties": {
"notebookIds": {
"description": "List of notebook IDs to link.",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"title": "Notebookids",
"type": "array"
},
"source": {
"allOf": [
{
"description": "The source of the entity linking. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"classic",
"nextGen",
"api"
],
"title": "EntityLinkingSources",
"type": "string"
}
],
"description": "The source of the entity linking."
},
"useCaseId": {
"description": "The ID of the Use Case to link the notebooks to.",
"title": "Usecaseid",
"type": "string"
},
"workflow": {
"allOf": [
{
"description": "The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"migration",
"creation",
"unspecified"
],
"title": "EntityLinkingWorkflows",
"type": "string"
}
],
"description": "The workflow responsible for attaching the notebook to the Use Case."
}
},
"required": [
"notebookIds",
"useCaseId"
],
"title": "BulkLinkNotebooksToUseCaseRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | BulkLinkNotebooksToUseCaseRequest | false | none |
Example responses¶
200 Response
{
"description": "Response schema indicating successful or failed operation.",
"properties": {
"success": {
"description": "Indicates whether the operation was successful.",
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema indicating successful or failed operation. | SuccessResponse |
Retrieve Filter Options¶
Operation path: GET /api/v2/notebooks/filterOptions/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| FilterOptionsQuery | query | FilterOptionsQuery | false | Query options for filtering notebooks in the notebooks directory. |
Example responses¶
200 Response
{
"description": "Response schema for filter options in the notebooks directory.",
"properties": {
"owners": {
"description": "A list of possible owners to filter notebooks by.",
"items": {
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
},
"title": "Owners",
"type": "array"
},
"tags": {
"description": "A list of possible tags to filter notebooks by.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
}
},
"title": "FilterOptionsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for filter options in the notebooks directory. | FilterOptionsResponse |
Create From File¶
Operation path: POST /api/v2/notebooks/fromFile/
Authentication requirements: BearerAuth
Import Notebook from file endpoint.
Example responses¶
201 Response
{
"description": "Imported notebook information.",
"properties": {
"id": {
"description": "The ID of the created notebook.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the created notebook.",
"title": "Name",
"type": "string"
}
},
"required": [
"id"
],
"title": "ImportNotebookResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Imported notebook information. | ImportNotebookResponse |
Create From URL¶
Operation path: POST /api/v2/notebooks/fromUrl/
Authentication requirements: BearerAuth
Import the notebook from the URL endpoint.
Body parameter¶
{
"description": "Request payload values for importing a notebook from a URL.",
"properties": {
"includeOutput": {
"default": true,
"description": "Whether to include the cell output of the notebook in the import.",
"title": "Includeoutput",
"type": "boolean"
},
"name": {
"description": "The name of the notebook to be created upon import.",
"title": "Name",
"type": "string"
},
"uri": {
"description": "The URL of the notebook to import.",
"title": "Uri",
"type": "string"
},
"useCaseId": {
"description": "The ID of the Use Case to import the notebook into.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"uri"
],
"title": "ImportNotebookFromUrlRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ImportNotebookFromUrlRequest | false | none |
Example responses¶
201 Response
{
"description": "Imported notebook information.",
"properties": {
"id": {
"description": "The ID of the created notebook.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the created notebook.",
"title": "Name",
"type": "string"
}
},
"required": [
"id"
],
"title": "ImportNotebookResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Imported notebook information. | ImportNotebookResponse |
Get access control lists¶
Operation path: GET /api/v2/notebooks/sharedRoles/
Authentication requirements: BearerAuth
Get a lists of users who have access to each notebook and their roles on each respective notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookIds | query | array[string] | true | Comma separated notebook IDs to get info of. |
Example responses¶
200 Response
{
"properties": {
"data": {
"description": "Roles data for multiple notebooks.",
"items": {
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"type": "string"
},
"roles": {
"description": "Individual roles data for the notebook.",
"items": {
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type.",
"enum": [
"user"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object",
"x-versionadded": "v2.35"
},
"type": "array"
}
},
"required": [
"notebookId",
"roles"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"data"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Access control list for each notebook keyed by notebook ID. | NotebooksSharedRolesListResponse |
Delete Notebooks by notebook ID¶
Operation path: DELETE /api/v2/notebooks/{notebookId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to delete. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Retrieve Notebooks by notebook ID¶
Operation path: GET /api/v2/notebooks/{notebookId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to retrieve. |
Example responses¶
200 Response
{
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook metadata with additional fields. | NotebookSchema |
Modify Notebooks by notebook ID¶
Operation path: PATCH /api/v2/notebooks/{notebookId}/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for updating a notebook.",
"properties": {
"description": {
"description": "The value to update the description of the notebook to.",
"title": "Description",
"type": "string"
},
"name": {
"description": "The value to update the name of the notebook to.",
"title": "Name",
"type": "string"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"description": "The value to update the settings of the notebook to.",
"title": "Settings"
},
"tags": {
"description": "The value to update the tags of the notebook to.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"useCaseId": {
"description": "The value to update the Use Case ID of the notebook to.",
"title": "Usecaseid",
"type": "string"
}
},
"title": "UpdateNotebookRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to update. |
| body | body | UpdateNotebookRequest | false | none |
Example responses¶
200 Response
{
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook metadata with additional fields. | NotebookSchema |
Modify Batch Clear Cells Execution Count by notebook ID¶
Operation path: PATCH /api/v2/notebooks/{notebookId}/batchClearCellsExecutionCount/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to batch clear cell execution count for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Retrieve Cells by notebook ID¶
Operation path: GET /api/v2/notebooks/{notebookId}/cells/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to retrieve cells for. |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CellSchema] | false | [Schema for notebook cell.] | |
| » CellSchema | CellSchema | false | Schema for notebook cell. | |
| »» attachments | object | false | Cell attachments. | |
| »» cellId | string | true | The ID of the cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionId | string | false | The ID of the execution. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» md5 | string | true | The MD5 hash of the cell. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
Create Cells by notebook ID¶
Operation path: POST /api/v2/notebooks/{notebookId}/cells/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for creating a notebook cell.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "The ID of the cell after which to create the new cell.",
"title": "Aftercellid"
},
"attachments": {
"description": "The attachments associated with the cell.",
"title": "Attachments",
"type": "object"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata associated with the cell.",
"title": "Metadata"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"afterCellId",
"source"
],
"title": "CreateCellRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to create cells for. |
| body | body | CreateCellRequest | false | none |
Example responses¶
200 Response
{
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | CellSchema |
Modify Batch Clear Output by notebook ID¶
Operation path: PATCH /api/v2/notebooks/{notebookId}/cells/batchClearOutput/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for batch clearing the output of notebook cells.",
"properties": {
"cellIds": {
"description": "The IDs of the cells to clear the output of.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"required": [
"cellIds"
],
"title": "BatchClearCellsOutputRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to clear all cell output of. |
| body | body | BatchClearCellsOutputRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CellSchema] | false | [Schema for notebook cell.] | |
| » CellSchema | CellSchema | false | Schema for notebook cell. | |
| »» attachments | object | false | Cell attachments. | |
| »» cellId | string | true | The ID of the cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionId | string | false | The ID of the execution. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» md5 | string | true | The MD5 hash of the cell. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
Create Batch Create by notebook ID¶
Operation path: POST /api/v2/notebooks/{notebookId}/cells/batchCreate/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for batch creating notebook cells.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "The ID of the cell after which to create the new cells.",
"title": "Aftercellid"
},
"cells": {
"description": "The list of cells to create.",
"items": {
"description": "Metadata for the source of a notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Cell metadata.",
"title": "Metadata"
},
"outputs": {
"description": "Cell outputs that conform to the nbformat-based NBX schema.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "Contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
],
"title": "NotebookCellSourceMetadata",
"type": "object"
},
"title": "Cells",
"type": "array"
}
},
"required": [
"afterCellId"
],
"title": "BatchCreateCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to create cells for. |
| body | body | BatchCreateCellsRequest | false | none |
Example responses¶
201 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 201
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CellSchema] | false | [Schema for notebook cell.] | |
| » CellSchema | CellSchema | false | Schema for notebook cell. | |
| »» attachments | object | false | Cell attachments. | |
| »» cellId | string | true | The ID of the cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionId | string | false | The ID of the execution. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» md5 | string | true | The MD5 hash of the cell. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
Create Batch Delete by notebook ID¶
Operation path: POST /api/v2/notebooks/{notebookId}/cells/batchDelete/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for batch deleting notebook cells.",
"properties": {
"cellIds": {
"description": "The IDs of the cells to delete.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"required": [
"cellIds"
],
"title": "BatchDeleteCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to batch delete cells for. |
| body | body | BatchDeleteCellsRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Modify Batch Update Metadata by notebook ID¶
Operation path: PATCH /api/v2/notebooks/{notebookId}/cells/batchUpdateMetadata/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for batch updating notebook cells metadata.",
"properties": {
"cellIds": {
"description": "The IDs of the cells to update.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata to update the cells with.",
"title": "Metadata"
}
},
"required": [
"cellIds",
"metadata"
],
"title": "BatchUpdateCellsMetadataRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to batch update cell metadata for. |
| body | body | BatchUpdateCellsMetadataRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CellSchema] | false | [Schema for notebook cell.] | |
| » CellSchema | CellSchema | false | Schema for notebook cell. | |
| »» attachments | object | false | Cell attachments. | |
| »» cellId | string | true | The ID of the cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionId | string | false | The ID of the execution. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» md5 | string | true | The MD5 hash of the cell. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
Modify Batch Update Sources by notebook ID¶
Operation path: PATCH /api/v2/notebooks/{notebookId}/cells/batchUpdateSources/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for batch updating notebook cells sources.",
"properties": {
"cells": {
"description": "The list of cells to update.",
"items": {
"description": "Notebook cell source model.",
"properties": {
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"source": {
"description": "Contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"cellId",
"source",
"md5"
],
"title": "NotebookCellSource",
"type": "object"
},
"title": "Cells",
"type": "array"
}
},
"title": "BatchUpdateCellsSourcesRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to batch update cell sources for. |
| body | body | BatchUpdateCellsSourcesRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CellSchema] | false | [Schema for notebook cell.] | |
| » CellSchema | CellSchema | false | Schema for notebook cell. | |
| »» attachments | object | false | Cell attachments. | |
| »» cellId | string | true | The ID of the cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionId | string | false | The ID of the execution. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» md5 | string | true | The MD5 hash of the cell. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
Delete Cells by notebook ID¶
Operation path: DELETE /api/v2/notebooks/{notebookId}/cells/{cellId}/
Authentication requirements: BearerAuth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook the cell belongs to. |
| cellId | path | string | true | The ID of the cell to delete. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
Modify Cells by notebook ID¶
Operation path: PATCH /api/v2/notebooks/{notebookId}/cells/{cellId}/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for updating a notebook cell.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "The ID of the cell after which to create the new cell.",
"title": "Aftercellid"
},
"attachments": {
"description": "The attachments associated with the cell.",
"title": "Attachments",
"type": "object"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata associated with the cell.",
"title": "Metadata"
},
"source": {
"description": "Contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"md5"
],
"title": "UpdateCellRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook the cell belongs to. |
| cellId | path | string | true | The ID of the cell to update. |
| body | body | UpdateCellRequest | false | none |
Example responses¶
200 Response
{
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | CellSchema |
Modify Output by notebook ID¶
Operation path: PATCH /api/v2/notebooks/{notebookId}/cells/{cellId}/output/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for clearing the output of a notebook cell.",
"properties": {
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
}
},
"required": [
"md5"
],
"title": "ClearCellOutputRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook the cell belongs to. |
| cellId | path | string | true | The ID of the cell to clear output for. |
| body | body | ClearCellOutputRequest | false | none |
Example responses¶
200 Response
{
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | CellSchema |
Modify Reorder Cells by notebook ID¶
Operation path: PATCH /api/v2/notebooks/{notebookId}/reorderCells/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Schema for taking an action on a notebook cell.",
"properties": {
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
}
},
"required": [
"md5",
"cellId"
],
"title": "CellVersionActionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to reorder cells for. |
| body | body | CellVersionActionSchema | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | No content. | None |
Get notebook's access control list by notebook ID¶
Operation path: GET /api/v2/notebooks/{notebookId}/sharedRoles/
Authentication requirements: BearerAuth
Get a list of users and their roles who have access to this notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer | false | The number of records to skip over. |
| limit | query | integer | false | The number of records to return. |
| notebookId | path | string | true | The ID of the notebook. |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "The number of items returned.",
"type": "integer"
},
"data": {
"description": "The access control list.",
"items": {
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The type of the recipient.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page.",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page.",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of items matching the condition.",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Access control list for a notebook. | SharingListV2Response |
Modify State by notebook ID¶
Operation path: PATCH /api/v2/notebooks/{notebookId}/state/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Schema for taking an action on a notebook cell.",
"properties": {
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
}
},
"required": [
"md5",
"cellId"
],
"title": "CellVersionActionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that cells belong to. |
| body | body | CellVersionActionSchema | false | none |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CellSchema] | false | [Schema for notebook cell.] | |
| » CellSchema | CellSchema | false | Schema for notebook cell. | |
| »» attachments | object | false | Cell attachments. | |
| »» cellId | string | true | The ID of the cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionId | string | false | The ID of the execution. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» md5 | string | true | The MD5 hash of the cell. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
Create To Codespace by notebook ID¶
Operation path: POST /api/v2/notebooks/{notebookId}/toCodespace/
Authentication requirements: BearerAuth
Body parameter¶
{
"description": "Request schema for converting a notebook to a codespace.",
"properties": {
"useCaseDescription": {
"description": "The description of the Use Case.",
"maxLength": 500,
"title": "Usecasedescription",
"type": "string"
},
"useCaseId": {
"description": "The ID of the Use Case to associate the notebook with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case to associate the notebook with.",
"title": "Usecasename",
"type": "string"
}
},
"title": "ConvertToCodespaceRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to convert to a codespace. |
| body | body | ConvertToCodespaceRequest | false | none |
Example responses¶
201 Response
{
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Schema for notebook metadata with additional fields. | NotebookSchema |
Retrieve To File by notebook ID¶
Operation path: GET /api/v2/notebooks/{notebookId}/toFile/
Authentication requirements: BearerAuth
Export Notebook to file endpoint.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to return as a file. |
| ExportNotebookQuerySchema | query | ExportNotebookQuerySchema | false | Query parameters for exporting a notebook. |
Example responses¶
200 Response
{
"type": "string"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Export notebook to file JSON response. | string |
Retrieve Providers¶
Operation path: GET /api/v2/vcs/git/providers/
Authentication requirements: BearerAuth
List authorized Git OAuth Providers.
Example responses¶
200 Response
{
"description": "A list of authorized Git OAuth providers available for the user.",
"properties": {
"providers": {
"description": "A list of authorized Git OAuth providers.",
"items": {
"description": "The Git OAuth Provider details.",
"properties": {
"hostname": {
"description": "The hostname of the Git provider.",
"title": "Hostname",
"type": "string"
},
"id": {
"description": "The authorized Git OAuth Provider ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the Git provider.",
"title": "Name",
"type": "string"
},
"settingsUrl": {
"description": "The URL to manage the Git provider settings.",
"title": "Settingsurl",
"type": "string"
},
"status": {
"description": "The status of the OAuth authorization.",
"title": "Status",
"type": "string"
},
"type": {
"description": "The type of the Git provider.",
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"status",
"type",
"name",
"hostname"
],
"title": "GitProviderSchema",
"type": "object"
},
"maxItems": 1000,
"minItems": 0,
"title": "Providers",
"type": "array"
}
},
"required": [
"providers"
],
"title": "ListGitProvidersResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A list of authorized Git OAuth providers available for the user. | ListGitProvidersResponse |
Retrieve Repositories by authorization ID¶
Operation path: GET /api/v2/vcs/git/providers/{authorizationId}/repositories/
Authentication requirements: BearerAuth
Get or search repositories for a given authorized Git provider.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| authorizationId | path | string | true | The authorization ID of the Git provider. |
| ListGitRepositoryQuery | query | ListGitRepositoryQuery | false | The possible query params to use when listing git repositories. |
Example responses¶
200 Response
{
"description": "A list of Git repositories available for the authorized Git provider and the related params used for filtering\n(if provided).",
"properties": {
"data": {
"description": "A list of Git repositories.",
"items": {
"properties": {
"createdAt": {
"description": "The creation date of the Git repository.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"fullName": {
"description": "The full name of Git repository, e.g., datarobot/notebooks.",
"title": "Fullname",
"type": "string"
},
"httpUrl": {
"description": "The HTTP URL of the Git repository, e.g., https://github.com/datarobot/notebooks.",
"title": "Httpurl",
"type": "string"
},
"isPrivate": {
"description": "Determines if the Git repository is private.",
"title": "Isprivate",
"type": "boolean"
},
"name": {
"description": "The name of Git repository, e.g., \"notebooks\".",
"title": "Name",
"type": "string"
},
"owner": {
"description": "The owner account of the Git repository.",
"title": "Owner",
"type": "string"
},
"pushedAt": {
"description": "The last push date of the Git repository.",
"format": "date-time",
"title": "Pushedat",
"type": "string"
},
"updatedAt": {
"description": "The last update date of the Git repository.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
}
},
"required": [
"name",
"fullName",
"httpUrl",
"owner"
],
"title": "GitRepositorySchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"params": {
"additionalProperties": {
"type": "string"
},
"description": "The params used when listing Git repositories.",
"title": "Params",
"type": "object"
}
},
"required": [
"data"
],
"title": "ListGitRepositoriesResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A list of Git repositories available for the authorized Git provider and the related params used for filtering | |
| (if provided). | ListGitRepositoriesResponse |
Schemas¶
APINotebookCellDisplayDataOutput
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
APINotebookCellDisplayDataOutput
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | object | true | A mime-type keyed dictionary of data. | |
| metadata | object | true | Cell output metadata. | |
| outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
APINotebookCellErrorOutput
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
}
APINotebookCellErrorOutput
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ename | string | true | The name of the error. | |
| evalue | string | true | The value of the error. | |
| outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| traceback | [string] | true | The traceback of the error. |
APINotebookCellExecuteResultOutput
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
}
APINotebookCellExecuteResultOutput
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | object | true | A mime-type keyed dictionary of data. | |
| executionCount | integer | false | A result's prompt number. | |
| metadata | object | true | Cell output metadata. | |
| outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
APINotebookCellInputRequest
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
}
APINotebookCellInputRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| password | boolean | true | Whether the input request is for a password. | |
| prompt | string | true | The prompt for the input request. |
APINotebookCellStreamOutput
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
}
APINotebookCellStreamOutput
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | The name of the stream. | |
| outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
AccessControlV2
{
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The type of the recipient.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The identifier of the recipient. | |
| name | string | true | The name of the recipient. | |
| role | string | true | The role of the recipient on this entity. | |
| shareRecipientType | string | true | The type of the recipient. |
Enumerated Values¶
| Property | Value |
|---|---|
| role | [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
| shareRecipientType | [user, group, organization] |
ActionCreatedResponse
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
ActionCreatedResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionId | string | true | Action ID of the notebook update request. |
AnyCellSchema
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
AnyCellSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellType | string | true | Type of the cell. | |
| id | string | true | ID of the cell. | |
| metadata | NotebookCellMetadata | false | Metadata of the cell. | |
| source | any | false | Contents of the cell, represented as a string. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
AssignNotebookKernelRequest
{
"description": "Request payload values for assigning a kernel to a notebook.",
"properties": {
"kernelId": {
"description": "ID of the kernel to assign to the notebook.",
"title": "Kernelid",
"type": "string"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "AssignNotebookKernelRequest",
"type": "object"
}
AssignNotebookKernelRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kernelId | string | false | ID of the kernel to assign to the notebook. | |
| path | string | true | Path to the notebook. |
AwaitingInputState
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
AwaitingInputState
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| password | boolean | true | Whether the input request is for a password. | |
| prompt | string | true | The prompt for the input request. | |
| requestedAt | string(date-time) | true | The time the input was requested. |
BatchCellQuery
{
"description": "Base schema for batch cell queries.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cellIds": {
"description": "List of cell IDs to operate on.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cellIds"
],
"title": "BatchCellQuery",
"type": "object"
}
BatchCellQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionId | string | false | maxLength: 64 |
Action ID of the notebook update request. |
| cellIds | [string] | true | List of cell IDs to operate on. | |
| generation | integer | true | Integer representing the generation of the notebook. | |
| path | string | true | Path to the notebook. |
BatchClearCellsOutputRequest
{
"description": "Request schema for batch clearing the output of notebook cells.",
"properties": {
"cellIds": {
"description": "The IDs of the cells to clear the output of.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"required": [
"cellIds"
],
"title": "BatchClearCellsOutputRequest",
"type": "object"
}
BatchClearCellsOutputRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellIds | [string] | true | The IDs of the cells to clear the output of. |
BatchCreateCellsRequest
{
"description": "Request schema for batch creating notebook cells.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "The ID of the cell after which to create the new cells.",
"title": "Aftercellid"
},
"cells": {
"description": "The list of cells to create.",
"items": {
"description": "Metadata for the source of a notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Cell metadata.",
"title": "Metadata"
},
"outputs": {
"description": "Cell outputs that conform to the nbformat-based NBX schema.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "Contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
],
"title": "NotebookCellSourceMetadata",
"type": "object"
},
"title": "Cells",
"type": "array"
}
},
"required": [
"afterCellId"
],
"title": "BatchCreateCellsRequest",
"type": "object"
}
BatchCreateCellsRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| afterCellId | any | true | The ID of the cell after which to create the new cells. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cells | [NotebookCellSourceMetadata] | false | The list of cells to create. |
Enumerated Values¶
| Property | Value |
|---|---|
| anonymous | FIRST |
BatchDeleteCellsRequest
{
"description": "Request schema for batch deleting notebook cells.",
"properties": {
"cellIds": {
"description": "The IDs of the cells to delete.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"required": [
"cellIds"
],
"title": "BatchDeleteCellsRequest",
"type": "object"
}
BatchDeleteCellsRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellIds | [string] | true | The IDs of the cells to delete. |
BatchUpdateCellsMetadataRequest
{
"description": "Request schema for batch updating notebook cells metadata.",
"properties": {
"cellIds": {
"description": "The IDs of the cells to update.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata to update the cells with.",
"title": "Metadata"
}
},
"required": [
"cellIds",
"metadata"
],
"title": "BatchUpdateCellsMetadataRequest",
"type": "object"
}
BatchUpdateCellsMetadataRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellIds | [string] | true | The IDs of the cells to update. | |
| metadata | NotebookCellMetadata | true | The metadata to update the cells with. |
BatchUpdateCellsSourcesRequest
{
"description": "Request schema for batch updating notebook cells sources.",
"properties": {
"cells": {
"description": "The list of cells to update.",
"items": {
"description": "Notebook cell source model.",
"properties": {
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"source": {
"description": "Contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"cellId",
"source",
"md5"
],
"title": "NotebookCellSource",
"type": "object"
},
"title": "Cells",
"type": "array"
}
},
"title": "BatchUpdateCellsSourcesRequest",
"type": "object"
}
BatchUpdateCellsSourcesRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cells | [NotebookCellSource] | false | The list of cells to update. |
BulkLinkNotebooksToUseCaseRequest
{
"description": "Request payload schema for bulk linking notebooks to a use case.",
"properties": {
"notebookIds": {
"description": "List of notebook IDs to link.",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"title": "Notebookids",
"type": "array"
},
"source": {
"allOf": [
{
"description": "The source of the entity linking. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"classic",
"nextGen",
"api"
],
"title": "EntityLinkingSources",
"type": "string"
}
],
"description": "The source of the entity linking."
},
"useCaseId": {
"description": "The ID of the Use Case to link the notebooks to.",
"title": "Usecaseid",
"type": "string"
},
"workflow": {
"allOf": [
{
"description": "The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"migration",
"creation",
"unspecified"
],
"title": "EntityLinkingWorkflows",
"type": "string"
}
],
"description": "The workflow responsible for attaching the notebook to the Use Case."
}
},
"required": [
"notebookIds",
"useCaseId"
],
"title": "BulkLinkNotebooksToUseCaseRequest",
"type": "object"
}
BulkLinkNotebooksToUseCaseRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| notebookIds | [string] | true | maxItems: 100 minItems: 1 |
List of notebook IDs to link. |
| source | EntityLinkingSources | false | The source of the entity linking. | |
| useCaseId | string | true | The ID of the Use Case to link the notebooks to. | |
| workflow | EntityLinkingWorkflows | false | The workflow responsible for attaching the notebook to the Use Case. |
CancelCellsExecutionRequest
{
"description": "Request payload values for canceling notebook cells execution.",
"properties": {
"cellIds": {
"description": "List of cell IDs to cancel execution for.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cellIds"
],
"title": "CancelCellsExecutionRequest",
"type": "object"
}
CancelCellsExecutionRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellIds | [string] | true | List of cell IDs to cancel execution for. | |
| generation | integer | true | Integer representing the generation of the notebook. | |
| path | string | true | Path to the notebook. |
CancelExecutionRequest
{
"description": "Request schema for canceling the execution of cells in a notebook session.",
"properties": {
"cellIds": {
"description": "List of cell IDs to cancel execution.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"title": "CancelExecutionRequest",
"type": "object"
}
CancelExecutionRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellIds | [string] | false | List of cell IDs to cancel execution. |
CancelScheduledJobsQuery
{
"description": "Query parameters for canceling scheduled jobs.",
"properties": {
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId"
],
"title": "CancelScheduledJobsQuery",
"type": "object"
}
CancelScheduledJobsQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| useCaseId | string | true | The ID of the use case this notebook is associated with. |
CellSchema
{
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
}
CellSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attachments | object | false | Cell attachments. | |
| cellId | string | true | The ID of the cell. | |
| executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| executionId | string | false | The ID of the execution. | |
| executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| md5 | string | true | The MD5 hash of the cell. | |
| metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellStreamOutput | false | Cell stream output. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellInputRequest | false | Cell input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellErrorOutput | false | Cell error output. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | string | true | The contents of the cell, represented as a string. |
CellVersionActionSchema
{
"description": "Schema for taking an action on a notebook cell.",
"properties": {
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
}
},
"required": [
"md5",
"cellId"
],
"title": "CellVersionActionSchema",
"type": "object"
}
CellVersionActionSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellId | string | true | The ID of the cell. | |
| md5 | string | true | The MD5 hash of the cell. |
ClearCellOutputRequest
{
"description": "Request schema for clearing the output of a notebook cell.",
"properties": {
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
}
},
"required": [
"md5"
],
"title": "ClearCellOutputRequest",
"type": "object"
}
ClearCellOutputRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| md5 | string | true | The MD5 hash of the cell. |
CloneNotebookFromRevisionRequest
{
"description": "Request to clone a notebook from a revision.",
"properties": {
"isAuto": {
"default": false,
"description": "Whether the revision is autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Notebook revision name.",
"minLength": 1,
"title": "Name",
"type": "string"
},
"notebookPath": {
"description": "Path to the notebook file, if using Codespaces.",
"title": "Notebookpath",
"type": "string"
}
},
"title": "CloneNotebookFromRevisionRequest",
"type": "object"
}
CloneNotebookFromRevisionRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isAuto | boolean | false | Whether the revision is autosaved. | |
| name | string | false | minLength: 1 minLength: 1 |
Notebook revision name. |
| notebookPath | string | false | Path to the notebook file, if using Codespaces. |
CloneRepositorySchema
{
"description": "Schema for cloning a repository.",
"properties": {
"checkoutRef": {
"description": "The branch or commit to checkout.",
"title": "Checkoutref",
"type": "string"
},
"url": {
"description": "The URL of the repository to clone.",
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "CloneRepositorySchema",
"type": "object"
}
CloneRepositorySchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| checkoutRef | string | false | The branch or commit to checkout. | |
| url | string | true | The URL of the repository to clone. |
ClonedNotebookResponse
{
"description": "Response schema for cloning a notebook from a revision.",
"properties": {
"notebookId": {
"description": "Newly cloned notebook ID.",
"title": "Notebookid",
"type": "string"
}
},
"required": [
"notebookId"
],
"title": "ClonedNotebookResponse",
"type": "object"
}
ClonedNotebookResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| notebookId | string | true | Newly cloned notebook ID. |
CodeCellSchema
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
}
CodeCellSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellType | SupportedCellTypes | false | Type of the cell. | |
| executionCount | integer | false | Execution count of the cell. | |
| id | string | true | ID of the cell. | |
| metadata | NotebookCellMetadata | false | Metadata of the cell. | |
| outputs | [anyOf] | false | Outputs of the cell. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | ExecuteResultOutputSchema | false | The schema for the execute result output in a notebook cell. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | DisplayDataOutputSchema | false | The schema for the display data output in a notebook cell. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | StreamOutputSchema | false | The schema for the stream output in a notebook cell. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | ErrorOutputSchema | false | The schema for the error output in a notebook cell. |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | any | false | Contents of the cell, represented as a string. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
CodeCompletionResultSchema
{
"description": "The schema for the code completion result.",
"properties": {
"cursorEnd": {
"description": "The end position of the cursor in the code.",
"title": "Cursorend",
"type": "integer"
},
"cursorStart": {
"description": "The start position of the cursor in the code.",
"title": "Cursorstart",
"type": "integer"
},
"matches": {
"description": "The list of code completions.",
"items": {
"type": "string"
},
"title": "Matches",
"type": "array"
}
},
"required": [
"matches",
"cursorStart",
"cursorEnd"
],
"title": "CodeCompletionResultSchema",
"type": "object"
}
CodeCompletionResultSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cursorEnd | integer | true | The end position of the cursor in the code. | |
| cursorStart | integer | true | The start position of the cursor in the code. | |
| matches | [string] | true | The list of code completions. |
CodeCompletionSchema
{
"description": "The schema for the code completion request.",
"properties": {
"code": {
"description": "The code to complete.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition"
],
"title": "CodeCompletionSchema",
"type": "object"
}
CodeCompletionSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | true | The code to complete. | |
| cursorPosition | integer | true | The position of the cursor in the code. |
CodeInspectionResultSchema
{
"description": "The schema for the code inspection result.",
"properties": {
"data": {
"additionalProperties": {
"type": "string"
},
"description": "The inspection result.",
"title": "Data",
"type": "object"
},
"found": {
"description": "True if an object was found, false otherwise.",
"title": "Found",
"type": "boolean"
}
},
"required": [
"data",
"found"
],
"title": "CodeInspectionResultSchema",
"type": "object"
}
CodeInspectionResultSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | object | true | The inspection result. | |
| » additionalProperties | string | false | none | |
| found | boolean | true | True if an object was found, false otherwise. |
CodeInspectionSchema
{
"description": "The schema for the code inspection request.",
"properties": {
"code": {
"description": "The code to inspect.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
},
"detailLevel": {
"description": "The detail level of the inspection. Possible values are 0 and 1.",
"title": "Detaillevel",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition",
"detailLevel"
],
"title": "CodeInspectionSchema",
"type": "object"
}
CodeInspectionSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | true | The code to inspect. | |
| cursorPosition | integer | true | The position of the cursor in the code. | |
| detailLevel | integer | true | The detail level of the inspection. Possible values are 0 and 1. |
CodeSnippet
{
"description": "CodeSnippet represents a code snippet.",
"properties": {
"code": {
"description": "The code snippet code content.",
"title": "Code",
"type": "string"
},
"description": {
"description": "The description of the code snippet.",
"title": "Description",
"type": "string"
},
"id": {
"description": "The ID of the code snippet.",
"title": "Id",
"type": "string"
},
"language": {
"description": "The programming language of the code snippet.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version of the code snippet.",
"title": "Languageversion",
"type": "string"
},
"locale": {
"description": "The language locale of the code snippet.",
"title": "Locale",
"type": "string"
},
"tags": {
"description": "A comma separated list of snippet tags.",
"title": "Tags",
"type": "string"
},
"title": {
"description": "The title of the code snippet.",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"locale",
"title",
"description",
"code",
"language",
"languageVersion"
],
"title": "CodeSnippet",
"type": "object"
}
CodeSnippet
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | true | The code snippet code content. | |
| description | string | true | The description of the code snippet. | |
| id | string | true | The ID of the code snippet. | |
| language | string | true | The programming language of the code snippet. | |
| languageVersion | string | true | The programming language version of the code snippet. | |
| locale | string | true | The language locale of the code snippet. | |
| tags | string | false | A comma separated list of snippet tags. | |
| title | string | true | The title of the code snippet. |
ConvertToCodespaceRequest
{
"description": "Request schema for converting a notebook to a codespace.",
"properties": {
"useCaseDescription": {
"description": "The description of the Use Case.",
"maxLength": 500,
"title": "Usecasedescription",
"type": "string"
},
"useCaseId": {
"description": "The ID of the Use Case to associate the notebook with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case to associate the notebook with.",
"title": "Usecasename",
"type": "string"
}
},
"title": "ConvertToCodespaceRequest",
"type": "object"
}
ConvertToCodespaceRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| useCaseDescription | string | false | maxLength: 500 |
The description of the Use Case. |
| useCaseId | string | false | The ID of the Use Case to associate the notebook with. | |
| useCaseName | string | false | The name of the Use Case to associate the notebook with. |
CopyFilesystemObjectRequest
{
"description": "Copy filesystem object request schema.",
"properties": {
"operations": {
"description": "List of source-destination pairs.",
"items": {
"description": "Source and destination schema for filesystem object operations.",
"properties": {
"destination": {
"description": "Destination path.",
"title": "Destination",
"type": "string"
},
"source": {
"description": "Source path.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"destination"
],
"title": "SourceDestinationSchema",
"type": "object"
},
"title": "Operations",
"type": "array"
},
"overrideExisting": {
"default": false,
"description": "Whether to override existing files or directories.",
"title": "Overrideexisting",
"type": "boolean"
}
},
"title": "CopyFilesystemObjectRequest",
"type": "object"
}
CopyFilesystemObjectRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operations | [SourceDestinationSchema] | false | List of source-destination pairs. | |
| overrideExisting | boolean | false | Whether to override existing files or directories. |
CreateAndStartCodespaceSchema
{
"description": "Schema for creating and starting a codespace.",
"properties": {
"cloneRepository": {
"allOf": [
{
"description": "Schema for cloning a repository.",
"properties": {
"checkoutRef": {
"description": "The branch or commit to checkout.",
"title": "Checkoutref",
"type": "string"
},
"url": {
"description": "The URL of the repository to clone.",
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "CloneRepositorySchema",
"type": "object"
}
],
"description": "The repository to clone for the codespace.",
"title": "Clonerepository"
},
"description": {
"description": "The description of the codespace.",
"title": "Description",
"type": "string"
},
"environment": {
"allOf": [
{
"description": "Request schema for assigning an execution environment to a notebook.",
"properties": {
"environmentId": {
"description": "The execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"environmentSlug": {
"description": "The execution environment slug.",
"title": "Environmentslug",
"type": "string"
},
"language": {
"description": "The programming language of the environment.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version.",
"title": "Languageversion",
"type": "string"
},
"machineId": {
"description": "The machine ID.",
"title": "Machineid",
"type": "string"
},
"machineSlug": {
"description": "The machine slug.",
"title": "Machineslug",
"type": "string"
},
"timeToLive": {
"description": "Inactivity timeout limit.",
"maximum": 525600,
"minimum": 3,
"title": "Timetolive",
"type": "integer"
},
"versionId": {
"description": "The execution environment version ID.",
"title": "Versionid",
"type": "string"
}
},
"title": "ExecutionEnvironmentAssignRequest",
"type": "object"
}
],
"description": "The environment for the codespace.",
"title": "Environment"
},
"environmentVariables": {
"description": "The environment variables for the codespace.",
"items": {
"description": "Schema for updating environment variables.",
"properties": {
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"pattern": "^[a-zA-Z_$][\\w$]*$",
"title": "Name",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "NewEnvironmentVariableSchema",
"type": "object"
},
"title": "Environmentvariables",
"type": "array"
},
"exposedPorts": {
"description": "The exposed ports for the codespace.",
"items": {
"description": "Port creation schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "ExposePortSchema",
"type": "object"
},
"title": "Exposedports",
"type": "array"
},
"name": {
"default": "Untitled Codespace",
"description": "The name of the codespace.",
"title": "Name",
"type": "string"
},
"openFilePaths": {
"description": "The file paths to open in the codespace.",
"items": {
"type": "string"
},
"title": "Openfilepaths",
"type": "array"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"description": "The settings for the codespace.",
"title": "Settings"
},
"tags": {
"description": "The tags associated with the codespace.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"useCaseId": {
"description": "The ID of the use case associated with the codespace.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId"
],
"title": "CreateAndStartCodespaceSchema",
"type": "object"
}
CreateAndStartCodespaceSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cloneRepository | CloneRepositorySchema | false | The repository to clone for the codespace. | |
| description | string | false | The description of the codespace. | |
| environment | ExecutionEnvironmentAssignRequest | false | The environment for the codespace. | |
| environmentVariables | [NewEnvironmentVariableSchema] | false | The environment variables for the codespace. | |
| exposedPorts | [ExposePortSchema] | false | The exposed ports for the codespace. | |
| name | string | false | The name of the codespace. | |
| openFilePaths | [string] | false | The file paths to open in the codespace. | |
| settings | NotebookSettings | false | The settings for the codespace. | |
| tags | [string] | false | The tags associated with the codespace. | |
| useCaseId | string | true | The ID of the use case associated with the codespace. |
CreateCellRequest
{
"description": "Request schema for creating a notebook cell.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "The ID of the cell after which to create the new cell.",
"title": "Aftercellid"
},
"attachments": {
"description": "The attachments associated with the cell.",
"title": "Attachments",
"type": "object"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata associated with the cell.",
"title": "Metadata"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"afterCellId",
"source"
],
"title": "CreateCellRequest",
"type": "object"
}
CreateCellRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| afterCellId | any | true | The ID of the cell after which to create the new cell. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attachments | object | false | The attachments associated with the cell. | |
| metadata | NotebookCellMetadata | false | The metadata associated with the cell. | |
| source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| anonymous | FIRST |
CreateCellsRequest
{
"description": "Request payload values for creating notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cells": {
"description": "List of cells to create.",
"items": {
"description": "The schema for the cells to be inserted into a notebook.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "ID of the cell after which to insert the new cell.",
"title": "Aftercellid"
},
"data": {
"allOf": [
{
"description": "The schema for the notebook cell to be created.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell to create."
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"cellType"
],
"title": "CreateNotebookCellSchema",
"type": "object"
}
],
"description": "The cell data to insert.",
"title": "Data"
}
},
"required": [
"afterCellId",
"data"
],
"title": "InsertCellsSchema",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cells"
],
"title": "CreateCellsRequest",
"type": "object"
}
CreateCellsRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionId | string | false | maxLength: 64 |
Action ID of notebook update request. |
| cells | [InsertCellsSchema] | true | List of cells to create. | |
| generation | integer | true | Integer representing the generation of the notebook. | |
| path | string | true | Path to the notebook. |
CreateCellsResponse
{
"description": "Response schema for creating notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
},
"cellIds": {
"description": "List of cell IDs of the created cells.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"required": [
"actionId",
"cellIds"
],
"title": "CreateCellsResponse",
"type": "object"
}
CreateCellsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionId | string | true | Action ID of the notebook update request. | |
| cellIds | [string] | true | List of cell IDs of the created cells. |
CreateEnvironmentVariablesRequestSchema
{
"description": "Create environment variables request schema.",
"properties": {
"data": {
"description": "List of environment variables to create.",
"items": {
"description": "Schema for updating environment variables.",
"properties": {
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"pattern": "^[a-zA-Z_$][\\w$]*$",
"title": "Name",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "NewEnvironmentVariableSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "CreateEnvironmentVariablesRequestSchema",
"type": "object"
}
CreateEnvironmentVariablesRequestSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [NewEnvironmentVariableSchema] | false | List of environment variables to create. |
CreateFilesystemObjectRequest
{
"description": "Create a new filesystem object request schema.",
"properties": {
"isDirectory": {
"description": "Whether the filesystem object is a directory or not.",
"title": "Isdirectory",
"type": "boolean"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"isDirectory"
],
"title": "CreateFilesystemObjectRequest",
"type": "object"
}
CreateFilesystemObjectRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isDirectory | boolean | true | Whether the filesystem object is a directory or not. | |
| path | string | true | Path to the filesystem object. |
CreateManualRunRequest
{
"description": "Request to create a manual run for a scheduled job.",
"properties": {
"manualRunType": {
"allOf": [
{
"description": "Intentionally a subset of RunTypes above - to be used in API schemas",
"enum": [
"manual",
"pipeline"
],
"title": "ManualRunTypes",
"type": "string"
}
],
"default": "manual",
"description": "The type of manual run. Possible values are 'manual' or 'pipeline'."
},
"notebookId": {
"description": "The ID of the notebook to schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"title": {
"description": "The title of the scheduled job.",
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"notebookId"
],
"title": "CreateManualRunRequest",
"type": "object"
}
CreateManualRunRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| manualRunType | ManualRunTypes | false | The type of manual run. Possible values are 'manual' or 'pipeline'. | |
| notebookId | string | true | The ID of the notebook to schedule. | |
| notebookPath | string | false | The path to the notebook in the file system if a Codespace is being used. | |
| parameters | [ScheduledJobParam] | false | The parameters to pass to the notebook when it runs. | |
| title | string | false | maxLength: 100 minLength: 1 minLength: 1 |
The title of the scheduled job. |
CreateNotebookCellSchema
{
"description": "The schema for the notebook cell to be created.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell to create."
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"cellType"
],
"title": "CreateNotebookCellSchema",
"type": "object"
}
CreateNotebookCellSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellType | SupportedCellTypes | true | Type of the cell to create. | |
| metadata | NotebookCellMetadata | false | Metadata of the cell. | |
| source | any | false | Contents of the cell, represented as a string. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
CreateNotebookRequest
{
"description": "Request schema for creating a notebook.",
"properties": {
"createInitialCell": {
"default": true,
"description": "Whether to create an initial cell.",
"title": "Createinitialcell",
"type": "boolean"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"name": {
"default": "Untitled Notebook",
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"title": "CreateNotebookRequest",
"type": "object"
}
CreateNotebookRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createInitialCell | boolean | false | Whether to create an initial cell. | |
| description | string | false | The description of the notebook. | |
| name | string | false | The name of the notebook. | |
| settings | NotebookSettings | false | The settings of the notebook. | |
| tags | [string] | false | The tags of the notebook. | |
| type | NotebookType | false | The type of the notebook. | |
| typeTransition | NotebookTypeTransition | false | The type transition of the notebook. | |
| useCaseId | string | false | The ID of the Use Case associated with the notebook. | |
| useCaseName | string | false | The name of the Use Case associated with the notebook. |
CreateNotebookRevisionRequest
{
"description": "Request to create a new notebook revision.",
"properties": {
"isAuto": {
"default": false,
"description": "Whether the revision is autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Notebook revision name.",
"minLength": 1,
"title": "Name",
"type": "string"
},
"notebookPath": {
"description": "Path to the notebook file, if using Codespaces.",
"title": "Notebookpath",
"type": "string"
}
},
"title": "CreateNotebookRevisionRequest",
"type": "object"
}
CreateNotebookRevisionRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isAuto | boolean | false | Whether the revision is autosaved. | |
| name | string | false | minLength: 1 minLength: 1 |
Notebook revision name. |
| notebookPath | string | false | Path to the notebook file, if using Codespaces. |
CreateScheduledJobRequest
{
"description": "Request to create a new scheduled job.",
"properties": {
"enabled": {
"default": true,
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"notebookId": {
"description": "The ID of the notebook to schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule for the job.",
"title": "Schedule"
},
"title": {
"description": "The title of the scheduled job.",
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId",
"notebookId",
"schedule"
],
"title": "CreateScheduledJobRequest",
"type": "object"
}
CreateScheduledJobRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| enabled | boolean | false | Whether the job is enabled. | |
| notebookId | string | true | The ID of the notebook to schedule. | |
| notebookPath | string | false | The path to the notebook in the file system if a Codespace is being used. | |
| parameters | [ScheduledJobParam] | false | The parameters to pass to the notebook when it runs. | |
| schedule | Schedule | true | The schedule for the job. | |
| title | string | false | maxLength: 100 minLength: 1 minLength: 1 |
The title of the scheduled job. |
| useCaseId | string | true | The ID of the use case this notebook is associated with. |
CreateTerminalSchema
{
"description": "Schema for creating a terminal.",
"properties": {
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "CreateTerminalSchema",
"type": "object"
}
CreateTerminalSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | Name of the terminal. |
DRFileMetadata
{
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
}
DRFileMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| commandArgs | string | false | Command arguments for the file. |
DRFilesystemMetadataResponse
{
"description": "Response schema for DataRobot filesystem metadata.",
"properties": {
"datarobotMetadata": {
"additionalProperties": {
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
},
"description": "Metadata for the files.",
"title": "Datarobotmetadata",
"type": "object"
}
},
"required": [
"datarobotMetadata"
],
"title": "DRFilesystemMetadataResponse",
"type": "object"
}
DRFilesystemMetadataResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| datarobotMetadata | object | true | Metadata for the files. | |
| » additionalProperties | DRFileMetadata | false | Metadata for DataRobot files. |
DataFrameEntrySchema
{
"description": "Schema for a single DataFrame entry.",
"properties": {
"name": {
"description": "Name of the DataFrame.",
"title": "Name",
"type": "string"
},
"type": {
"description": "Type of the DataFrame.",
"title": "Type",
"type": "string"
}
},
"required": [
"name",
"type"
],
"title": "DataFrameEntrySchema",
"type": "object"
}
DataFrameEntrySchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | Name of the DataFrame. | |
| type | string | true | Type of the DataFrame. |
DataFrameResponseSchema
{
"description": "Schema for the DataFrame response.",
"properties": {
"dataframe": {
"description": "The DataFrame as a string.",
"title": "Dataframe",
"type": "string"
}
},
"required": [
"dataframe"
],
"title": "DataFrameResponseSchema",
"type": "object"
}
DataFrameResponseSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dataframe | string | true | The DataFrame as a string. |
DeleteFilesystemObjectsRequest
{
"description": "Delete filesystem object request schema.",
"properties": {
"paths": {
"description": "List of paths to delete.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "DeleteFilesystemObjectsRequest",
"type": "object"
}
DeleteFilesystemObjectsRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| paths | [string] | false | List of paths to delete. |
DeleteScheduledJobQuery
{
"description": "Query parameters for deleting a scheduled job.",
"properties": {
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId"
],
"title": "DeleteScheduledJobQuery",
"type": "object"
}
DeleteScheduledJobQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| useCaseId | string | true | The ID of the use case this notebook is associated with. |
DirHierarchyObjectSchema
{
"description": "These are only directories\n\nThe name property can be any string or the constant/sentinel \"root\"",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"root"
],
"type": "string"
}
],
"description": "Name of the directory.",
"title": "Name"
},
"path": {
"description": "Path to the directory.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path"
],
"title": "DirHierarchyObjectSchema",
"type": "object"
}
DirHierarchyObjectSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | any | true | Name of the directory. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| path | string | true | Path to the directory. |
Enumerated Values¶
| Property | Value |
|---|---|
| anonymous | root |
DisplayDataOutputSchema
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
}
DisplayDataOutputSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | object | false | Data of the output. | |
| » additionalProperties | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | any | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | object | false | Metadata of the output. | |
| outputType | string | false | Type of the output. |
DownloadFilesystemObjectsQuery
{
"description": "Query schema for downloading filesystem objects.",
"properties": {
"paths": {
"description": "List of paths to download.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "DownloadFilesystemObjectsQuery",
"type": "object"
}
DownloadFilesystemObjectsQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| paths | [string] | false | List of paths to download. |
DownloadFilesystemObjectsRequest
{
"description": "Query schema for downloading filesystem objects.",
"properties": {
"paths": {
"description": "List of paths to download.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "DownloadFilesystemObjectsRequest",
"type": "object"
}
DownloadFilesystemObjectsRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| paths | [string] | false | List of paths to download. |
EntityLinkingSources
{
"description": "The source of the entity linking. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"classic",
"nextGen",
"api"
],
"title": "EntityLinkingSources",
"type": "string"
}
EntityLinkingSources
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| EntityLinkingSources | string | false | The source of the entity linking. Does not affect the operation of the API call. Only used for analytics. |
Enumerated Values¶
| Property | Value |
|---|---|
| EntityLinkingSources | [classic, nextGen, api] |
EntityLinkingWorkflows
{
"description": "The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"migration",
"creation",
"unspecified"
],
"title": "EntityLinkingWorkflows",
"type": "string"
}
EntityLinkingWorkflows
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| EntityLinkingWorkflows | string | false | The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics. |
Enumerated Values¶
| Property | Value |
|---|---|
| EntityLinkingWorkflows | [migration, creation, unspecified] |
EnvironmentPublic
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
EnvironmentPublic
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| image | ImagePublic | true | The image of the environment. | |
| machine | Machine | true | The machine of the environment. | |
| timeToLive | integer | false | The inactivity timeout of the environment. |
EnvironmentSupplementalMetadata
{
"description": "Supplemental metadata for an environment.",
"properties": {
"id": {
"description": "The ID of the environment.",
"title": "Id",
"type": "string"
},
"label": {
"description": "The label of the environment.",
"title": "Label",
"type": "string"
},
"name": {
"description": "The name of the environment.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"label"
],
"title": "EnvironmentSupplementalMetadata",
"type": "object"
}
EnvironmentSupplementalMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the environment. | |
| label | string | true | The label of the environment. | |
| name | string | true | The name of the environment. |
EnvironmentVariableResourceType
{
"description": "An enumeration.",
"enum": [
"notebook"
],
"title": "EnvironmentVariableResourceType",
"type": "string"
}
EnvironmentVariableResourceType
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| EnvironmentVariableResourceType | string | false | An enumeration. |
Enumerated Values¶
| Property | Value |
|---|---|
| EnvironmentVariableResourceType | notebook |
EnvironmentVariableSchema
{
"description": "Environment variable schema.",
"properties": {
"assignedResourceId": {
"description": "The resource ID to which the environment variable is assigned.",
"title": "Assignedresourceid",
"type": "string"
},
"assignedResourceType": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"notebook"
],
"title": "EnvironmentVariableResourceType",
"type": "string"
}
],
"default": "notebook",
"description": "The resource type to which the environment variable is assigned."
},
"createdAt": {
"description": "The date and time when the environment variable was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the environment variable.",
"title": "Createdby",
"type": "string"
},
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"id": {
"description": "The environment variable ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"title": "Name",
"type": "string"
},
"updatedAt": {
"description": "The date and time when the environment variable was last updated.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the environment variable.",
"title": "Updatedby",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value",
"id",
"assignedResourceId",
"createdBy",
"createdAt"
],
"title": "EnvironmentVariableSchema",
"type": "object"
}
EnvironmentVariableSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| assignedResourceId | string | true | The resource ID to which the environment variable is assigned. | |
| assignedResourceType | EnvironmentVariableResourceType | false | The resource type to which the environment variable is assigned. | |
| createdAt | string(date-time) | true | The date and time when the environment variable was created. | |
| createdBy | string | true | The ID of the user who created the environment variable. | |
| description | string | false | maxLength: 500 |
The description of the environment variable. |
| id | string | true | The environment variable ID. | |
| name | string | true | maxLength: 253 |
The name of the environment variable. |
| updatedAt | string(date-time) | false | The date and time when the environment variable was last updated. | |
| updatedBy | string | false | The ID of the user who last updated the environment variable. | |
| value | string | true | maxLength: 131072 |
The value of the environment variable. |
EnvironmentVariablesResponseSchema
{
"description": "List environment variables response schema.",
"properties": {
"data": {
"description": "List of environment variables",
"items": {
"description": "Environment variable schema.",
"properties": {
"assignedResourceId": {
"description": "The resource ID to which the environment variable is assigned.",
"title": "Assignedresourceid",
"type": "string"
},
"assignedResourceType": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"notebook"
],
"title": "EnvironmentVariableResourceType",
"type": "string"
}
],
"default": "notebook",
"description": "The resource type to which the environment variable is assigned."
},
"createdAt": {
"description": "The date and time when the environment variable was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the environment variable.",
"title": "Createdby",
"type": "string"
},
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"id": {
"description": "The environment variable ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"title": "Name",
"type": "string"
},
"updatedAt": {
"description": "The date and time when the environment variable was last updated.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the environment variable.",
"title": "Updatedby",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value",
"id",
"assignedResourceId",
"createdBy",
"createdAt"
],
"title": "EnvironmentVariableSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "EnvironmentVariablesResponseSchema",
"type": "object"
}
EnvironmentVariablesResponseSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [EnvironmentVariableSchema] | false | List of environment variables |
EphemeralSessionEntityType
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
EphemeralSessionEntityType
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| EphemeralSessionEntityType | string | false | Types of entities that can be associated with an ephemeral session. |
Enumerated Values¶
| Property | Value |
|---|---|
| EphemeralSessionEntityType | [CUSTOM_APP, CUSTOM_JOB, CUSTOM_MODEL, CUSTOM_METRIC, CODE_SNIPPET] |
EphemeralSessionKey
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
EphemeralSessionKey
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| entityId | string | true | The ID of the entity. | |
| entityType | EphemeralSessionEntityType | true | The type of the entity. |
ErrorOutputSchema
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
ErrorOutputSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ename | string | true | Error name. | |
| evalue | string | true | Error value. | |
| outputType | string | false | Type of the output. | |
| traceback | [string] | false | Traceback of the error. |
ExecuteCellsRequest
{
"description": "Request payload values for executing notebook cells.",
"properties": {
"cellIds": {
"description": "List of cell IDs to execute.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"cells": {
"description": "List of cells to execute.",
"items": {
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType",
"source"
],
"title": "NotebookCellExecData",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"generation",
"cells"
],
"title": "ExecuteCellsRequest",
"type": "object"
}
ExecuteCellsRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellIds | [string] | false | List of cell IDs to execute. | |
| cells | [NotebookCellExecData] | true | List of cells to execute. | |
| generation | integer | true | Integer representing the generation of the notebook. | |
| path | string | true | Path to the notebook. |
ExecuteCodeRequest
{
"properties": {
"code": {
"description": "The code to execute.",
"title": "Code",
"type": "string"
}
},
"required": [
"code"
],
"title": "ExecuteCodeRequest",
"type": "object"
}
ExecuteCodeRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | true | The code to execute. |
ExecuteFileResponse
{
"description": "Response schema for executing a file.",
"properties": {
"kernelId": {
"description": "ID of the kernel assigned to the file.",
"title": "Kernelid",
"type": "string"
}
},
"required": [
"kernelId"
],
"title": "ExecuteFileResponse",
"type": "object"
}
ExecuteFileResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kernelId | string | true | ID of the kernel assigned to the file. |
ExecuteResultOutputSchema
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
}
ExecuteResultOutputSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | object | false | Data of the output. | |
| » additionalProperties | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | any | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| executionCount | integer | false | Execution count of the output. | |
| metadata | object | false | Metadata of the output. | |
| outputType | string | false | Type of the output. |
ExecutingFileData
{
"description": "Schema for executing file information.",
"properties": {
"filePath": {
"description": "Path to the file being executed.",
"title": "Filepath",
"type": "string"
},
"kernelId": {
"description": "ID of the kernel assigned to the file.",
"title": "Kernelid",
"type": "string"
}
},
"required": [
"kernelId",
"filePath"
],
"title": "ExecutingFileData",
"type": "object"
}
ExecutingFileData
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| filePath | string | true | Path to the file being executed. | |
| kernelId | string | true | ID of the kernel assigned to the file. |
ExecutingFilesResponse
{
"description": "Response schema for listing executing files.",
"properties": {
"executingFiles": {
"description": "List of executing files with their kernel IDs.",
"items": {
"description": "Schema for executing file information.",
"properties": {
"filePath": {
"description": "Path to the file being executed.",
"title": "Filepath",
"type": "string"
},
"kernelId": {
"description": "ID of the kernel assigned to the file.",
"title": "Kernelid",
"type": "string"
}
},
"required": [
"kernelId",
"filePath"
],
"title": "ExecutingFileData",
"type": "object"
},
"title": "Executingfiles",
"type": "array"
}
},
"required": [
"executingFiles"
],
"title": "ExecutingFilesResponse",
"type": "object"
}
ExecutingFilesResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| executingFiles | [ExecutingFileData] | true | List of executing files with their kernel IDs. |
ExecutionEnvironmentAssignRequest
{
"description": "Request schema for assigning an execution environment to a notebook.",
"properties": {
"environmentId": {
"description": "The execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"environmentSlug": {
"description": "The execution environment slug.",
"title": "Environmentslug",
"type": "string"
},
"language": {
"description": "The programming language of the environment.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version.",
"title": "Languageversion",
"type": "string"
},
"machineId": {
"description": "The machine ID.",
"title": "Machineid",
"type": "string"
},
"machineSlug": {
"description": "The machine slug.",
"title": "Machineslug",
"type": "string"
},
"timeToLive": {
"description": "Inactivity timeout limit.",
"maximum": 525600,
"minimum": 3,
"title": "Timetolive",
"type": "integer"
},
"versionId": {
"description": "The execution environment version ID.",
"title": "Versionid",
"type": "string"
}
},
"title": "ExecutionEnvironmentAssignRequest",
"type": "object"
}
ExecutionEnvironmentAssignRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| environmentId | string | false | The execution environment ID. | |
| environmentSlug | string | false | The execution environment slug. | |
| language | string | false | The programming language of the environment. | |
| languageVersion | string | false | The programming language version. | |
| machineId | string | false | The machine ID. | |
| machineSlug | string | false | The machine slug. | |
| timeToLive | integer | false | maximum: 525600 minimum: 3 |
Inactivity timeout limit. |
| versionId | string | false | The execution environment version ID. |
ExecutionEnvironmentSchema
{
"properties": {
"created": {
"description": "The time the environment was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Execution environment description.",
"title": "Description",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the environment is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Execution environment ID.",
"title": "Id",
"type": "string"
},
"isBuiltIn": {
"default": false,
"description": "Whether the environment is a built-in environment supplied by DataRobot.",
"title": "Isbuiltin",
"type": "boolean"
},
"isDownloadable": {
"description": "Whether the environment is downloadable.",
"title": "Isdownloadable",
"type": "boolean"
},
"isPublic": {
"description": "Whether the environment is public.",
"title": "Ispublic",
"type": "boolean"
},
"latestSuccessfulVersion": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"latestVersion": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"name": {
"description": "Execution environment name.",
"title": "Name",
"type": "string"
},
"programmingLanguage": {
"description": "Programming language of the environment.",
"title": "Programminglanguage",
"type": "string"
},
"requiredMetadataKeys": {
"description": "Required metadata keys.",
"items": {
"description": "Define additional parameters required to assemble a model. Model versions using this environment must define values\nfor each fieldName in the requiredMetadata.",
"properties": {
"displayName": {
"description": "A human readable name for the required field.",
"title": "Displayname",
"type": "string"
},
"fieldName": {
"description": "The required field key. This value is added as an environment variable when running custom models.",
"title": "Fieldname",
"type": "string"
}
},
"required": [
"fieldName",
"displayName"
],
"title": "RequiredMetadataKey",
"type": "object"
},
"title": "Requiredmetadatakeys",
"type": "array"
},
"useCases": {
"description": "List of use cases for the environment. This includes 'notebooks', at a minimum .",
"items": {
"type": "string"
},
"title": "Usecases",
"type": "array"
},
"username": {
"description": "The username of the user who created the environment.",
"title": "Username",
"type": "string"
}
},
"required": [
"id",
"isDownloadable",
"isPublic",
"name",
"programmingLanguage",
"created",
"latestVersion",
"latestSuccessfulVersion",
"username"
],
"title": "ExecutionEnvironmentSchema",
"type": "object"
}
ExecutionEnvironmentSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created | string(date-time) | true | The time the environment was created. | |
| description | string | false | Execution environment description. | |
| gpuOptimized | boolean | false | Whether the environment is GPU optimized. | |
| id | string | true | Execution environment ID. | |
| isBuiltIn | boolean | false | Whether the environment is a built-in environment supplied by DataRobot. | |
| isDownloadable | boolean | true | Whether the environment is downloadable. | |
| isPublic | boolean | true | Whether the environment is public. | |
| latestSuccessfulVersion | ExecutionEnvironmentVersionSchema | true | Execution environment version schema. | |
| latestVersion | ExecutionEnvironmentVersionSchema | true | Execution environment version schema. | |
| name | string | true | Execution environment name. | |
| programmingLanguage | string | true | Programming language of the environment. | |
| requiredMetadataKeys | [RequiredMetadataKey] | false | Required metadata keys. | |
| useCases | [string] | false | List of use cases for the environment. This includes 'notebooks', at a minimum . | |
| username | string | true | The username of the user who created the environment. |
ExecutionEnvironmentUsageByNotebooks
{
"description": "Notebook using a specific execution environment.",
"properties": {
"createdAt": {
"description": "The time the notebook was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created the notebook.",
"title": "Createdby",
"type": "string"
},
"environmentVersion": {
"description": "The version of the environment used by the notebook.",
"title": "Environmentversion",
"type": "string"
},
"notebookId": {
"description": "Notebook ID.",
"title": "Notebookid",
"type": "string"
},
"notebookLastSession": {
"description": "The last time the notebook was started.",
"format": "date-time",
"title": "Notebooklastsession",
"type": "string"
},
"notebookName": {
"description": "Notebook name.",
"title": "Notebookname",
"type": "string"
},
"useCaseId": {
"description": "The use case ID of the notebook.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"notebookId",
"notebookName",
"createdAt",
"environmentVersion"
],
"title": "ExecutionEnvironmentUsageByNotebooks",
"type": "object"
}
ExecutionEnvironmentUsageByNotebooks
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | The time the notebook was created. | |
| createdBy | string | false | The username of the user who created the notebook. | |
| environmentVersion | string | true | The version of the environment used by the notebook. | |
| notebookId | string | true | Notebook ID. | |
| notebookLastSession | string(date-time) | false | The last time the notebook was started. | |
| notebookName | string | true | Notebook name. | |
| useCaseId | string | false | The use case ID of the notebook. |
ExecutionEnvironmentUsageByNotebooksQuery
{
"description": "Query parameters for listing notebooks using a specific execution environment.",
"properties": {
"limit": {
"default": 10,
"description": "The limit or results to return.",
"exclusiveMinimum": 0,
"maximum": 100,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "The offset to use when querying paginated results.",
"minimum": 0,
"title": "Offset",
"type": "integer"
}
},
"title": "ExecutionEnvironmentUsageByNotebooksQuery",
"type": "object"
}
ExecutionEnvironmentUsageByNotebooksQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| limit | integer | false | maximum: 100 |
The limit or results to return. |
| offset | integer | false | minimum: 0 |
The offset to use when querying paginated results. |
ExecutionEnvironmentUsageByNotebooksResponse
{
"description": "Response schema for listing notebooks using a specific execution environment.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebooks using the environment.",
"items": {
"description": "Notebook using a specific execution environment.",
"properties": {
"createdAt": {
"description": "The time the notebook was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created the notebook.",
"title": "Createdby",
"type": "string"
},
"environmentVersion": {
"description": "The version of the environment used by the notebook.",
"title": "Environmentversion",
"type": "string"
},
"notebookId": {
"description": "Notebook ID.",
"title": "Notebookid",
"type": "string"
},
"notebookLastSession": {
"description": "The last time the notebook was started.",
"format": "date-time",
"title": "Notebooklastsession",
"type": "string"
},
"notebookName": {
"description": "Notebook name.",
"title": "Notebookname",
"type": "string"
},
"useCaseId": {
"description": "The use case ID of the notebook.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"notebookId",
"notebookName",
"createdAt",
"environmentVersion"
],
"title": "ExecutionEnvironmentUsageByNotebooks",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ExecutionEnvironmentUsageByNotebooksResponse",
"type": "object"
}
ExecutionEnvironmentUsageByNotebooksResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [ExecutionEnvironmentUsageByNotebooks] | false | List of notebooks using the environment. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. |
ExecutionEnvironmentVersionSchema
{
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
}
ExecutionEnvironmentVersionSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| buildStatus | string | true | Build status of the environment version. Possible values: 'success', 'failed'. | |
| created | string(date-time) | true | The time the environment version was created. | |
| description | string | false | Description of the environment version. | |
| dockerContext | string | false | URL for downloading the Docker context of the environment version. | |
| dockerContextSize | integer | false | Size of the Docker context in bytes. | |
| dockerImage | string | false | URL for downloading the Docker image of the environment version. | |
| dockerImageSize | integer | false | Size of the Docker image in bytes. | |
| environmentId | string | true | Execution environment ID. | |
| id | string | true | Execution environment version ID. | |
| imageId | string | false | Image ID of the environment version. | |
| label | string | false | Label of the environment version. | |
| libraries | [string] | false | List of libraries in the environment version. | |
| sourceDockerImageUri | string | false | The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions. |
ExecutionEnvironmentVersionsResponse
{
"description": "Response schema for listing execution environment versions.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of environment versions.",
"items": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ExecutionEnvironmentVersionsResponse",
"type": "object"
}
ExecutionEnvironmentVersionsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [ExecutionEnvironmentVersionSchema] | false | List of environment versions. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. |
ExecutionEnvironmentsResponse
{
"description": "Response schema for listing execution environments.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of execution environments.",
"items": {
"properties": {
"created": {
"description": "The time the environment was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Execution environment description.",
"title": "Description",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the environment is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Execution environment ID.",
"title": "Id",
"type": "string"
},
"isBuiltIn": {
"default": false,
"description": "Whether the environment is a built-in environment supplied by DataRobot.",
"title": "Isbuiltin",
"type": "boolean"
},
"isDownloadable": {
"description": "Whether the environment is downloadable.",
"title": "Isdownloadable",
"type": "boolean"
},
"isPublic": {
"description": "Whether the environment is public.",
"title": "Ispublic",
"type": "boolean"
},
"latestSuccessfulVersion": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"latestVersion": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"name": {
"description": "Execution environment name.",
"title": "Name",
"type": "string"
},
"programmingLanguage": {
"description": "Programming language of the environment.",
"title": "Programminglanguage",
"type": "string"
},
"requiredMetadataKeys": {
"description": "Required metadata keys.",
"items": {
"description": "Define additional parameters required to assemble a model. Model versions using this environment must define values\nfor each fieldName in the requiredMetadata.",
"properties": {
"displayName": {
"description": "A human readable name for the required field.",
"title": "Displayname",
"type": "string"
},
"fieldName": {
"description": "The required field key. This value is added as an environment variable when running custom models.",
"title": "Fieldname",
"type": "string"
}
},
"required": [
"fieldName",
"displayName"
],
"title": "RequiredMetadataKey",
"type": "object"
},
"title": "Requiredmetadatakeys",
"type": "array"
},
"useCases": {
"description": "List of use cases for the environment. This includes 'notebooks', at a minimum .",
"items": {
"type": "string"
},
"title": "Usecases",
"type": "array"
},
"username": {
"description": "The username of the user who created the environment.",
"title": "Username",
"type": "string"
}
},
"required": [
"id",
"isDownloadable",
"isPublic",
"name",
"programmingLanguage",
"created",
"latestVersion",
"latestSuccessfulVersion",
"username"
],
"title": "ExecutionEnvironmentSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ExecutionEnvironmentsResponse",
"type": "object"
}
ExecutionEnvironmentsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [ExecutionEnvironmentSchema] | false | List of execution environments. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. |
ExecutionStatusSchema
{
"description": "Schema for the execution status of a notebook session.",
"properties": {
"cellId": {
"description": "The ID of the cell currently being executed.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Info related to when the execution was completed.",
"title": "Executed"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
},
"status": {
"allOf": [
{
"description": "Kernel execution status.",
"enum": [
"busy",
"idle"
],
"title": "KernelExecutionStatus",
"type": "string"
}
],
"description": "The status of the kernel execution. Possible values are 'busy' or 'idle'."
},
"submitted": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Info related to when the execution request was submitted.",
"title": "Submitted"
}
},
"required": [
"status",
"notebookId"
],
"title": "ExecutionStatusSchema",
"type": "object"
}
ExecutionStatusSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellId | string | false | The ID of the cell currently being executed. | |
| executed | NotebookActionSignature | false | Info related to when the execution was completed. | |
| inputRequest | AwaitingInputState | false | The input request state of the cell. | |
| notebookId | string | true | The ID of the notebook. | |
| queuedCellIds | [string] | false | The IDs of the cells that are queued for execution. | |
| status | KernelExecutionStatus | true | The status of the kernel execution. Possible values are 'busy' or 'idle'. | |
| submitted | NotebookActionSignature | false | Info related to when the execution request was submitted. |
ExportNotebookQuerySchema
{
"description": "Query parameters for exporting a notebook.",
"properties": {
"includeOutput": {
"default": true,
"description": "Whether to include the cell output of the notebook in the export.",
"title": "Includeoutput",
"type": "boolean"
}
},
"title": "ExportNotebookQuerySchema",
"type": "object"
}
ExportNotebookQuerySchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| includeOutput | boolean | false | Whether to include the cell output of the notebook in the export. |
ExposePortSchema
{
"description": "Port creation schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "ExposePortSchema",
"type": "object"
}
ExposePortSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | maxLength: 500 |
Description of the exposed port. |
| port | integer | true | Exposed port number. |
ExposedPortListSchema
{
"description": "List of exposed ports for a notebook.",
"properties": {
"data": {
"description": "List of exposed ports.",
"items": {
"description": "Exposed port schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"title": "Description",
"type": "string"
},
"id": {
"description": "Exposed port ID.",
"title": "Id",
"type": "string"
},
"notebookId": {
"description": "Notebook ID the exposed port belongs to.",
"title": "Notebookid",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
},
"url": {
"description": "URL to access the exposed port.",
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"notebookId",
"port",
"url"
],
"title": "ExposedPortSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "ExposedPortListSchema",
"type": "object"
}
ExposedPortListSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [ExposedPortSchema] | false | List of exposed ports. |
ExposedPortSchema
{
"description": "Exposed port schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"title": "Description",
"type": "string"
},
"id": {
"description": "Exposed port ID.",
"title": "Id",
"type": "string"
},
"notebookId": {
"description": "Notebook ID the exposed port belongs to.",
"title": "Notebookid",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
},
"url": {
"description": "URL to access the exposed port.",
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"notebookId",
"port",
"url"
],
"title": "ExposedPortSchema",
"type": "object"
}
ExposedPortSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | Description of the exposed port. | |
| id | string | true | Exposed port ID. | |
| notebookId | string | true | Notebook ID the exposed port belongs to. | |
| port | integer | true | Exposed port number. | |
| url | string | true | URL to access the exposed port. |
FilesystemObjectSchema
{
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
}
FilesystemObjectSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lastUpdatedAt | string(date-time) | false | Last updated time of the filesystem object. | |
| mediaType | string | false | Media type of the filesystem object. | |
| name | string | true | Name of the filesystem object. | |
| path | string | true | Path to the filesystem object. | |
| sizeInBytes | integer | false | Size of the filesystem object in bytes. | |
| type | FilesystemObjectType | true | Type of the filesystem object. Possible values include 'dir', 'file'. |
FilesystemObjectType
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
FilesystemObjectType
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| FilesystemObjectType | string | false | Type of the filesystem object. |
Enumerated Values¶
| Property | Value |
|---|---|
| FilesystemObjectType | [dir, file] |
FilesystemSortBy
{
"description": "An enumeration.",
"enum": [
"name",
"-name",
"updated_at",
"-updated_at"
],
"title": "FilesystemSortBy",
"type": "string"
}
FilesystemSortBy
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| FilesystemSortBy | string | false | An enumeration. |
Enumerated Values¶
| Property | Value |
|---|---|
| FilesystemSortBy | [name, -name, updated_at, -updated_at] |
FilterOptionsQuery
{
"description": "Query options for filtering notebooks in the notebooks directory.",
"properties": {
"allUseCases": {
"default": false,
"description": "Whether to include all use cases.",
"title": "Allusecases",
"type": "boolean"
},
"useCaseId": {
"description": "The ID of a usecase to filter by.",
"title": "Usecaseid",
"type": "string"
}
},
"title": "FilterOptionsQuery",
"type": "object"
}
FilterOptionsQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| allUseCases | boolean | false | Whether to include all use cases. | |
| useCaseId | string | false | The ID of a usecase to filter by. |
FilterOptionsResponse
{
"description": "Response schema for filter options in the notebooks directory.",
"properties": {
"owners": {
"description": "A list of possible owners to filter notebooks by.",
"items": {
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
},
"title": "Owners",
"type": "array"
},
"tags": {
"description": "A list of possible tags to filter notebooks by.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
}
},
"title": "FilterOptionsResponse",
"type": "object"
}
FilterOptionsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| owners | [UserInfo] | false | A list of possible owners to filter notebooks by. | |
| tags | [string] | false | A list of possible tags to filter notebooks by. |
GetCellsQuery
{
"description": "Base query schema for getting notebook cells.",
"properties": {
"cellIds": {
"description": "List of cell IDs to get.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"cellIds"
],
"title": "GetCellsQuery",
"type": "object"
}
GetCellsQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellIds | [string] | true | List of cell IDs to get. | |
| path | string | true | Path to the notebook. |
GetDataframeResponse
{
"description": "Response schema for getting a dataframe from a notebook session.",
"properties": {
"dataframe": {
"description": "The requested dataframe in the notebook session.",
"title": "Dataframe",
"type": "string"
}
},
"required": [
"dataframe"
],
"title": "GetDataframeResponse",
"type": "object"
}
GetDataframeResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dataframe | string | true | The requested dataframe in the notebook session. |
GetFilesystemObjectMetadataRequest
{
"description": "Request payload values for getting filesystem object metadata.",
"properties": {
"path": {
"description": "List of paths to get metadata for.",
"items": {
"type": "string"
},
"title": "Path",
"type": "array"
}
},
"title": "GetFilesystemObjectMetadataRequest",
"type": "object"
}
GetFilesystemObjectMetadataRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| path | [string] | false | List of paths to get metadata for. |
GitCloneRequest
{
"description": "Request schema for cloning a Git repository.",
"properties": {
"url": {
"description": "URL of the Git repository to clone.",
"format": "uri",
"maxLength": 65536,
"minLength": 1,
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "GitCloneRequest",
"type": "object"
}
GitCloneRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| url | string(uri) | true | maxLength: 65536 minLength: 1 minLength: 1 |
URL of the Git repository to clone. |
GitCloneStatusResponse
{
"description": "Response schema for the status of a Git clone operation.",
"properties": {
"errorMsg": {
"description": "Error message if the clone operation failed.",
"title": "Errormsg",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Status of the VCS command.",
"enum": [
"not_inited",
"running",
"finished",
"error"
],
"title": "VCSCommandStatus",
"type": "string"
}
],
"description": "Status of the Git clone operation."
}
},
"required": [
"status"
],
"title": "GitCloneStatusResponse",
"type": "object"
}
GitCloneStatusResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errorMsg | string | false | Error message if the clone operation failed. | |
| status | VCSCommandStatus | true | Status of the Git clone operation. |
GitProviderSchema
{
"description": "The Git OAuth Provider details.",
"properties": {
"hostname": {
"description": "The hostname of the Git provider.",
"title": "Hostname",
"type": "string"
},
"id": {
"description": "The authorized Git OAuth Provider ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the Git provider.",
"title": "Name",
"type": "string"
},
"settingsUrl": {
"description": "The URL to manage the Git provider settings.",
"title": "Settingsurl",
"type": "string"
},
"status": {
"description": "The status of the OAuth authorization.",
"title": "Status",
"type": "string"
},
"type": {
"description": "The type of the Git provider.",
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"status",
"type",
"name",
"hostname"
],
"title": "GitProviderSchema",
"type": "object"
}
GitProviderSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hostname | string | true | The hostname of the Git provider. | |
| id | string | true | The authorized Git OAuth Provider ID. | |
| name | string | true | The name of the Git provider. | |
| settingsUrl | string | false | The URL to manage the Git provider settings. | |
| status | string | true | The status of the OAuth authorization. | |
| type | string | true | The type of the Git provider. |
GitRepositorySchema
{
"properties": {
"createdAt": {
"description": "The creation date of the Git repository.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"fullName": {
"description": "The full name of Git repository, e.g., datarobot/notebooks.",
"title": "Fullname",
"type": "string"
},
"httpUrl": {
"description": "The HTTP URL of the Git repository, e.g., https://github.com/datarobot/notebooks.",
"title": "Httpurl",
"type": "string"
},
"isPrivate": {
"description": "Determines if the Git repository is private.",
"title": "Isprivate",
"type": "boolean"
},
"name": {
"description": "The name of Git repository, e.g., \"notebooks\".",
"title": "Name",
"type": "string"
},
"owner": {
"description": "The owner account of the Git repository.",
"title": "Owner",
"type": "string"
},
"pushedAt": {
"description": "The last push date of the Git repository.",
"format": "date-time",
"title": "Pushedat",
"type": "string"
},
"updatedAt": {
"description": "The last update date of the Git repository.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
}
},
"required": [
"name",
"fullName",
"httpUrl",
"owner"
],
"title": "GitRepositorySchema",
"type": "object"
}
GitRepositorySchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | false | The creation date of the Git repository. | |
| fullName | string | true | The full name of Git repository, e.g., datarobot/notebooks. | |
| httpUrl | string | true | The HTTP URL of the Git repository, e.g., https://github.com/datarobot/notebooks. | |
| isPrivate | boolean | false | Determines if the Git repository is private. | |
| name | string | true | The name of Git repository, e.g., "notebooks". | |
| owner | string | true | The owner account of the Git repository. | |
| pushedAt | string(date-time) | false | The last push date of the Git repository. | |
| updatedAt | string(date-time) | false | The last update date of the Git repository. |
ImagePublic
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
ImagePublic
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| default | boolean | false | Whether the image is the default image. | |
| description | string | true | Image description. | |
| environmentId | string | false | Environment ID. | |
| gpuOptimized | boolean | false | Whether the image is GPU optimized. | |
| id | string | true | Image ID. | |
| label | string | false | Image label. | |
| language | string | true | Image programming language. | |
| languageVersion | string | true | Image programming language version. | |
| libraries | [string] | false | The preinstalled libraries in the image. | |
| name | string | true | Image name. |
ImportNotebookFromUrlRequest
{
"description": "Request payload values for importing a notebook from a URL.",
"properties": {
"includeOutput": {
"default": true,
"description": "Whether to include the cell output of the notebook in the import.",
"title": "Includeoutput",
"type": "boolean"
},
"name": {
"description": "The name of the notebook to be created upon import.",
"title": "Name",
"type": "string"
},
"uri": {
"description": "The URL of the notebook to import.",
"title": "Uri",
"type": "string"
},
"useCaseId": {
"description": "The ID of the Use Case to import the notebook into.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"uri"
],
"title": "ImportNotebookFromUrlRequest",
"type": "object"
}
ImportNotebookFromUrlRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| includeOutput | boolean | false | Whether to include the cell output of the notebook in the import. | |
| name | string | false | The name of the notebook to be created upon import. | |
| uri | string | true | The URL of the notebook to import. | |
| useCaseId | string | false | The ID of the Use Case to import the notebook into. |
ImportNotebookResponse
{
"description": "Imported notebook information.",
"properties": {
"id": {
"description": "The ID of the created notebook.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the created notebook.",
"title": "Name",
"type": "string"
}
},
"required": [
"id"
],
"title": "ImportNotebookResponse",
"type": "object"
}
ImportNotebookResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the created notebook. | |
| name | string | false | The name of the created notebook. |
InputReplySchema
{
"description": "The schema for the input reply request.",
"properties": {
"value": {
"description": "The value to send as a reply after kernel has requested input.",
"title": "Value",
"type": "string"
}
},
"required": [
"value"
],
"title": "InputReplySchema",
"type": "object"
}
InputReplySchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string | true | The value to send as a reply after kernel has requested input. |
InsertCellsSchema
{
"description": "The schema for the cells to be inserted into a notebook.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "ID of the cell after which to insert the new cell.",
"title": "Aftercellid"
},
"data": {
"allOf": [
{
"description": "The schema for the notebook cell to be created.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell to create."
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"cellType"
],
"title": "CreateNotebookCellSchema",
"type": "object"
}
],
"description": "The cell data to insert.",
"title": "Data"
}
},
"required": [
"afterCellId",
"data"
],
"title": "InsertCellsSchema",
"type": "object"
}
InsertCellsSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| afterCellId | any | true | ID of the cell after which to insert the new cell. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | CreateNotebookCellSchema | true | The cell data to insert. |
Enumerated Values¶
| Property | Value |
|---|---|
| anonymous | FIRST |
InteractiveVariablesSchema
{
"description": "Interactive variables schema. For use with results from IPython's magic `%who_ls` command.",
"properties": {
"name": {
"description": "The name of the variable.",
"title": "Name",
"type": "string"
},
"type": {
"description": "The type of the variable.",
"title": "Type",
"type": "string"
}
},
"required": [
"name",
"type"
],
"title": "InteractiveVariablesSchema",
"type": "object"
}
InteractiveVariablesSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | The name of the variable. | |
| type | string | true | The type of the variable. |
JupyterCellMetadata
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
JupyterCellMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| sourceHidden | boolean | false | Whether the cell's source is hidden. |
KernelExecutionStatus
{
"description": "Kernel execution status.",
"enum": [
"busy",
"idle"
],
"title": "KernelExecutionStatus",
"type": "string"
}
KernelExecutionStatus
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| KernelExecutionStatus | string | false | Kernel execution status. |
Enumerated Values¶
| Property | Value |
|---|---|
| KernelExecutionStatus | [busy, idle] |
KernelSchema
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
KernelSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| executionState | KernelState | true | The execution state of the kernel. | |
| id | string | true | The ID of the kernel. | |
| language | RuntimeLanguage | true | The programming language of the kernel. Possible values include 'python', 'r'. | |
| name | string | true | The name of the kernel. Possible values include 'python3', 'ir'. | |
| running | boolean | false | Whether the kernel is running. |
KernelSpecSchema
{
"properties": {
"displayName": {
"description": "Display name of the kernel. Possible values include 'R', 'Python 3 (ipykernel)'.",
"title": "Displayname",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "Runtime language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "Name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"displayName",
"language"
],
"title": "KernelSpecSchema",
"type": "object"
}
KernelSpecSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| displayName | string | true | Display name of the kernel. Possible values include 'R', 'Python 3 (ipykernel)'. | |
| language | RuntimeLanguage | true | Runtime language of the kernel. Possible values include 'python', 'r'. | |
| name | string | true | Name of the kernel. Possible values include 'python3', 'ir'. |
KernelSpecsResponse
{
"description": "Schema for the Codespace's kernel information.",
"properties": {
"default": {
"description": "The default kernel. Possible values include 'python3', 'ir'.",
"title": "Default",
"type": "string"
},
"kernels": {
"description": "List of available kernels.",
"items": {
"properties": {
"displayName": {
"description": "Display name of the kernel. Possible values include 'R', 'Python 3 (ipykernel)'.",
"title": "Displayname",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "Runtime language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "Name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"displayName",
"language"
],
"title": "KernelSpecSchema",
"type": "object"
},
"title": "Kernels",
"type": "array"
}
},
"required": [
"default"
],
"title": "KernelSpecsResponse",
"type": "object"
}
KernelSpecsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| default | string | true | The default kernel. Possible values include 'python3', 'ir'. | |
| kernels | [KernelSpecSchema] | false | List of available kernels. |
KernelState
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
KernelState
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| KernelState | string | false | Event Sequences on Various Workflows: - On kernel created: CONNECTED -> BUSY -> IDLE - On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE - On regular execution: IDLE -> BUSY -> IDLE - On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE - On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE - On kernel shut down via calling the stop kernel endpoint: DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s) |
Enumerated Values¶
| Property | Value |
|---|---|
| KernelState | [connecting, disconnected, connected, starting, idle, busy, interrupting, restarting, not_running] |
Language
{
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
Language
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Language | string | false | An enumeration. |
Enumerated Values¶
| Property | Value |
|---|---|
| Language | [dataframe, markdown, python, r, scala, sas, custommetric] |
ListCodeSnippetsResponse
{
"description": "Response schema for the list of code snippets.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "A list of code snippets.",
"items": {
"description": "CodeSnippet represents a code snippet.",
"properties": {
"code": {
"description": "The code snippet code content.",
"title": "Code",
"type": "string"
},
"description": {
"description": "The description of the code snippet.",
"title": "Description",
"type": "string"
},
"id": {
"description": "The ID of the code snippet.",
"title": "Id",
"type": "string"
},
"language": {
"description": "The programming language of the code snippet.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version of the code snippet.",
"title": "Languageversion",
"type": "string"
},
"locale": {
"description": "The language locale of the code snippet.",
"title": "Locale",
"type": "string"
},
"tags": {
"description": "A comma separated list of snippet tags.",
"title": "Tags",
"type": "string"
},
"title": {
"description": "The title of the code snippet.",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"locale",
"title",
"description",
"code",
"language",
"languageVersion"
],
"title": "CodeSnippet",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ListCodeSnippetsResponse",
"type": "object"
}
ListCodeSnippetsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [CodeSnippet] | false | A list of code snippets. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. |
ListCodeSnippetsTagsResponse
{
"description": "Response schema for the list of code snippets tags.",
"properties": {
"tags": {
"description": "A list of tags for the code snippets.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
}
},
"title": "ListCodeSnippetsTagsResponse",
"type": "object"
}
ListCodeSnippetsTagsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tags | [string] | false | A list of tags for the code snippets. |
ListDataFrameResponse
{
"description": "Schema for the list of DataFrames in a notebook.",
"properties": {
"dataframes": {
"description": "List of DataFrames information.",
"items": {
"description": "Schema for a single DataFrame entry.",
"properties": {
"name": {
"description": "Name of the DataFrame.",
"title": "Name",
"type": "string"
},
"type": {
"description": "Type of the DataFrame.",
"title": "Type",
"type": "string"
}
},
"required": [
"name",
"type"
],
"title": "DataFrameEntrySchema",
"type": "object"
},
"title": "Dataframes",
"type": "array"
}
},
"title": "ListDataFrameResponse",
"type": "object"
}
ListDataFrameResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dataframes | [DataFrameEntrySchema] | false | List of DataFrames information. |
ListDataframesResponse
{
"description": "Response schema for listing DataFrames in a notebook session.",
"properties": {
"dataframes": {
"description": "List of DataFrames in the notebook session.",
"items": {
"description": "Interactive variables schema. For use with results from IPython's magic `%who_ls` command.",
"properties": {
"name": {
"description": "The name of the variable.",
"title": "Name",
"type": "string"
},
"type": {
"description": "The type of the variable.",
"title": "Type",
"type": "string"
}
},
"required": [
"name",
"type"
],
"title": "InteractiveVariablesSchema",
"type": "object"
},
"title": "Dataframes",
"type": "array"
}
},
"title": "ListDataframesResponse",
"type": "object"
}
ListDataframesResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dataframes | [InteractiveVariablesSchema] | false | List of DataFrames in the notebook session. |
ListFilesystemObjectsRequest
{
"description": "We have set the limit max value to one thousand",
"properties": {
"limit": {
"default": 100,
"description": "Maximum number of objects to return.",
"exclusiveMinimum": 0,
"maximum": 1000,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Offset for pagination.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sortBy": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"name",
"-name",
"updated_at",
"-updated_at"
],
"title": "FilesystemSortBy",
"type": "string"
}
],
"default": "name",
"description": "Sort results by this field."
}
},
"required": [
"path"
],
"title": "ListFilesystemObjectsRequest",
"type": "object"
}
ListFilesystemObjectsRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| limit | integer | false | maximum: 1000 |
Maximum number of objects to return. |
| offset | integer | false | minimum: 0 |
Offset for pagination. |
| path | string | true | Path to the filesystem object. | |
| sortBy | FilesystemSortBy | false | Sort results by this field. |
ListFilesystemObjectsResponse
{
"description": "Response schema for listing filesystem objects.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of filesystem objects.",
"items": {
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"datarobotMetadata": {
"additionalProperties": {
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
},
"description": "Metadata for DataRobot files.",
"title": "Datarobotmetadata",
"type": "object"
},
"directoryHierarchy": {
"description": "List of directories respective names and paths.",
"items": {
"description": "These are only directories\n\nThe name property can be any string or the constant/sentinel \"root\"",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"root"
],
"type": "string"
}
],
"description": "Name of the directory.",
"title": "Name"
},
"path": {
"description": "Path to the directory.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path"
],
"title": "DirHierarchyObjectSchema",
"type": "object"
},
"title": "Directoryhierarchy",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"required": [
"data",
"directoryHierarchy",
"datarobotMetadata"
],
"title": "ListFilesystemObjectsResponse",
"type": "object"
}
ListFilesystemObjectsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [FilesystemObjectSchema] | true | List of filesystem objects. | |
| datarobotMetadata | object | true | Metadata for DataRobot files. | |
| » additionalProperties | DRFileMetadata | false | Metadata for DataRobot files. | |
| directoryHierarchy | [DirHierarchyObjectSchema] | true | List of directories respective names and paths. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. |
ListGitProvidersResponse
{
"description": "A list of authorized Git OAuth providers available for the user.",
"properties": {
"providers": {
"description": "A list of authorized Git OAuth providers.",
"items": {
"description": "The Git OAuth Provider details.",
"properties": {
"hostname": {
"description": "The hostname of the Git provider.",
"title": "Hostname",
"type": "string"
},
"id": {
"description": "The authorized Git OAuth Provider ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the Git provider.",
"title": "Name",
"type": "string"
},
"settingsUrl": {
"description": "The URL to manage the Git provider settings.",
"title": "Settingsurl",
"type": "string"
},
"status": {
"description": "The status of the OAuth authorization.",
"title": "Status",
"type": "string"
},
"type": {
"description": "The type of the Git provider.",
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"status",
"type",
"name",
"hostname"
],
"title": "GitProviderSchema",
"type": "object"
},
"maxItems": 1000,
"minItems": 0,
"title": "Providers",
"type": "array"
}
},
"required": [
"providers"
],
"title": "ListGitProvidersResponse",
"type": "object"
}
ListGitProvidersResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| providers | [GitProviderSchema] | true | maxItems: 1000 |
A list of authorized Git OAuth providers. |
ListGitRepositoriesResponse
{
"description": "A list of Git repositories available for the authorized Git provider and the related params used for filtering\n(if provided).",
"properties": {
"data": {
"description": "A list of Git repositories.",
"items": {
"properties": {
"createdAt": {
"description": "The creation date of the Git repository.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"fullName": {
"description": "The full name of Git repository, e.g., datarobot/notebooks.",
"title": "Fullname",
"type": "string"
},
"httpUrl": {
"description": "The HTTP URL of the Git repository, e.g., https://github.com/datarobot/notebooks.",
"title": "Httpurl",
"type": "string"
},
"isPrivate": {
"description": "Determines if the Git repository is private.",
"title": "Isprivate",
"type": "boolean"
},
"name": {
"description": "The name of Git repository, e.g., \"notebooks\".",
"title": "Name",
"type": "string"
},
"owner": {
"description": "The owner account of the Git repository.",
"title": "Owner",
"type": "string"
},
"pushedAt": {
"description": "The last push date of the Git repository.",
"format": "date-time",
"title": "Pushedat",
"type": "string"
},
"updatedAt": {
"description": "The last update date of the Git repository.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
}
},
"required": [
"name",
"fullName",
"httpUrl",
"owner"
],
"title": "GitRepositorySchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"params": {
"additionalProperties": {
"type": "string"
},
"description": "The params used when listing Git repositories.",
"title": "Params",
"type": "object"
}
},
"required": [
"data"
],
"title": "ListGitRepositoriesResponse",
"type": "object"
}
ListGitRepositoriesResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [GitRepositorySchema] | true | A list of Git repositories. | |
| params | object | false | The params used when listing Git repositories. | |
| » additionalProperties | string | false | none |
ListGitRepositoryQuery
{
"description": "The possible query params to use when listing git repositories.",
"properties": {
"limit": {
"default": 30,
"description": "The number of repositories to return.",
"exclusiveMinimum": 1,
"maximum": 100,
"title": "Limit",
"type": "integer"
},
"query": {
"description": "A search query for repository names.",
"title": "Query",
"type": "string"
}
},
"title": "ListGitRepositoryQuery",
"type": "object"
}
ListGitRepositoryQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| limit | integer | false | maximum: 100 |
The number of repositories to return. |
| query | string | false | A search query for repository names. |
ListNotebookRevisionsQuerySchema
{
"description": "Query schema for listing notebook revisions.",
"properties": {
"autosaved": {
"description": "Whether to include autosaved revisions.",
"title": "Autosaved",
"type": "boolean"
},
"createdAfter": {
"description": "Filter revisions created after this date.",
"format": "date-time",
"title": "Createdafter",
"type": "string"
},
"limit": {
"default": 10,
"description": "The limit or results to return.",
"exclusiveMinimum": 0,
"maximum": 100,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "The offset to use when querying paginated results.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"orderBy": {
"allOf": [
{
"description": "Enum for ordering notebooks when querying.",
"enum": [
"name",
"-name",
"created",
"-created",
"updated",
"-updated",
"tags",
"-tags",
"lastViewed",
"-lastViewed",
"useCaseName",
"-useCaseName",
"sessionStatus",
"-sessionStatus"
],
"title": "OrderBy",
"type": "string"
}
],
"default": "created",
"description": "Order by field."
}
},
"title": "ListNotebookRevisionsQuerySchema",
"type": "object"
}
ListNotebookRevisionsQuerySchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| autosaved | boolean | false | Whether to include autosaved revisions. | |
| createdAfter | string(date-time) | false | Filter revisions created after this date. | |
| limit | integer | false | maximum: 100 |
The limit or results to return. |
| offset | integer | false | minimum: 0 |
The offset to use when querying paginated results. |
| orderBy | OrderBy | false | Order by field. |
ListNotebookRevisionsResponse
{
"description": "Response schema for listing notebook revisions.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebook revisions.",
"items": {
"description": "Notebook revision schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"notebookId": {
"description": "Notebook ID this revision belongs to.",
"title": "Notebookid",
"type": "string"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
}
},
"required": [
"revisionId",
"notebookId",
"name",
"isAuto",
"created"
],
"title": "NotebookRevisionSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ListNotebookRevisionsResponse",
"type": "object"
}
ListNotebookRevisionsResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [NotebookRevisionSchema] | false | List of notebook revisions. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. |
ListNotebooksQuery
{
"description": "Query options for listing notebooks in the notebooks directory.",
"properties": {
"allUseCases": {
"default": false,
"description": "Whether to include all Use Cases.",
"title": "Allusecases",
"type": "boolean"
},
"createdAfter": {
"description": "Filter notebooks created after this date.",
"format": "date-time",
"title": "Createdafter",
"type": "string"
},
"createdBefore": {
"description": "Filter notebooks created before this date.",
"format": "date-time",
"title": "Createdbefore",
"type": "string"
},
"limit": {
"default": 10,
"description": "The maximum number of notebooks to return.",
"exclusiveMinimum": 0,
"maximum": 1000,
"title": "Limit",
"type": "integer"
},
"name": {
"default": "",
"description": "A name to filter notebooks by.",
"title": "Name",
"type": "string"
},
"offset": {
"default": 0,
"description": "The offset to use when querying paginated results.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"orderBy": {
"allOf": [
{
"description": "Enum for ordering notebooks when querying.",
"enum": [
"name",
"-name",
"created",
"-created",
"updated",
"-updated",
"tags",
"-tags",
"lastViewed",
"-lastViewed",
"useCaseName",
"-useCaseName",
"sessionStatus",
"-sessionStatus"
],
"title": "OrderBy",
"type": "string"
}
],
"default": "-updated",
"description": "The order in which to sort the notebooks."
},
"owners": {
"description": "A list of user IDs to filter notebooks by.",
"items": {
"type": "string"
},
"title": "Owners",
"type": "array"
},
"query": {
"description": "A query to filter notebooks by name and description.",
"title": "Query",
"type": "string"
},
"tags": {
"description": "A list of tags to filter notebooks by.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"type": {
"description": "The notebook type to filter by.",
"items": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"type": "array"
},
"types": {
"description": "The notebook type to filter by.",
"items": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"type": "array"
},
"useCaseId": {
"description": "The ID of a Use Case to filter notebooks by.",
"title": "Usecaseid",
"type": "string"
}
},
"title": "ListNotebooksQuery",
"type": "object"
}
ListNotebooksQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| allUseCases | boolean | false | Whether to include all Use Cases. | |
| createdAfter | string(date-time) | false | Filter notebooks created after this date. | |
| createdBefore | string(date-time) | false | Filter notebooks created before this date. | |
| limit | integer | false | maximum: 1000 |
The maximum number of notebooks to return. |
| name | string | false | A name to filter notebooks by. | |
| offset | integer | false | minimum: 0 |
The offset to use when querying paginated results. |
| orderBy | OrderBy | false | The order in which to sort the notebooks. | |
| owners | [string] | false | A list of user IDs to filter notebooks by. | |
| query | string | false | A query to filter notebooks by name and description. | |
| tags | [string] | false | A list of tags to filter notebooks by. | |
| type | [NotebookType] | false | The notebook type to filter by. | |
| types | [NotebookType] | false | The notebook type to filter by. | |
| useCaseId | string | false | The ID of a Use Case to filter notebooks by. |
ListNotebooksResponse
{
"description": "Response schema for listing notebooks.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "A list of notebooks.",
"items": {
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ListNotebooksResponse",
"type": "object"
}
ListNotebooksResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [NotebookSchema] | false | A list of notebooks. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. |
ListScheduledJobQuery
{
"description": "Query parameters for listing scheduled jobs.",
"properties": {
"createdByIds": {
"description": "The IDs of the users who created the scheduled jobs.",
"items": {
"type": "string"
},
"title": "Createdbyids",
"type": "array"
},
"lastRunEnd": {
"description": "The end time of the last run to filter the scheduled jobs by.",
"format": "date-time",
"title": "Lastrunend",
"type": "string"
},
"lastRunStart": {
"description": "The start time of the last run to filter the scheduled jobs by.",
"format": "date-time",
"title": "Lastrunstart",
"type": "string"
},
"limit": {
"default": 10,
"description": "The limit or results to return.",
"exclusiveMinimum": 0,
"maximum": 100,
"title": "Limit",
"type": "integer"
},
"nextRunEnd": {
"description": "The end time of the next run to filter the scheduled jobs by.",
"format": "date-time",
"title": "Nextrunend",
"type": "string"
},
"nextRunStart": {
"description": "The start time of the next run to filter the scheduled jobs by.",
"format": "date-time",
"title": "Nextrunstart",
"type": "string"
},
"notebookIds": {
"description": "The IDs of the notebooks to filter the scheduled jobs by.",
"items": {
"type": "string"
},
"title": "Notebookids",
"type": "array"
},
"notebookTypes": {
"description": "The types of notebooks to filter the scheduled jobs by.",
"items": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"type": "array"
},
"offset": {
"default": 0,
"description": "The offset to use when querying paginated results.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"orderBy": {
"allOf": [
{
"description": "Fields to order the list of scheduled jobs by.",
"enum": [
"title",
"-title",
"username",
"-username",
"notebookName",
"-notebookName",
"useCaseName",
"-useCaseName",
"status",
"-status",
"schedule",
"-schedule",
"lastRun",
"-lastRun",
"nextRun",
"-nextRun"
],
"title": "ScheduledJobListOrderBy",
"type": "string"
}
],
"description": "The field to order the results by."
},
"search": {
"description": "The search term to filter the scheduled jobs.",
"title": "Search",
"type": "string"
},
"statuses": {
"description": "The statuses to filter the scheduled jobs by.",
"items": {
"enum": [
"enabled",
"disabled"
],
"type": "string"
},
"title": "Statuses",
"type": "array"
},
"titles": {
"description": "The titles to filter the scheduled jobs by.",
"items": {
"type": "string"
},
"title": "Titles",
"type": "array"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"title": "ListScheduledJobQuery",
"type": "object"
}
ListScheduledJobQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdByIds | [string] | false | The IDs of the users who created the scheduled jobs. | |
| lastRunEnd | string(date-time) | false | The end time of the last run to filter the scheduled jobs by. | |
| lastRunStart | string(date-time) | false | The start time of the last run to filter the scheduled jobs by. | |
| limit | integer | false | maximum: 100 |
The limit or results to return. |
| nextRunEnd | string(date-time) | false | The end time of the next run to filter the scheduled jobs by. | |
| nextRunStart | string(date-time) | false | The start time of the next run to filter the scheduled jobs by. | |
| notebookIds | [string] | false | The IDs of the notebooks to filter the scheduled jobs by. | |
| notebookTypes | [NotebookType] | false | The types of notebooks to filter the scheduled jobs by. | |
| offset | integer | false | minimum: 0 |
The offset to use when querying paginated results. |
| orderBy | ScheduledJobListOrderBy | false | The field to order the results by. | |
| search | string | false | The search term to filter the scheduled jobs. | |
| statuses | [string] | false | The statuses to filter the scheduled jobs by. | |
| titles | [string] | false | The titles to filter the scheduled jobs by. | |
| useCaseId | string | false | The ID of the use case this notebook is associated with. |
ListScheduledRunsHistoryQuery
{
"description": "Query parameters for listing scheduled runs history.",
"properties": {
"createdByIds": {
"description": "The IDs of the users who created the scheduled runs history.",
"items": {
"type": "string"
},
"title": "Createdbyids",
"type": "array"
},
"endTimeEnd": {
"description": "The end time of the run to filter the scheduled runs history by.",
"format": "date-time",
"title": "Endtimeend",
"type": "string"
},
"endTimeStart": {
"description": "The start time of the run to filter the scheduled runs history by.",
"format": "date-time",
"title": "Endtimestart",
"type": "string"
},
"envIds": {
"description": "The IDs of the environments to filter the scheduled runs history by.",
"items": {
"type": "string"
},
"title": "Envids",
"type": "array"
},
"jobIds": {
"description": "The IDs of the jobs to filter the scheduled runs history by.",
"items": {
"type": "string"
},
"title": "Jobids",
"type": "array"
},
"limit": {
"default": 10,
"description": "The limit or results to return.",
"exclusiveMinimum": 0,
"maximum": 100,
"title": "Limit",
"type": "integer"
},
"notebookIds": {
"description": "The IDs of the notebooks to filter the scheduled runs history by.",
"items": {
"type": "string"
},
"title": "Notebookids",
"type": "array"
},
"notebookTypes": {
"description": "The types of notebooks to filter the scheduled runs history by.",
"items": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"type": "array"
},
"offset": {
"default": 0,
"description": "The offset to use when querying paginated results.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"orderBy": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"created",
"-created",
"title",
"-title",
"notebookName",
"-notebookName",
"runType",
"-runType",
"status",
"-status",
"startTime",
"-startTime",
"endTime",
"-endTime",
"duration",
"-duration",
"revisionName",
"-revisionName",
"environmentName",
"-environmentName",
"useCaseName",
"-useCaseName"
],
"title": "ScheduledHistoryListOrderBy",
"type": "string"
}
],
"default": "-created",
"description": "The field to order the results by."
},
"runTypes": {
"description": "The types of runs to filter the scheduled runs history by.",
"items": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"type": "array"
},
"search": {
"description": "The search term to filter the scheduled runs history.",
"title": "Search",
"type": "string"
},
"startTimeEnd": {
"description": "The end time of the run to filter the scheduled runs history by.",
"format": "date-time",
"title": "Starttimeend",
"type": "string"
},
"startTimeStart": {
"description": "The start time of the run to filter the scheduled runs history by.",
"format": "date-time",
"title": "Starttimestart",
"type": "string"
},
"statuses": {
"description": "The statuses to filter the scheduled runs history by.",
"items": {
"type": "string"
},
"title": "Statuses",
"type": "array"
},
"titles": {
"description": "The titles to filter the scheduled runs history by.",
"items": {
"type": "string"
},
"title": "Titles",
"type": "array"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"title": "ListScheduledRunsHistoryQuery",
"type": "object"
}
ListScheduledRunsHistoryQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdByIds | [string] | false | The IDs of the users who created the scheduled runs history. | |
| endTimeEnd | string(date-time) | false | The end time of the run to filter the scheduled runs history by. | |
| endTimeStart | string(date-time) | false | The start time of the run to filter the scheduled runs history by. | |
| envIds | [string] | false | The IDs of the environments to filter the scheduled runs history by. | |
| jobIds | [string] | false | The IDs of the jobs to filter the scheduled runs history by. | |
| limit | integer | false | maximum: 100 |
The limit or results to return. |
| notebookIds | [string] | false | The IDs of the notebooks to filter the scheduled runs history by. | |
| notebookTypes | [NotebookType] | false | The types of notebooks to filter the scheduled runs history by. | |
| offset | integer | false | minimum: 0 |
The offset to use when querying paginated results. |
| orderBy | ScheduledHistoryListOrderBy | false | The field to order the results by. | |
| runTypes | [RunTypes] | false | The types of runs to filter the scheduled runs history by. | |
| search | string | false | The search term to filter the scheduled runs history. | |
| startTimeEnd | string(date-time) | false | The end time of the run to filter the scheduled runs history by. | |
| startTimeStart | string(date-time) | false | The start time of the run to filter the scheduled runs history by. | |
| statuses | [string] | false | The statuses to filter the scheduled runs history by. | |
| titles | [string] | false | The titles to filter the scheduled runs history by. | |
| useCaseId | string | false | The ID of the use case this notebook is associated with. |
ListSnippetsQuerySchema
{
"description": "Query schema for searching code nuggets.",
"properties": {
"language": {
"description": "The programming language of the code snippet to query for.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version of the code snippet to query for.",
"title": "Languageversion",
"type": "string"
},
"limit": {
"default": 10,
"description": "The limit or results to return.",
"exclusiveMinimum": 0,
"maximum": 100,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "The offset to use when querying paginated results.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"q": {
"description": "A search query to filter the code snippets.",
"title": "Q",
"type": "string"
},
"tags": {
"description": "A comma separated list of tags to filter the code snippets.",
"title": "Tags",
"type": "string"
}
},
"title": "ListSnippetsQuerySchema",
"type": "object"
}
ListSnippetsQuerySchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| language | string | false | The programming language of the code snippet to query for. | |
| languageVersion | string | false | The programming language version of the code snippet to query for. | |
| limit | integer | false | maximum: 100 |
The limit or results to return. |
| offset | integer | false | minimum: 0 |
The offset to use when querying paginated results. |
| q | string | false | A search query to filter the code snippets. | |
| tags | string | false | A comma separated list of tags to filter the code snippets. |
Machine
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
Machine
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| bundleId | string | false | Bundle ID. | |
| cpu | string | false | Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1). | |
| cpuCores | number | false | CPU cores. | |
| default | boolean | false | Is this machine type default for the environment. | |
| ephemeralStorage | string | false | Ephemeral storage size. | |
| gpu | string | false | GPU cores. | |
| hasGpu | boolean | false | Whether or not this machine type has a GPU. | |
| id | string | true | Machine ID. | |
| memory | string | false | Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G). | |
| name | string | true | Machine name. | |
| ramGb | integer | false | RAM in GB. |
MachineStatuses
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
MachineStatuses
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| MachineStatuses | string | false | This enum represents possible overall state of the machine(s) of all components of the notebook. |
Enumerated Values¶
| Property | Value |
|---|---|
| MachineStatuses | [not_started, allocated, starting, running, restarting, stopping, stopped, dead, deleted] |
MachinesPublic
{
"description": "Represents a list of machine types in the system.",
"properties": {
"machines": {
"description": "List of machine types.",
"items": {
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
},
"title": "Machines",
"type": "array"
}
},
"title": "MachinesPublic",
"type": "object"
}
MachinesPublic
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| machines | [Machine] | false | List of machine types. |
ManualRunTypes
{
"description": "Intentionally a subset of RunTypes above - to be used in API schemas",
"enum": [
"manual",
"pipeline"
],
"title": "ManualRunTypes",
"type": "string"
}
ManualRunTypes
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ManualRunTypes | string | false | Intentionally a subset of RunTypes above - to be used in API schemas |
Enumerated Values¶
| Property | Value |
|---|---|
| ManualRunTypes | [manual, pipeline] |
MarkdownCellSchema
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
}
MarkdownCellSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attachments | object | false | Attachments of the cell. | |
| cellType | SupportedCellTypes | false | Type of the cell. | |
| id | string | true | ID of the cell. | |
| metadata | NotebookCellMetadata | false | Metadata of the cell. | |
| source | any | false | Contents of the cell, represented as a string. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
MoveCellRequest
{
"description": "Request payload values for moving a notebook cell.",
"properties": {
"actionId": {
"description": "Action ID of notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "ID of the cell after which to move the cell.",
"title": "Aftercellid"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"afterCellId"
],
"title": "MoveCellRequest",
"type": "object"
}
MoveCellRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionId | string | false | maxLength: 64 |
Action ID of notebook update request. |
| afterCellId | any | true | ID of the cell after which to move the cell. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| generation | integer | true | Integer representing the generation of the notebook. | |
| path | string | true | Path to the notebook. |
Enumerated Values¶
| Property | Value |
|---|---|
| anonymous | FIRST |
MoveFilesystemObjectRequest
{
"description": "Move filesystem object request schema.",
"properties": {
"operations": {
"description": "List of source-destination pairs.",
"items": {
"description": "Source and destination schema for filesystem object operations.",
"properties": {
"destination": {
"description": "Destination path.",
"title": "Destination",
"type": "string"
},
"source": {
"description": "Source path.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"destination"
],
"title": "SourceDestinationSchema",
"type": "object"
},
"title": "Operations",
"type": "array"
}
},
"title": "MoveFilesystemObjectRequest",
"type": "object"
}
MoveFilesystemObjectRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operations | [SourceDestinationSchema] | false | List of source-destination pairs. |
MultiNotebookOperationQuery
{
"description": "Base query schema for multiple notebook operations.",
"properties": {
"path": {
"description": "List of paths to the notebooks.",
"items": {
"type": "string"
},
"title": "Path",
"type": "array"
}
},
"title": "MultiNotebookOperationQuery",
"type": "object"
}
MultiNotebookOperationQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| path | [string] | false | List of paths to the notebooks. |
MultipleNotebooksSharedRole
{
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"type": "string"
},
"roles": {
"description": "Individual roles data for the notebook.",
"items": {
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type.",
"enum": [
"user"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object",
"x-versionadded": "v2.35"
},
"type": "array"
}
},
"required": [
"notebookId",
"roles"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| notebookId | string | true | The ID of the notebook. | |
| roles | [NotebookSharedRole] | true | Individual roles data for the notebook. |
NewEnvironmentVariableSchema
{
"description": "Schema for updating environment variables.",
"properties": {
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"pattern": "^[a-zA-Z_$][\\w$]*$",
"title": "Name",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "NewEnvironmentVariableSchema",
"type": "object"
}
NewEnvironmentVariableSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | maxLength: 500 |
The description of the environment variable. |
| name | string | true | maxLength: 253 |
The name of the environment variable. |
| value | string | true | maxLength: 131072 |
The value of the environment variable. |
NewNotebookFileSchema
{
"description": "The schema for the newly created notebook.",
"properties": {
"cells": {
"description": "List of cells in the notebook.",
"items": {
"anyOf": [
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
},
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
},
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
]
},
"title": "Cells",
"type": "array"
},
"metadata": {
"description": "Metadata for the notebook.",
"title": "Metadata",
"type": "object"
},
"name": {
"description": "Name of the notebook.",
"title": "Name",
"type": "string"
},
"nbformat": {
"description": "The notebook format version.",
"title": "Nbformat",
"type": "integer"
},
"nbformatMinor": {
"description": "The notebook format minor version.",
"title": "Nbformatminor",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path",
"nbformat",
"nbformatMinor",
"metadata"
],
"title": "NewNotebookFileSchema",
"type": "object"
}
NewNotebookFileSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cells | [anyOf] | false | List of cells in the notebook. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | CodeCellSchema | false | The schema for a code cell in the notebook. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | MarkdownCellSchema | false | The schema for a markdown cell in the notebook. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AnyCellSchema | false | The schema for cells in a notebook that are not code or markdown. |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | object | true | Metadata for the notebook. | |
| name | string | true | Name of the notebook. | |
| nbformat | integer | true | The notebook format version. | |
| nbformatMinor | integer | true | The notebook format minor version. | |
| path | string | true | Path to the notebook. |
NotebookActionSignature
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
NotebookActionSignature
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| at | string(date-time) | true | Timestamp of the action. | |
| by | UserInfo | true | User info of the actor who performed the action. |
NotebookActivityRequest
{
"description": "Request payload values for updating notebook activity.",
"properties": {
"paths": {
"description": "List of paths to update activity for.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "NotebookActivityRequest",
"type": "object"
}
NotebookActivityRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| paths | [string] | false | List of paths to update activity for. |
NotebookCellCommonSchema
{
"description": "Schema for notebook cell.",
"properties": {
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata"
],
"title": "NotebookCellCommonSchema",
"type": "object"
}
NotebookCellCommonSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellStreamOutput | false | Cell stream output. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellInputRequest | false | Cell input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellErrorOutput | false | Cell error output. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | string | true | The contents of the cell, represented as a string. |
NotebookCellDataRobotMetadata
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
NotebookCellDataRobotMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| disableRun | boolean | false | Whether to disable the run button in the cell. | |
| executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| hideCode | boolean | false | Whether to hide the code in the cell. | |
| hideResults | boolean | false | Whether to hide the results in the cell. | |
| language | Language | false | Programming language of the notebook cell. |
NotebookCellExecData
{
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType",
"source"
],
"title": "NotebookCellExecData",
"type": "object"
}
NotebookCellExecData
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellType | SupportedCellTypes | true | Type of the cell. | |
| id | string | true | ID of the cell. | |
| source | any | true | Contents of the cell, represented as a string. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
NotebookCellMetadata
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
NotebookCellMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| name | string | false | Name of the cell. | |
| scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
Enumerated Values¶
| Property | Value |
|---|---|
| anonymous | auto |
NotebookCellSource
{
"description": "Notebook cell source model.",
"properties": {
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"source": {
"description": "Contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"cellId",
"source",
"md5"
],
"title": "NotebookCellSource",
"type": "object"
}
NotebookCellSource
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellId | string | true | The ID of the cell. | |
| md5 | string | true | The MD5 hash of the cell. | |
| source | string | true | Contents of the cell, represented as a string. |
NotebookCellSourceMetadata
{
"description": "Metadata for the source of a notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Cell metadata.",
"title": "Metadata"
},
"outputs": {
"description": "Cell outputs that conform to the nbformat-based NBX schema.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "Contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
],
"title": "NotebookCellSourceMetadata",
"type": "object"
}
NotebookCellSourceMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attachments | object | false | Cell attachments. | |
| metadata | NotebookCellMetadata | false | Cell metadata. | |
| outputs | [anyOf] | false | Cell outputs that conform to the nbformat-based NBX schema. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellStreamOutput | false | Cell stream output. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellInputRequest | false | Cell input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellErrorOutput | false | Cell error output. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | string | true | Contents of the cell, represented as a string. |
NotebookCellsSchema
{
"description": "The schema for the notebook cells.",
"properties": {
"cells": {
"description": "List of cells in the notebook.",
"items": {
"anyOf": [
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
},
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
},
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
]
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
}
},
"required": [
"generation",
"cells"
],
"title": "NotebookCellsSchema",
"type": "object"
}
NotebookCellsSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cells | [anyOf] | true | List of cells in the notebook. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | CodeCellSchema | false | The schema for a code cell in the notebook. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | MarkdownCellSchema | false | The schema for a markdown cell in the notebook. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AnyCellSchema | false | The schema for cells in a notebook that are not code or markdown. |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| generation | integer | true | Integer representing the generation of the notebook. |
NotebookChartCellAxis
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
NotebookChartCellAxis
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| y | NotebookChartCellAxisSettings | false | Chart cell axis settings. |
NotebookChartCellAxisSettings
{
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
NotebookChartCellAxisSettings
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| aggregation | string | false | Aggregation function for the axis. | |
| color | string | false | Color for the axis. | |
| hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| hideLabel | boolean | false | Whether to hide the axis label. | |
| key | string | false | Key for the axis. | |
| label | string | false | Label for the axis. | |
| position | string | false | Position of the axis. | |
| showPointMarkers | boolean | false | Whether to show point markers on the axis. |
NotebookChartCellMetadata
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
NotebookChartCellMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| axis | NotebookChartCellAxis | false | Axis settings. | |
| data | object | false | The data associated with the cell chart. | |
| dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. |
NotebookChartCellViewOptions
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
NotebookChartCellViewOptions
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| chartType | string | false | Type of the chart. | |
| showLegend | boolean | false | Whether to show the chart legend. | |
| showTitle | boolean | false | Whether to show the chart title. | |
| showTooltip | boolean | false | Whether to show the chart tooltip. | |
| title | string | false | Title of the chart. |
NotebookCustomLlmMetricCellMetadata
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
NotebookCustomLlmMetricCellMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metricId | string | true | The ID of the custom LLM metric. | |
| metricName | string | true | The name of the custom LLM metric. | |
| playgroundId | string | true | The ID of the playground associated with the custom LLM metric. |
NotebookCustomMetricCellMetadata
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
NotebookCustomMetricCellMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| metricId | string | true | The ID of the custom metric. | |
| metricName | string | false | The name of the custom metric. | |
| schedule | Schedule | false | The schedule associated with the custom metric. |
NotebookExecutionState
{
"description": "Notebook execution state model",
"properties": {
"executingCellId": {
"description": "The ID of the cell currently being executed.",
"title": "Executingcellid",
"type": "string"
},
"executionFinishedAt": {
"description": "The time the execution finished. This is based on the finish time of the last cell.",
"format": "date-time",
"title": "Executionfinishedat",
"type": "string"
},
"executionStartedAt": {
"description": "The time the execution started.",
"format": "date-time",
"title": "Executionstartedat",
"type": "string"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"kernelId": {
"description": "The ID of the kernel used for execution.",
"title": "Kernelid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
}
},
"title": "NotebookExecutionState",
"type": "object"
}
NotebookExecutionState
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| executingCellId | string | false | The ID of the cell currently being executed. | |
| executionFinishedAt | string(date-time) | false | The time the execution finished. This is based on the finish time of the last cell. | |
| executionStartedAt | string(date-time) | false | The time the execution started. | |
| inputRequest | AwaitingInputState | false | The input request state of the cell. | |
| kernelId | string | false | The ID of the kernel used for execution. | |
| queuedCellIds | [string] | false | The IDs of the cells that are queued for execution. |
NotebookExecutionStateSchema
{
"description": "The schema for the notebook execution state.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Notebook execution state model",
"properties": {
"executingCellId": {
"description": "The ID of the cell currently being executed.",
"title": "Executingcellid",
"type": "string"
},
"executionFinishedAt": {
"description": "The time the execution finished. This is based on the finish time of the last cell.",
"format": "date-time",
"title": "Executionfinishedat",
"type": "string"
},
"executionStartedAt": {
"description": "The time the execution started.",
"format": "date-time",
"title": "Executionstartedat",
"type": "string"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"kernelId": {
"description": "The ID of the kernel used for execution.",
"title": "Kernelid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
}
},
"title": "NotebookExecutionState",
"type": "object"
}
],
"description": "Execution state of the notebook.",
"title": "Executionstate"
},
"kernel": {
"allOf": [
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
],
"description": "Kernel assigned to the notebook.",
"title": "Kernel"
},
"kernelId": {
"description": "Kernel ID assigned to the notebook.",
"title": "Kernelid",
"type": "string"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "NotebookExecutionStateSchema",
"type": "object"
}
NotebookExecutionStateSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| executionState | NotebookExecutionState | false | Execution state of the notebook. | |
| kernel | KernelSchema | false | Kernel assigned to the notebook. | |
| kernelId | string | false | Kernel ID assigned to the notebook. | |
| path | string | true | Path to the notebook. |
NotebookFileSchema
{
"description": "The schema for a .ipynb notebook as part of a Codespace.",
"properties": {
"cells": {
"description": "List of cells in the notebook.",
"items": {
"anyOf": [
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
},
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
},
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
]
},
"title": "Cells",
"type": "array"
},
"executionState": {
"allOf": [
{
"description": "Notebook execution state model",
"properties": {
"executingCellId": {
"description": "The ID of the cell currently being executed.",
"title": "Executingcellid",
"type": "string"
},
"executionFinishedAt": {
"description": "The time the execution finished. This is based on the finish time of the last cell.",
"format": "date-time",
"title": "Executionfinishedat",
"type": "string"
},
"executionStartedAt": {
"description": "The time the execution started.",
"format": "date-time",
"title": "Executionstartedat",
"type": "string"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"kernelId": {
"description": "The ID of the kernel used for execution.",
"title": "Kernelid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
}
},
"title": "NotebookExecutionState",
"type": "object"
}
],
"description": "Execution state of the notebook.",
"title": "Executionstate"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"kernelId": {
"description": "Kernel ID assigned to the notebook.",
"title": "Kernelid",
"type": "string"
},
"lastExecuted": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Last executed information.",
"title": "Lastexecuted"
},
"metadata": {
"description": "Metadata for the notebook.",
"title": "Metadata",
"type": "object"
},
"name": {
"description": "Name of the notebook.",
"title": "Name",
"type": "string"
},
"nbformat": {
"description": "The notebook format version.",
"title": "Nbformat",
"type": "integer"
},
"nbformatMinor": {
"description": "The notebook format minor version.",
"title": "Nbformatminor",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path",
"generation",
"nbformat",
"nbformatMinor",
"metadata"
],
"title": "NotebookFileSchema",
"type": "object"
}
NotebookFileSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cells | [anyOf] | false | List of cells in the notebook. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | CodeCellSchema | false | The schema for a code cell in the notebook. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | MarkdownCellSchema | false | The schema for a markdown cell in the notebook. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AnyCellSchema | false | The schema for cells in a notebook that are not code or markdown. |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| executionState | NotebookExecutionState | false | Execution state of the notebook. | |
| generation | integer | true | Integer representing the generation of the notebook. | |
| kernelId | string | false | Kernel ID assigned to the notebook. | |
| lastExecuted | NotebookActionSignature | false | Last executed information. | |
| metadata | object | true | Metadata for the notebook. | |
| name | string | true | Name of the notebook. | |
| nbformat | integer | true | The notebook format version. | |
| nbformatMinor | integer | true | The notebook format minor version. | |
| path | string | true | Path to the notebook. |
NotebookOperationQuery
{
"description": "Base query schema for notebook operations.",
"properties": {
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "NotebookOperationQuery",
"type": "object"
}
NotebookOperationQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| path | string | true | Path to the notebook. |
NotebookOperationSchema
{
"description": "Base schema for notebook operations.",
"properties": {
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "NotebookOperationSchema",
"type": "object"
}
NotebookOperationSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| path | string | true | Path to the notebook. |
NotebookPermission
{
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
}
NotebookPermission
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| NotebookPermission | string | false | The possible allowed actions for the current user for a given Notebook. |
Enumerated Values¶
| Property | Value |
|---|---|
| NotebookPermission | [CAN_READ, CAN_UPDATE, CAN_DELETE, CAN_SHARE, CAN_COPY, CAN_EXECUTE] |
NotebookRevisionSchema
{
"description": "Notebook revision schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"notebookId": {
"description": "Notebook ID this revision belongs to.",
"title": "Notebookid",
"type": "string"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
}
},
"required": [
"revisionId",
"notebookId",
"name",
"isAuto",
"created"
],
"title": "NotebookRevisionSchema",
"type": "object"
}
NotebookRevisionSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created | RevisionActionSchema | true | Revision creation action information. | |
| isAuto | boolean | true | Whether the revision was autosaved. | |
| name | string | true | Revision name. | |
| notebookId | string | true | Notebook ID this revision belongs to. | |
| revisionId | string | true | Revision ID. | |
| updated | RevisionActionSchema | false | Revision update action information. |
NotebookScheduleDefinition
{
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
}
NotebookScheduleDefinition
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdBy | UserInfo | false | User who created the job. | |
| enabled | boolean | true | Whether the job is enabled. | |
| id | string | true | The ID of the scheduled job. | |
| isNotebookRunning | boolean | false | Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces. | |
| jobPayload | ScheduledJobPayload | true | The payload for the job. | |
| lastFailedRun | string(date-time) | false | Last failed run time of the job. | |
| lastRunTime | string(date-time) | false | Calculated last run time (if it has run) by considering both failed and successful. | |
| lastSuccessfulRun | string(date-time) | false | Last successful run time of the job. | |
| nextRunTime | string(date-time) | false | Next run time of the job. | |
| notebook | NotebookSupplementalMetadata | false | Notebook metadata. | |
| notebookHasEnabledSchedule | boolean | false | Whether or not the notebook for this schedule has an enabled schedule - includes other schedules. | |
| notebookType | NotebookType | false | Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that are part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session shutdown. |
|
| permissions | [NotebookPermission] | false | [The possible allowed actions for the current user for a given Notebook.] | |
| runType | RunTypes | false | Types of runs that can be scheduled. | |
| schedule | string | false | Cron-like string to define how frequently job should be run. | |
| scheduleLocalized | string | false | Human-readable string calculated from the cron string that is translated and localized. | |
| title | string | false | Human readable name for the job that a user can create and update. | |
| userId | string | true | The ID of the user who created the job. |
NotebookScheduleJobsPaginated
{
"description": "Paginated response for notebook schedule jobs.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebook schedule jobs.",
"items": {
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
},
"totalEnabledCount": {
"description": "Total number of enabled schedule jobs.",
"title": "Totalenabledcount",
"type": "integer"
}
},
"required": [
"totalEnabledCount"
],
"title": "NotebookScheduleJobsPaginated",
"type": "object"
}
NotebookScheduleJobsPaginated
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [NotebookScheduleDefinition] | false | List of notebook schedule jobs. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. | |
| totalEnabledCount | integer | true | Total number of enabled schedule jobs. |
NotebookScheduledRun
{
"description": "Notebook scheduled run.",
"properties": {
"createdAt": {
"description": "The time the job was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"duration": {
"description": "The duration of the job in seconds.",
"title": "Duration",
"type": "integer"
},
"endTime": {
"description": "The time the job ended.",
"format": "date-time",
"title": "Endtime",
"type": "string"
},
"endTimeTs": {
"description": "The time the job ended.",
"format": "date-time",
"title": "Endtimets",
"type": "string"
},
"environment": {
"allOf": [
{
"description": "Supplemental metadata for an environment.",
"properties": {
"id": {
"description": "The ID of the environment.",
"title": "Id",
"type": "string"
},
"label": {
"description": "The label of the environment.",
"title": "Label",
"type": "string"
},
"name": {
"description": "The name of the environment.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"label"
],
"title": "EnvironmentSupplementalMetadata",
"type": "object"
}
],
"description": "Environment metadata.",
"title": "Environment"
},
"id": {
"description": "The ID of the job run.",
"title": "Id",
"type": "string"
},
"jobAbortedTs": {
"description": "The time the job was aborted.",
"format": "date-time",
"title": "Jobabortedts",
"type": "string"
},
"jobCompletedTs": {
"description": "The time the job completed.",
"format": "date-time",
"title": "Jobcompletedts",
"type": "string"
},
"jobCreatedBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Jobcreatedby"
},
"jobErrorTs": {
"description": "The time the job errored.",
"format": "date-time",
"title": "Joberrorts",
"type": "string"
},
"jobStartedTs": {
"description": "The time the job started.",
"format": "date-time",
"title": "Jobstartedts",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookDeleted": {
"default": false,
"description": "Whether the notebook was deleted.",
"title": "Notebookdeleted",
"type": "boolean"
},
"notebookEnvironmentId": {
"description": "The ID of the notebook environment.",
"title": "Notebookenvironmentid",
"type": "string"
},
"notebookEnvironmentImageId": {
"description": "The ID of the notebook environment image.",
"title": "Notebookenvironmentimageid",
"type": "string"
},
"notebookEnvironmentLabel": {
"description": "The label of the notebook environment.",
"title": "Notebookenvironmentlabel",
"type": "string"
},
"notebookEnvironmentName": {
"description": "The name of the notebook environment.",
"title": "Notebookenvironmentname",
"type": "string"
},
"notebookHadErrors": {
"default": false,
"description": "Whether the notebook had errors.",
"title": "Notebookhaderrors",
"type": "boolean"
},
"notebookId": {
"description": "The ID of the notebook associated with the run.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the run.",
"title": "Notebookname",
"type": "string"
},
"notebookRevisionId": {
"description": "The ID of the notebook revision.",
"title": "Notebookrevisionid",
"type": "string"
},
"notebookRevisionName": {
"description": "The name of the notebook revision.",
"title": "Notebookrevisionname",
"type": "string"
},
"notebookRunType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"payload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Payload"
},
"revision": {
"allOf": [
{
"description": "Supplemental metadata for a revision.",
"properties": {
"id": {
"description": "The ID of the revision.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the revision.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "RevisionSupplementalMetadata",
"type": "object"
}
],
"description": "Revision metadata.",
"title": "Revision"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"scheduledJobId": {
"description": "The ID of the scheduled job.",
"title": "Scheduledjobid",
"type": "string"
},
"startTime": {
"description": "The time the job started.",
"format": "date-time",
"title": "Starttime",
"type": "string"
},
"status": {
"description": "The status of the job.",
"title": "Status",
"type": "string"
},
"title": {
"description": "The name of the schedule.",
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"createdAt",
"useCaseId",
"userId",
"orgId",
"notebookId",
"scheduledJobId",
"title",
"status",
"payload",
"notebookName",
"notebookRunType"
],
"title": "NotebookScheduledRun",
"type": "object"
}
NotebookScheduledRun
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | The time the job was created. | |
| duration | integer | false | The duration of the job in seconds. | |
| endTime | string(date-time) | false | The time the job ended. | |
| endTimeTs | string(date-time) | false | The time the job ended. | |
| environment | EnvironmentSupplementalMetadata | false | Environment metadata. | |
| id | string | true | The ID of the job run. | |
| jobAbortedTs | string(date-time) | false | The time the job was aborted. | |
| jobCompletedTs | string(date-time) | false | The time the job completed. | |
| jobCreatedBy | UserInfo | false | User who created the job. | |
| jobErrorTs | string(date-time) | false | The time the job errored. | |
| jobStartedTs | string(date-time) | false | The time the job started. | |
| notebook | NotebookSupplementalMetadata | false | Notebook metadata. | |
| notebookDeleted | boolean | false | Whether the notebook was deleted. | |
| notebookEnvironmentId | string | false | The ID of the notebook environment. | |
| notebookEnvironmentImageId | string | false | The ID of the notebook environment image. | |
| notebookEnvironmentLabel | string | false | The label of the notebook environment. | |
| notebookEnvironmentName | string | false | The name of the notebook environment. | |
| notebookHadErrors | boolean | false | Whether the notebook had errors. | |
| notebookId | string | true | The ID of the notebook associated with the run. | |
| notebookName | string | true | The name of the notebook associated with the run. | |
| notebookRevisionId | string | false | The ID of the notebook revision. | |
| notebookRevisionName | string | false | The name of the notebook revision. | |
| notebookRunType | RunTypes | true | The run type of the notebook. | |
| orgId | string | true | The ID of the organization the job is associated with. | |
| payload | ScheduledJobPayload | true | The payload for the job. | |
| revision | RevisionSupplementalMetadata | false | Revision metadata. | |
| runType | RunTypes | false | The run type of the job. | |
| scheduledJobId | string | true | The ID of the scheduled job. | |
| startTime | string(date-time) | false | The time the job started. | |
| status | string | true | The status of the job. | |
| title | string | true | The name of the schedule. | |
| useCaseId | string | true | The ID of the use case this notebook is associated with. | |
| useCaseName | string | false | The name of the use case this notebook is associated with. | |
| userId | string | true | The ID of the user who created the job. |
NotebookScheduledRunsHistoryPaginated
{
"description": "Paginated response for notebook scheduled runs history.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebook scheduled runs history.",
"items": {
"description": "Notebook scheduled run.",
"properties": {
"createdAt": {
"description": "The time the job was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"duration": {
"description": "The duration of the job in seconds.",
"title": "Duration",
"type": "integer"
},
"endTime": {
"description": "The time the job ended.",
"format": "date-time",
"title": "Endtime",
"type": "string"
},
"endTimeTs": {
"description": "The time the job ended.",
"format": "date-time",
"title": "Endtimets",
"type": "string"
},
"environment": {
"allOf": [
{
"description": "Supplemental metadata for an environment.",
"properties": {
"id": {
"description": "The ID of the environment.",
"title": "Id",
"type": "string"
},
"label": {
"description": "The label of the environment.",
"title": "Label",
"type": "string"
},
"name": {
"description": "The name of the environment.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"label"
],
"title": "EnvironmentSupplementalMetadata",
"type": "object"
}
],
"description": "Environment metadata.",
"title": "Environment"
},
"id": {
"description": "The ID of the job run.",
"title": "Id",
"type": "string"
},
"jobAbortedTs": {
"description": "The time the job was aborted.",
"format": "date-time",
"title": "Jobabortedts",
"type": "string"
},
"jobCompletedTs": {
"description": "The time the job completed.",
"format": "date-time",
"title": "Jobcompletedts",
"type": "string"
},
"jobCreatedBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Jobcreatedby"
},
"jobErrorTs": {
"description": "The time the job errored.",
"format": "date-time",
"title": "Joberrorts",
"type": "string"
},
"jobStartedTs": {
"description": "The time the job started.",
"format": "date-time",
"title": "Jobstartedts",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookDeleted": {
"default": false,
"description": "Whether the notebook was deleted.",
"title": "Notebookdeleted",
"type": "boolean"
},
"notebookEnvironmentId": {
"description": "The ID of the notebook environment.",
"title": "Notebookenvironmentid",
"type": "string"
},
"notebookEnvironmentImageId": {
"description": "The ID of the notebook environment image.",
"title": "Notebookenvironmentimageid",
"type": "string"
},
"notebookEnvironmentLabel": {
"description": "The label of the notebook environment.",
"title": "Notebookenvironmentlabel",
"type": "string"
},
"notebookEnvironmentName": {
"description": "The name of the notebook environment.",
"title": "Notebookenvironmentname",
"type": "string"
},
"notebookHadErrors": {
"default": false,
"description": "Whether the notebook had errors.",
"title": "Notebookhaderrors",
"type": "boolean"
},
"notebookId": {
"description": "The ID of the notebook associated with the run.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the run.",
"title": "Notebookname",
"type": "string"
},
"notebookRevisionId": {
"description": "The ID of the notebook revision.",
"title": "Notebookrevisionid",
"type": "string"
},
"notebookRevisionName": {
"description": "The name of the notebook revision.",
"title": "Notebookrevisionname",
"type": "string"
},
"notebookRunType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"payload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Payload"
},
"revision": {
"allOf": [
{
"description": "Supplemental metadata for a revision.",
"properties": {
"id": {
"description": "The ID of the revision.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the revision.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "RevisionSupplementalMetadata",
"type": "object"
}
],
"description": "Revision metadata.",
"title": "Revision"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"scheduledJobId": {
"description": "The ID of the scheduled job.",
"title": "Scheduledjobid",
"type": "string"
},
"startTime": {
"description": "The time the job started.",
"format": "date-time",
"title": "Starttime",
"type": "string"
},
"status": {
"description": "The status of the job.",
"title": "Status",
"type": "string"
},
"title": {
"description": "The name of the schedule.",
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"createdAt",
"useCaseId",
"userId",
"orgId",
"notebookId",
"scheduledJobId",
"title",
"status",
"payload",
"notebookName",
"notebookRunType"
],
"title": "NotebookScheduledRun",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "NotebookScheduledRunsHistoryPaginated",
"type": "object"
}
NotebookScheduledRunsHistoryPaginated
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [NotebookScheduledRun] | false | List of notebook scheduled runs history. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. |
NotebookSchema
{
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
}
NotebookSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created | NotebookActionSignature | true | Information about the creation of the notebook. | |
| description | string | false | The description of the notebook. | |
| hasEnabledSchedule | boolean | false | Whether the notebook has an enabled schedule. | |
| hasSchedule | boolean | false | Whether the notebook has a schedule. | |
| id | string | true | The ID of the notebook. | |
| lastViewed | NotebookActionSignature | true | Information about the last viewed time of the notebook. | |
| name | string | true | The name of the notebook. | |
| orgId | string | false | The ID of the organization associated with the notebook. | |
| permissions | [NotebookPermission] | false | The permissions associated with the notebook. | |
| session | NotebookSessionSharedSchema | false | Information about the session associated with the notebook. | |
| settings | NotebookSettings | false | The settings of the notebook. | |
| tags | [string] | false | The tags of the notebook. | |
| tenantId | string | false | The tenant ID associated with the notebook. | |
| type | NotebookType | false | The type of the notebook. | |
| typeTransition | NotebookTypeTransition | false | The type transition of the notebook. | |
| updated | NotebookActionSignature | false | Information about the last update of the notebook. | |
| useCaseId | string | false | The ID of the Use Case associated with the notebook. | |
| useCaseName | string | false | The name of the Use Case associated with the notebook. |
NotebookSessionSchema
{
"description": "The schema for the notebook session.",
"properties": {
"environment": {
"allOf": [
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
],
"description": "The environment of the notebook session.",
"title": "Environment"
},
"ephemeralSessionKey": {
"allOf": [
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
],
"description": "The key of the ephemeral session. None if not an ephemeral session.",
"title": "Ephemeralsessionkey"
},
"executionCount": {
"default": 0,
"description": "The execution count of the notebook session.",
"title": "Executioncount",
"type": "integer"
},
"machineStatus": {
"allOf": [
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
],
"description": "The status of the machine running the notebook session."
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runnerStatus": {
"allOf": [
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
],
"description": "The status of the runner for the notebook session."
},
"sessionId": {
"description": "The ID of the notebook session.",
"title": "Sessionid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"default": "interactive",
"description": "The type of the notebook session. Possible values are interactive and triggered."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"startedBy": {
"allOf": [
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
],
"description": "The user who started the notebook session.",
"title": "Startedby"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
},
"withNetworkPolicy": {
"description": "Whether the session is created with network policies.",
"title": "Withnetworkpolicy",
"type": "boolean"
}
},
"required": [
"status",
"notebookId",
"sessionId",
"environment",
"machineStatus",
"runnerStatus"
],
"title": "NotebookSessionSchema",
"type": "object"
}
NotebookSessionSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| environment | EnvironmentPublic | true | The environment of the notebook session. | |
| ephemeralSessionKey | EphemeralSessionKey | false | The key of the ephemeral session. None if not an ephemeral session. | |
| executionCount | integer | false | The execution count of the notebook session. | |
| machineStatus | MachineStatuses | true | The status of the machine running the notebook session. | |
| notebookId | string | true | The ID of the notebook. | |
| parameters | [ScheduledJobParam] | false | Parameters to use as environment variables. | |
| runnerStatus | RunnerStatuses | true | The status of the runner for the notebook session. | |
| sessionId | string | true | The ID of the notebook session. | |
| sessionType | SessionType | false | The type of the notebook session. Possible values are interactive and triggered. | |
| startedAt | string(date-time) | false | The time the notebook session was started. | |
| startedBy | NotebookUserSchema | false | The user who started the notebook session. | |
| status | NotebookSessionStatus | true | The status of the notebook session. | |
| userId | string | false | The ID of the user associated with the notebook session. | |
| withNetworkPolicy | boolean | false | Whether the session is created with network policies. |
NotebookSessionSharedSchema
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
NotebookSessionSharedSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| notebookId | string | true | The ID of the notebook. | |
| sessionType | SessionType | false | The type of the notebook session. | |
| startedAt | string(date-time) | false | The time the notebook session was started. | |
| status | NotebookSessionStatus | true | The status of the notebook session. | |
| userId | string | false | The ID of the user associated with the notebook session. |
NotebookSessionStatus
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
NotebookSessionStatus
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| NotebookSessionStatus | string | false | Possible overall states of a notebook session. |
Enumerated Values¶
| Property | Value |
|---|---|
| NotebookSessionStatus | [stopping, stopped, starting, running, restarting, dead, deleted] |
NotebookSettings
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
NotebookSettings
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hideCellFooters | boolean | false | Whether or not cell footers are hidden in the UI. | |
| hideCellOutputs | boolean | false | Whether or not cell outputs are hidden in the UI. | |
| hideCellTitles | boolean | false | Whether or not cell titles are hidden in the UI. | |
| highlightWhitespace | boolean | false | Whether or whitespace is highlighted in the UI. | |
| showLineNumbers | boolean | false | Whether or not line numbers are shown in the UI. | |
| showScrollers | boolean | false | Whether or not scroll bars are shown in the UI. |
NotebookSharedRole
{
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type.",
"enum": [
"user"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The identifier of the recipient. | |
| name | string | true | The name of the recipient. | |
| role | string | true | The role of the recipient on this entity. | |
| shareRecipientType | string | true | The recipient type. |
Enumerated Values¶
| Property | Value |
|---|---|
| role | [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
| shareRecipientType | user |
NotebookSupplementalMetadata
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
NotebookSupplementalMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| deleted | boolean | false | Whether the notebook is deleted. | |
| id | string | true | Notebook ID. | |
| name | string | true | Notebook name. | |
| sessionStatus | NotebookSessionStatus | false | Status of the notebook session. | |
| sessionType | SessionType | false | Type of the notebook session. | |
| useCaseId | string | false | Use case ID associated with the notebook. | |
| useCaseName | string | false | Use case name associated with the notebook. |
NotebookTimestampInfo
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
NotebookTimestampInfo
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| at | string(date-time) | true | Timestamp of the action. | |
| by | UserInfo | true | User info of the actor who caused the action to occur. |
NotebookType
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
NotebookType
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| NotebookType | string | false | Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that are part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session shutdown. |
Enumerated Values¶
| Property | Value |
|---|---|
| NotebookType | [plain, codespace, ephemeral] |
NotebookTypeTransition
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
NotebookTypeTransition
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| NotebookTypeTransition | string | false | An enumeration. |
Enumerated Values¶
| Property | Value |
|---|---|
| NotebookTypeTransition | [initiated_to_codespace, completed] |
NotebookUserSchema
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
NotebookUserSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| activated | boolean | false | Whether the user is activated. | |
| firstName | string | false | The first name of the user. | |
| gravatarHash | string | false | The gravatar hash of the user. | |
| id | string | true | The ID of the user. | |
| lastName | string | false | The last name of the user. | |
| orgId | string | false | The ID of the organization the user belongs to. | |
| permissions | UserFeatureFlags | false | The feature flags of the user. | |
| tenantPhase | string | false | The tenant phase of the user. | |
| username | string | false | The username of the user. |
NotebooksExecutionStateResponse
{
"description": "Response schema for the notebooks execution state.",
"properties": {
"states": {
"description": "List of notebooks execution states.",
"items": {
"description": "The schema for the notebook execution state.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Notebook execution state model",
"properties": {
"executingCellId": {
"description": "The ID of the cell currently being executed.",
"title": "Executingcellid",
"type": "string"
},
"executionFinishedAt": {
"description": "The time the execution finished. This is based on the finish time of the last cell.",
"format": "date-time",
"title": "Executionfinishedat",
"type": "string"
},
"executionStartedAt": {
"description": "The time the execution started.",
"format": "date-time",
"title": "Executionstartedat",
"type": "string"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"kernelId": {
"description": "The ID of the kernel used for execution.",
"title": "Kernelid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
}
},
"title": "NotebookExecutionState",
"type": "object"
}
],
"description": "Execution state of the notebook.",
"title": "Executionstate"
},
"kernel": {
"allOf": [
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
],
"description": "Kernel assigned to the notebook.",
"title": "Kernel"
},
"kernelId": {
"description": "Kernel ID assigned to the notebook.",
"title": "Kernelid",
"type": "string"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "NotebookExecutionStateSchema",
"type": "object"
},
"title": "States",
"type": "array"
}
},
"required": [
"states"
],
"title": "NotebooksExecutionStateResponse",
"type": "object"
}
NotebooksExecutionStateResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| states | [NotebookExecutionStateSchema] | true | List of notebooks execution states. |
NotebooksSharedRolesListResponse
{
"properties": {
"data": {
"description": "Roles data for multiple notebooks.",
"items": {
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"type": "string"
},
"roles": {
"description": "Individual roles data for the notebook.",
"items": {
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type.",
"enum": [
"user"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object",
"x-versionadded": "v2.35"
},
"type": "array"
}
},
"required": [
"notebookId",
"roles"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"data"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [MultipleNotebooksSharedRole] | true | maxItems: 100 |
Roles data for multiple notebooks. |
OrderBy
{
"description": "Enum for ordering notebooks when querying.",
"enum": [
"name",
"-name",
"created",
"-created",
"updated",
"-updated",
"tags",
"-tags",
"lastViewed",
"-lastViewed",
"useCaseName",
"-useCaseName",
"sessionStatus",
"-sessionStatus"
],
"title": "OrderBy",
"type": "string"
}
OrderBy
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| OrderBy | string | false | Enum for ordering notebooks when querying. |
Enumerated Values¶
| Property | Value |
|---|---|
| OrderBy | [name, -name, created, -created, updated, -updated, tags, -tags, lastViewed, -lastViewed, useCaseName, -useCaseName, sessionStatus, -sessionStatus] |
OutputStorageType
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
OutputStorageType
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| OutputStorageType | string | false | The possible allowed values for where/how notebook cell output is stored. |
Enumerated Values¶
| Property | Value |
|---|---|
| OutputStorageType | RAW_OUTPUT |
OutputType
{
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
OutputType
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| OutputType | string | false | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
Enumerated Values¶
| Property | Value |
|---|---|
| OutputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
PaginatedDataframeQuery
{
"description": "Query schema for paginated dataframe requests.",
"properties": {
"cellId": {
"description": "ID of the cell.",
"title": "Cellid",
"type": "string"
},
"limit": {
"default": 10,
"description": "Maximum number of objects to return.",
"exclusiveMinimum": 0,
"maximum": 1000,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Offset for pagination.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
},
"sortBy": {
"description": "Sort results by this field.",
"title": "Sortby",
"type": "string"
}
},
"required": [
"path",
"cellId"
],
"title": "PaginatedDataframeQuery",
"type": "object"
}
PaginatedDataframeQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellId | string | true | ID of the cell. | |
| limit | integer | false | maximum: 1000 |
Maximum number of objects to return. |
| offset | integer | false | minimum: 0 |
Offset for pagination. |
| path | string | true | Path to the notebook. | |
| sortBy | string | false | Sort results by this field. |
ReorderCellsRequest
{
"description": "Request payload values for reordering notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cellIds": {
"description": "List of cell IDs to reorder.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cellIds"
],
"title": "ReorderCellsRequest",
"type": "object"
}
ReorderCellsRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionId | string | false | maxLength: 64 |
Action ID of the notebook update request. |
| cellIds | [string] | true | List of cell IDs to reorder. | |
| generation | integer | true | Integer representing the generation of the notebook. | |
| path | string | true | Path to the notebook. |
RequiredMetadataKey
{
"description": "Define additional parameters required to assemble a model. Model versions using this environment must define values\nfor each fieldName in the requiredMetadata.",
"properties": {
"displayName": {
"description": "A human readable name for the required field.",
"title": "Displayname",
"type": "string"
},
"fieldName": {
"description": "The required field key. This value is added as an environment variable when running custom models.",
"title": "Fieldname",
"type": "string"
}
},
"required": [
"fieldName",
"displayName"
],
"title": "RequiredMetadataKey",
"type": "object"
}
RequiredMetadataKey
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| displayName | string | true | A human readable name for the required field. | |
| fieldName | string | true | The required field key. This value is added as an environment variable when running custom models. |
RevisionActionSchema
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
RevisionActionSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| at | string(date-time) | true | Action timestamp. | |
| by | UserInfo | false | User who performed the action. |
RevisionSupplementalMetadata
{
"description": "Supplemental metadata for a revision.",
"properties": {
"id": {
"description": "The ID of the revision.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the revision.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "RevisionSupplementalMetadata",
"type": "object"
}
RevisionSupplementalMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the revision. | |
| name | string | true | The name of the revision. |
RunFileRequest
{
"description": "Request payload values for running a file.",
"properties": {
"commandArgs": {
"description": "Arguments and/or flags to pass to a file execution command. For example: '--filename foo.txt -r'",
"title": "Commandargs",
"type": "string"
},
"commandType": {
"allOf": [
{
"description": "These are the command types/languages we support running files for.",
"enum": [
"python",
"bash"
],
"title": "RunnableCommandType",
"type": "string"
}
],
"description": "The type of command to be run. For example 'python'"
},
"filePath": {
"description": "Path to the file to execute.",
"title": "Filepath",
"type": "string"
}
},
"required": [
"filePath"
],
"title": "RunFileRequest",
"type": "object"
}
RunFileRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| commandArgs | string | false | Arguments and/or flags to pass to a file execution command. For example: '--filename foo.txt -r' | |
| commandType | RunnableCommandType | false | The type of command to be run. For example 'python' | |
| filePath | string | true | Path to the file to execute. |
RunTypes
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
RunTypes
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| RunTypes | string | false | Types of runs that can be scheduled. |
Enumerated Values¶
| Property | Value |
|---|---|
| RunTypes | [scheduled, manual, pipeline] |
RunnableCommandType
{
"description": "These are the command types/languages we support running files for.",
"enum": [
"python",
"bash"
],
"title": "RunnableCommandType",
"type": "string"
}
RunnableCommandType
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| RunnableCommandType | string | false | These are the command types/languages we support running files for. |
Enumerated Values¶
| Property | Value |
|---|---|
| RunnableCommandType | [python, bash] |
RunnerStatuses
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
RunnerStatuses
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| RunnerStatuses | string | false | Runner is the same as kernel since it will manage multiple kernels in the future, We can't consider kernel running if runner is not functioning and therefor this enum represents possible statuses of the kernel and runner sidecar functionality states. In the future this will likely be renamed to kernel. |
Enumerated Values¶
| Property | Value |
|---|---|
| RunnerStatuses | [not_started, starting, running, restarting, stopping, stopped, dead, deleted] |
RuntimeLanguage
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
RuntimeLanguage
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| RuntimeLanguage | string | false | Runtime language for notebook execution in the kernel. |
Enumerated Values¶
| Property | Value |
|---|---|
| RuntimeLanguage | [python, r, shell, markdown] |
Schedule
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
Schedule
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
ScheduledHistoryListOrderBy
{
"description": "An enumeration.",
"enum": [
"created",
"-created",
"title",
"-title",
"notebookName",
"-notebookName",
"runType",
"-runType",
"status",
"-status",
"startTime",
"-startTime",
"endTime",
"-endTime",
"duration",
"-duration",
"revisionName",
"-revisionName",
"environmentName",
"-environmentName",
"useCaseName",
"-useCaseName"
],
"title": "ScheduledHistoryListOrderBy",
"type": "string"
}
ScheduledHistoryListOrderBy
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ScheduledHistoryListOrderBy | string | false | An enumeration. |
Enumerated Values¶
| Property | Value |
|---|---|
| ScheduledHistoryListOrderBy | [created, -created, title, -title, notebookName, -notebookName, runType, -runType, status, -status, startTime, -startTime, endTime, -endTime, duration, -duration, revisionName, -revisionName, environmentName, -environmentName, useCaseName, -useCaseName] |
ScheduledJobListOrderBy
{
"description": "Fields to order the list of scheduled jobs by.",
"enum": [
"title",
"-title",
"username",
"-username",
"notebookName",
"-notebookName",
"useCaseName",
"-useCaseName",
"status",
"-status",
"schedule",
"-schedule",
"lastRun",
"-lastRun",
"nextRun",
"-nextRun"
],
"title": "ScheduledJobListOrderBy",
"type": "string"
}
ScheduledJobListOrderBy
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ScheduledJobListOrderBy | string | false | Fields to order the list of scheduled jobs by. |
Enumerated Values¶
| Property | Value |
|---|---|
| ScheduledJobListOrderBy | [title, -title, username, -username, notebookName, -notebookName, useCaseName, -useCaseName, status, -status, schedule, -schedule, lastRun, -lastRun, nextRun, -nextRun] |
ScheduledJobParam
{
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
}
ScheduledJobParam
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | maxLength: 256 |
Environment variable name. |
| value | string | true | maxLength: 131072 |
Environment variable value. |
ScheduledJobPayload
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
ScheduledJobPayload
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| notebookId | string | true | The ID of the notebook associated with the schedule. | |
| notebookName | string | true | The name of the notebook associated with the schedule. | |
| notebookPath | string | false | The path to the notebook in the file system if a Codespace is being used. | |
| notebookType | NotebookType | false | The type of notebook. | |
| orgId | string | true | The ID of the organization the job is associated with. | |
| parameters | [ScheduledJobParam] | false | The parameters to pass to the notebook when it runs. | |
| runType | RunTypes | false | The run type of the job. | |
| uid | string | true | The ID of the user who created the job. | |
| useCaseId | string | true | The ID of the use case this notebook is associated with. | |
| useCaseName | string | false | The name of the use case this notebook is associated with. |
ScheduledJobQuery
{
"description": "Query parameters for a scheduled job.",
"properties": {
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId"
],
"title": "ScheduledJobQuery",
"type": "object"
}
ScheduledJobQuery
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| useCaseId | string | true | The ID of the use case this notebook is associated with. |
SessionType
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
SessionType
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| SessionType | string | false | Session type is either 'interactive', meaning a user has started the session via their own interactions or 'triggered' for when a session is started programmatically. |
Enumerated Values¶
| Property | Value |
|---|---|
| SessionType | [interactive, triggered] |
SharingListV2Response
{
"properties": {
"count": {
"description": "The number of items returned.",
"type": "integer"
},
"data": {
"description": "The access control list.",
"items": {
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The type of the recipient.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page.",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page.",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of items matching the condition.",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | true | The number of items returned. | |
| data | [AccessControlV2] | true | maxItems: 1000 |
The access control list. |
| next | string,null | true | URL pointing to the next page. | |
| previous | string,null | true | URL pointing to the previous page. | |
| totalCount | integer | true | Total number of items matching the condition. |
SortedPaginationQuerySchema
{
"description": "Schema for query parameters for paginated requests.",
"properties": {
"limit": {
"default": 10,
"description": "The limit or results to return.",
"exclusiveMinimum": 0,
"maximum": 100,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "The offset to use when querying paginated results.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"sortBy": {
"description": "Field to sort by.",
"title": "Sortby",
"type": "string"
}
},
"title": "SortedPaginationQuerySchema",
"type": "object"
}
SortedPaginationQuerySchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| limit | integer | false | maximum: 100 |
The limit or results to return. |
| offset | integer | false | minimum: 0 |
The offset to use when querying paginated results. |
| sortBy | string | false | Field to sort by. |
SourceDestinationSchema
{
"description": "Source and destination schema for filesystem object operations.",
"properties": {
"destination": {
"description": "Destination path.",
"title": "Destination",
"type": "string"
},
"source": {
"description": "Source path.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"destination"
],
"title": "SourceDestinationSchema",
"type": "object"
}
SourceDestinationSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| destination | string | true | Destination path. | |
| source | string | true | Source path. |
StartKernelRequest
{
"description": "Request payload values for starting a kernel.",
"properties": {
"spec": {
"description": "Name of the kernel to start. Possible values include 'python3', 'ir'.",
"title": "Spec",
"type": "string"
}
},
"required": [
"spec"
],
"title": "StartKernelRequest",
"type": "object"
}
StartKernelRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| spec | string | true | Name of the kernel to start. Possible values include 'python3', 'ir'. |
StartNotebookSessionSchema
{
"description": "Schema for starting a notebook session.",
"properties": {
"cloneRepository": {
"allOf": [
{
"description": "Schema for cloning a repository.",
"properties": {
"checkoutRef": {
"description": "The branch or commit to checkout.",
"title": "Checkoutref",
"type": "string"
},
"url": {
"description": "The URL of the repository to clone.",
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "CloneRepositorySchema",
"type": "object"
}
],
"description": "Automatically tells the runner to clone remote repository if it's supported as part of its environment setup flow.",
"title": "Clonerepository"
},
"isTriggeredRun": {
"default": false,
"description": "Indicates if the session is a triggered run versus an interactive run.",
"title": "Istriggeredrun",
"type": "boolean"
},
"openFilePaths": {
"description": "List of file paths to open in the notebook session.",
"items": {
"type": "string"
},
"title": "Openfilepaths",
"type": "array"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
}
},
"title": "StartNotebookSessionSchema",
"type": "object"
}
StartNotebookSessionSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cloneRepository | CloneRepositorySchema | false | Automatically tells the runner to clone remote repository if it's supported as part of its environment setup flow. | |
| isTriggeredRun | boolean | false | Indicates if the session is a triggered run versus an interactive run. | |
| openFilePaths | [string] | false | List of file paths to open in the notebook session. | |
| parameters | [ScheduledJobParam] | false | Parameters to use as environment variables. |
StreamOutputSchema
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
}
StreamOutputSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | Name of the stream. | |
| outputType | string | false | Type of the output. | |
| text | any | true | Text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
SuccessResponse
{
"description": "Response schema indicating successful or failed operation.",
"properties": {
"success": {
"description": "Indicates whether the operation was successful.",
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
}
SuccessResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| success | boolean | true | Indicates whether the operation was successful. |
SupportedCellTypes
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
SupportedCellTypes
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| SupportedCellTypes | string | false | Supported cell types for notebooks. |
Enumerated Values¶
| Property | Value |
|---|---|
| SupportedCellTypes | [code, markdown] |
TerminalSchema
{
"description": "Schema for a terminal.",
"properties": {
"createdAt": {
"description": "Creation time of the terminal.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
},
"terminalId": {
"description": "ID of the terminal.",
"title": "Terminalid",
"type": "string"
}
},
"required": [
"terminalId",
"name",
"createdAt"
],
"title": "TerminalSchema",
"type": "object"
}
TerminalSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | Creation time of the terminal. | |
| name | string | true | Name of the terminal. | |
| terminalId | string | true | ID of the terminal. |
TerminalsResponseSchema
{
"description": "Schema for the list of terminals in a notebook.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of terminals in a notebook.",
"items": {
"description": "Schema for a terminal.",
"properties": {
"createdAt": {
"description": "Creation time of the terminal.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
},
"terminalId": {
"description": "ID of the terminal.",
"title": "Terminalid",
"type": "string"
}
},
"required": [
"terminalId",
"name",
"createdAt"
],
"title": "TerminalSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "TerminalsResponseSchema",
"type": "object"
}
TerminalsResponseSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | The total of paginated results. | |
| data | [TerminalSchema] | false | List of terminals in a notebook. | |
| next | string | false | The URL to fetch the next batch of results. | |
| previous | string | false | The URL to fetch the previous batch of results. | |
| totalCount | integer | false | The total of all results. |
TriggeredNotebookExecutionRequest
{
"description": "Request payload values for executing a notebook with parameters.",
"properties": {
"parameters": {
"description": "List of parameters to use as environment variables during execution.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "TriggeredNotebookExecutionRequest",
"type": "object"
}
TriggeredNotebookExecutionRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| parameters | [ScheduledJobParam] | false | List of parameters to use as environment variables during execution. | |
| path | string | true | Path to the notebook. |
UpdateCellRequest
{
"description": "Request schema for updating a notebook cell.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "The ID of the cell after which to create the new cell.",
"title": "Aftercellid"
},
"attachments": {
"description": "The attachments associated with the cell.",
"title": "Attachments",
"type": "object"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata associated with the cell.",
"title": "Metadata"
},
"source": {
"description": "Contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"md5"
],
"title": "UpdateCellRequest",
"type": "object"
}
UpdateCellRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| afterCellId | any | false | The ID of the cell after which to create the new cell. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attachments | object | false | The attachments associated with the cell. | |
| md5 | string | true | The MD5 hash of the cell. | |
| metadata | NotebookCellMetadata | false | The metadata associated with the cell. | |
| source | string | false | Contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| anonymous | FIRST |
UpdateCellsRequest
{
"description": "Request payload values for updating notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cells": {
"description": "List of updated notebook cells.",
"items": {
"description": "The schema for the updated notebook cell.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "UpdateNotebookCellSchema",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cells"
],
"title": "UpdateCellsRequest",
"type": "object"
}
UpdateCellsRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionId | string | false | maxLength: 64 |
Action ID of notebook update request. |
| cells | [UpdateNotebookCellSchema] | true | List of updated notebook cells. | |
| generation | integer | true | Integer representing the generation of the notebook. | |
| path | string | true | Path to the notebook. |
UpdateClientActivityRequest
{
"description": "Empty payload used when updating the client activity for a notebook session.",
"properties": {},
"title": "UpdateClientActivityRequest",
"type": "object"
}
UpdateClientActivityRequest
Properties¶
None
UpdateExposedPortSchema
{
"description": "Port update schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
}
},
"title": "UpdateExposedPortSchema",
"type": "object"
}
UpdateExposedPortSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | maxLength: 500 |
Description of the exposed port. |
| port | integer | false | Exposed port number. |
UpdateFilesystemObjectMetadata
{
"description": "Update filesystem object metadata path and values.",
"properties": {
"metadata": {
"allOf": [
{
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
}
],
"description": "Metadata to update.",
"title": "Metadata"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"metadata"
],
"title": "UpdateFilesystemObjectMetadata",
"type": "object"
}
UpdateFilesystemObjectMetadata
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | DRFileMetadata | true | Metadata to update. | |
| path | string | true | Path to the filesystem object. |
UpdateFilesystemObjectsMetadataRequest
{
"description": "Request payload values for updating filesystem object metadata.",
"properties": {
"updates": {
"description": "List of updates to apply.",
"items": {
"description": "Update filesystem object metadata path and values.",
"properties": {
"metadata": {
"allOf": [
{
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
}
],
"description": "Metadata to update.",
"title": "Metadata"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"metadata"
],
"title": "UpdateFilesystemObjectMetadata",
"type": "object"
},
"title": "Updates",
"type": "array"
}
},
"title": "UpdateFilesystemObjectsMetadataRequest",
"type": "object"
}
UpdateFilesystemObjectsMetadataRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updates | [UpdateFilesystemObjectMetadata] | false | List of updates to apply. |
UpdateNotebookCellSchema
{
"description": "The schema for the updated notebook cell.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "Notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "UpdateNotebookCellSchema",
"type": "object"
}
UpdateNotebookCellSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cellType | SupportedCellTypes | false | Type of the cell. | |
| id | string | true | ID of the cell. | |
| metadata | NotebookCellMetadata | false | Metadata of the cell. | |
| source | any | false | Contents of the cell, represented as a string. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
UpdateNotebookRequest
{
"description": "Request schema for updating a notebook.",
"properties": {
"description": {
"description": "The value to update the description of the notebook to.",
"title": "Description",
"type": "string"
},
"name": {
"description": "The value to update the name of the notebook to.",
"title": "Name",
"type": "string"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"description": "The value to update the settings of the notebook to.",
"title": "Settings"
},
"tags": {
"description": "The value to update the tags of the notebook to.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"useCaseId": {
"description": "The value to update the Use Case ID of the notebook to.",
"title": "Usecaseid",
"type": "string"
}
},
"title": "UpdateNotebookRequest",
"type": "object"
}
UpdateNotebookRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | The value to update the description of the notebook to. | |
| name | string | false | The value to update the name of the notebook to. | |
| settings | NotebookSettings | false | The value to update the settings of the notebook to. | |
| tags | [string] | false | The value to update the tags of the notebook to. | |
| useCaseId | string | false | The value to update the Use Case ID of the notebook to. |
UpdateNotebookRevisionRequest
{
"description": "Request",
"properties": {
"isAuto": {
"default": false,
"description": "Whether the revision is autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Notebook revision name.",
"minLength": 1,
"title": "Name",
"type": "string"
},
"notebookPath": {
"description": "Path to the notebook file, if using Codespaces.",
"title": "Notebookpath",
"type": "string"
}
},
"title": "UpdateNotebookRevisionRequest",
"type": "object"
}
UpdateNotebookRevisionRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isAuto | boolean | false | Whether the revision is autosaved. | |
| name | string | false | minLength: 1 minLength: 1 |
Notebook revision name. |
| notebookPath | string | false | Path to the notebook file, if using Codespaces. |
UpdateScheduledJobRequest
{
"description": "Request to update an existing scheduled job.",
"properties": {
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule for the job.",
"title": "Schedule"
},
"title": {
"description": "The title of the scheduled job.",
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId"
],
"title": "UpdateScheduledJobRequest",
"type": "object"
}
UpdateScheduledJobRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| enabled | boolean | false | Whether the job is enabled. | |
| parameters | [ScheduledJobParam] | false | The parameters to pass to the notebook when it runs. | |
| schedule | Schedule | false | The schedule for the job. | |
| title | string | false | maxLength: 100 minLength: 1 minLength: 1 |
The title of the scheduled job. |
| useCaseId | string | true | The ID of the use case this notebook is associated with. |
UpdateTerminalSchema
{
"description": "Schema for updating a terminal.",
"properties": {
"name": {
"description": "Name to update the terminal with.",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "UpdateTerminalSchema",
"type": "object"
}
UpdateTerminalSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | Name to update the terminal with. |
UserFeatureFlags
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
UserFeatureFlags
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| DISABLE_CODESPACE_SCHEDULING | boolean | false | Whether codespace scheduling is disabled for the user. | |
| DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING | boolean | false | Dummy feature flag used for testing. | |
| DISABLE_NOTEBOOKS_CODESPACES | boolean | false | Whether codespaces are disabled for the user. | |
| DISABLE_NOTEBOOKS_SCHEDULING | boolean | false | Whether scheduling is disabled for the user. | |
| DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING | boolean | false | Whether session port forwarding is disabled for the user. | |
| ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING | boolean | false | Dummy feature flag used for testing. | |
| ENABLE_MMM_HOSTED_CUSTOM_METRICS | boolean | false | Whether custom metrics are enabled for the user. | |
| ENABLE_NOTEBOOKS | boolean | false | Whether notebooks are enabled for the user. | |
| ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS | boolean | false | Whether custom environments are enabled for the user. | |
| ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT | boolean | false | Whether filesystem management is enabled for the user. | |
| ENABLE_NOTEBOOKS_GPU | boolean | false | Whether GPU is enabled for the user. | |
| ENABLE_NOTEBOOKS_OPEN_AI | boolean | false | Whether OpenAI is enabled for the user. | |
| ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING | boolean | false | Whether session port forwarding is enabled for the user. | |
| ENABLE_NOTEBOOKS_TERMINAL | boolean | false | Whether terminals are enabled for the user. |
UserInfo
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
UserInfo
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| activated | boolean | false | Whether the user is activated. | |
| firstName | string | false | The first name of the user. | |
| gravatarHash | string | false | The gravatar hash of the user. | |
| id | string | true | The ID of the user. | |
| lastName | string | false | The last name of the user. | |
| orgId | string | false | The ID of the organization the user belongs to. | |
| tenantPhase | string | false | The tenant phase of the user. | |
| username | string | false | The username of the user. |
VCSCommandStatus
{
"description": "Status of the VCS command.",
"enum": [
"not_inited",
"running",
"finished",
"error"
],
"title": "VCSCommandStatus",
"type": "string"
}
VCSCommandStatus
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| VCSCommandStatus | string | false | Status of the VCS command. |
Enumerated Values¶
| Property | Value |
|---|---|
| VCSCommandStatus | [not_inited, running, finished, error] |
VersionedNotebookSchema
{
"description": "Versioned notebook schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"lastViewed": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision last viewed action information.",
"title": "Lastviewed"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "Organization ID.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "Notebook permissions.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "Notebook settings.",
"title": "Settings"
},
"tags": {
"description": "Notebook tags.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
},
"useCaseId": {
"description": "Use case ID.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"id",
"revisionId",
"name",
"isAuto",
"created",
"lastViewed"
],
"title": "VersionedNotebookSchema",
"type": "object"
}
VersionedNotebookSchema
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created | RevisionActionSchema | true | Revision creation action information. | |
| id | string | true | Notebook ID. | |
| isAuto | boolean | true | Whether the revision was autosaved. | |
| lastViewed | RevisionActionSchema | true | Revision last viewed action information. | |
| name | string | true | Revision name. | |
| orgId | string | false | Organization ID. | |
| permissions | [NotebookPermission] | false | Notebook permissions. | |
| revisionId | string | true | Revision ID. | |
| settings | NotebookSettings | false | Notebook settings. | |
| tags | [string] | false | Notebook tags. | |
| updated | RevisionActionSchema | false | Revision update action information. | |
| useCaseId | string | false | Use case ID. |