Skip to content

アプリケーション内で をクリックすると、お使いのDataRobotバージョンに関する全プラットフォームドキュメントにアクセスできます。

Blueprints

This page outlines the operations, endpoints, parameters, and example requests and responses for the Blueprints.

GET /api/v2/projects/{projectId}/blueprints/

List appropriate blueprints for the project.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/blueprints/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID.

Example responses

200 Response

[
  {
    "blueprintCategory": "string",
    "id": "string",
    "isCustomModelBlueprint": true,
    "modelType": "string",
    "monotonicDecreasingFeaturelistId": "string",
    "monotonicIncreasingFeaturelistId": "string",
    "processes": [
      "string"
    ],
    "projectId": "string",
    "recommendedFeaturelistId": "string",
    "supportsComposableMl": true,
    "supportsIncrementalLearning": true,
    "supportsMonotonicConstraints": true
  }
]

Responses

Status Meaning Description Schema
200 OK The list of blueprints Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BlueprintResponse] false none
» blueprintCategory string true describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either "DataRobot" or "Scaleout DataRobot".
» id string true the blueprint ID of this blueprint - note that this is not an ObjectId.
» isCustomModelBlueprint boolean true Whether blueprint contains custom task.
» modelType string true the model this blueprint will produce.
» monotonicDecreasingFeaturelistId string¦null true the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.
» monotonicIncreasingFeaturelistId string¦null true null or str, the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.
» processes [string] true a list of strings representing processes the blueprint uses.
» projectId string true the project the blueprint belongs to.
» recommendedFeaturelistId string¦null false The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.
» supportsComposableMl boolean true indicates whether this blueprint is supported in Composable ML.
» supportsIncrementalLearning boolean true Whether blueprint supports incremental learning.
» supportsMonotonicConstraints boolean true whether this model supports enforcing monotonic constraints.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/

Retrieve a blueprint by its ID.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/blueprints/{blueprintId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

{
  "blueprintCategory": "string",
  "id": "string",
  "isCustomModelBlueprint": true,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "processes": [
    "string"
  ],
  "projectId": "string",
  "recommendedFeaturelistId": "string",
  "supportsComposableMl": true,
  "supportsIncrementalLearning": true,
  "supportsMonotonicConstraints": true
}

Responses

Status Meaning Description Schema
200 OK A blueprint based on its blueprint ID. BlueprintResponse
404 Not Found This resource does not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintChart/

Retrieve a blueprint chart by blueprint id.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintChart/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

{
  "edges": [
    [
      "string",
      "string"
    ]
  ],
  "nodes": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A blueprint chart based on the blueprint id. BlueprintChartRetrieveResponse
404 Not Found No blueprint data found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintDocs/

Retrieve blueprint tasks documentation.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintDocs/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

[
  {
    "description": "string",
    "links": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "parameters": [
      {
        "description": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "references": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "task": "string",
    "title": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK The task documentation for a blueprint. Inline
404 Not Found Model document missing. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BlueprintListDocumentsResponse] false none
» description string true The task description.
» links [BlueprintDocLinks] true A list of external documentation links.
»» name string true The name of the documentation at the link.
»» url string¦null true The URL at which external documentation can be found.
» parameters [BlueprintDocParameters] true An array of task parameters.
»» description string true A description of what the parameter does.
»» name string true The name of the parameter.
»» type string true The type (and default value) of the parameter.
» references [BlueprintDocReferences] true A list of reference links.
»» name string true The name of the reference.
»» url string¦null true The URL at which the reference can be found.
» task string true The task described in document.
» title string true The document title.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/json/

Retrieve a blueprint json by its ID.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/blueprints/{blueprintId}/json/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID.
blueprintId path string true The blueprint ID.

Example responses

200 Response

{
  "blueprint": "\n                {\n                    \"1\": [[\"NUM\"], [\"PNI2\"], \"T\"],\n                    \"2\": [[\"1\"], [\"LASSO2\"], \"P\"],\n                }\n            "
}

Responses

Status Meaning Description Schema
200 OK Blueprint json based on its blueprint ID. BlueprintJsonResponse
404 Not Found This resource does not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/blueprintChart/

Retrieve a reduced model blueprint chart by model id. The model blueprint charts are reduced from the full blueprint charts to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/blueprintChart/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "edges": [
    [
      "string",
      "string"
    ]
  ],
  "nodes": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A reduced model blueprint chart based on the model id. BlueprintChartRetrieveResponse
404 Not Found No model found for given projectId and modelId. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/blueprintDocs/

Retrieve task documentation for a reduced model blueprint. The model blueprint is reduced from the full blueprint to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/blueprintDocs/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

[
  {
    "description": "string",
    "links": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "parameters": [
      {
        "description": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "references": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "task": "string",
    "title": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK The task documentation for a reduced model blueprint. Inline
404 Not Found No model found for given projectId and modelId. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BlueprintListDocumentsResponse] false none
» description string true The task description.
» links [BlueprintDocLinks] true A list of external documentation links.
»» name string true The name of the documentation at the link.
»» url string¦null true The URL at which external documentation can be found.
» parameters [BlueprintDocParameters] true An array of task parameters.
»» description string true A description of what the parameter does.
»» name string true The name of the parameter.
»» type string true The type (and default value) of the parameter.
» references [BlueprintDocReferences] true A list of reference links.
»» name string true The name of the reference.
»» url string¦null true The URL at which the reference can be found.
» task string true The task described in document.
» title string true The document title.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

BlueprintChartRetrieveResponse

{
  "edges": [
    [
      "string",
      "string"
    ]
  ],
  "nodes": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
edges [array] true An array of chart edges - tuples of (start_id, end_id).
nodes [NodeDescription] true An array of node descriptions.

{
  "name": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
name string true The name of the documentation at the link.
url string¦null true The URL at which external documentation can be found.

BlueprintDocParameters

{
  "description": "string",
  "name": "string",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
description string true A description of what the parameter does.
name string true The name of the parameter.
type string true The type (and default value) of the parameter.

BlueprintDocReferences

{
  "name": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
name string true The name of the reference.
url string¦null true The URL at which the reference can be found.

BlueprintJsonResponse

{
  "blueprint": "\n                {\n                    \"1\": [[\"NUM\"], [\"PNI2\"], \"T\"],\n                    \"2\": [[\"1\"], [\"LASSO2\"], \"P\"],\n                }\n            "
}

Properties

Name Type Required Restrictions Description
blueprint object true JSON blueprint representation of the model.

BlueprintListDocumentsResponse

{
  "description": "string",
  "links": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "parameters": [
    {
      "description": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "references": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "task": "string",
  "title": "string"
}

Properties

Name Type Required Restrictions Description
description string true The task description.
links [BlueprintDocLinks] true A list of external documentation links.
parameters [BlueprintDocParameters] true An array of task parameters.
references [BlueprintDocReferences] true A list of reference links.
task string true The task described in document.
title string true The document title.

BlueprintResponse

{
  "blueprintCategory": "string",
  "id": "string",
  "isCustomModelBlueprint": true,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "processes": [
    "string"
  ],
  "projectId": "string",
  "recommendedFeaturelistId": "string",
  "supportsComposableMl": true,
  "supportsIncrementalLearning": true,
  "supportsMonotonicConstraints": true
}

Properties

Name Type Required Restrictions Description
blueprintCategory string true describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either "DataRobot" or "Scaleout DataRobot".
id string true the blueprint ID of this blueprint - note that this is not an ObjectId.
isCustomModelBlueprint boolean true Whether blueprint contains custom task.
modelType string true the model this blueprint will produce.
monotonicDecreasingFeaturelistId string¦null true the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.
monotonicIncreasingFeaturelistId string¦null true null or str, the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.
processes [string] true a list of strings representing processes the blueprint uses.
projectId string true the project the blueprint belongs to.
recommendedFeaturelistId string¦null false The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.
supportsComposableMl boolean true indicates whether this blueprint is supported in Composable ML.
supportsIncrementalLearning boolean true Whether blueprint supports incremental learning.
supportsMonotonicConstraints boolean true whether this model supports enforcing monotonic constraints.

NodeDescription

{
  "id": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
id string true The ID of the node.
label string true The label of the node.

更新しました February 28, 2024