DataRobot APIのリソース > APIリファレンスドキュメント > DataRobot REST API > Secure and Govern > Compliance Documentation

Compliance Documentation¶

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

GET /api/v2/automatedDocumentOptions/¶

Check which document types and locales are available for generation with your account.

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/automatedDocumentOptions/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Example responses¶

200 Response

{
  "data": [
    {
      "documentType": "AUTOPILOT_SUMMARY",
      "locale": "EN_US"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Available document types and locales retrieved.	AutomatedDocOptionsResponse

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

BearerAuth

GET /api/v2/automatedDocuments/¶

Get information about all previously generated documents available for your account. The information includes document ID and type, ID of the entity it was generated for, time of creation, and other information.

Example request to get a list of all documents:

.. code-block:: text

GET https://app.datarobot.com/api/v2/automatedDocuments/ HTTP/1.1
Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4

Query for specific documents. For example, request a list of documents generated for a specific model in docx and html formats:

.. code-block:: text

GET https://app.datarobot.com/api/v2/automatedDocuments?entityId=
5ec4ea7e41054c158c5b002f&outputFormat=docx&outputFormat=html HTTP/1.1
Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4

In response body, you will get a page with queried documents. This is an example response with one document returned:

.. code-block:: json

{
    "totalCount": 1,
    "count": 1,
    "previous": null,
    "next": null,
    "data": [
        {
            "id": "5ebdb5e911a5fb85edff2b3c",
            "documentType": "MODEL_COMPLIANCE",
            "entityId": "5ebbb5e7d9d7b96e3d48e3b5",
            "templateId": "5bd812e5f750edd392fa880f",
            "locale": "EN_US",
            "outputFormat": "DOCX",
            "createdAt": "2019-11-07T11:12:13.141516Z"
        }
    ]
}

If there are no matching documents, you will get a page with an empty data array.

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/automatedDocuments/?offset=0&limit=100 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	Number of items to skip. Defaults to 0 if not provided.
limit	query	integer	true	Number of items to return, defaults to 100 if not provided.
documentType	query	any	false	Query for one or more document types.
outputFormat	query	any	false	Query for one or more output formats.
locale	query	any	false	Query generated documents by one or more locales.
entityId	query	any	false	Query generated documents by one or more entity IDs. For Model Compliance docs, the entity ID is a model ID. For Autopilot Summary reports, query by project IDs.

Example responses¶

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "docTypeSpecificInfo": {
        "endDate": "2019-08-24T14:15:22Z",
        "modelName": "string",
        "startDate": "2019-08-24T14:15:22Z"
      },
      "documentType": "AUTOPILOT_SUMMARY",
      "entityId": "string",
      "id": "string",
      "locale": "EN_US",
      "outputFormat": "docx",
      "templateId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of found documents retrieved.	AutomatedDocListResponse

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

BearerAuth

POST /api/v2/automatedDocuments/¶

Request generation of an automated document that's available for your account. Below is an example request body to generate Model Compliance documentation:

.. sourcecode:: json

{
    "documentType": "MODEL_COMPLIANCE",
    "entityId": "507f191e810c19729de860ea",
    "outputFormat": "docx"
}

For Autopilot Summary, set a corresponding document type, AUTOPILOT_SUMMARY, and assign a needed project ID to the entityId value.

After the request is sent, the jobs needed for document generation are queued. You can see the status of the generation by polling the URL in the Location headers. After the generation is complete, the status URL will automatically redirect you to the resource location to download the document.

Code samples¶

curl -X POST https://app.datarobot.com/api/v2/automatedDocuments/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{AutomatedDocCreate}'

Body parameter¶

{
  "documentType": "AUTOPILOT_SUMMARY",
  "documentTypeSpecificParameters": {
    "bucketSize": "string",
    "end": "2019-08-24T14:15:22Z",
    "modelId": "string",
    "start": "2019-08-24T14:15:22Z"
  },
  "entityId": "string",
  "locale": "EN_US",
  "outputFormat": "docx",
  "templateId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	AutomatedDocCreate	false	none

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Document generation request accepted.	None
422	Unprocessable Entity	Unable to process document generation request.	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		URL to poll document generation status: GET /api/v2/status/{statusId}/

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

BearerAuth

DELETE /api/v2/automatedDocuments/{documentId}/¶

Delete a document using its ID. Example request:

.. code-block:: text

        DELETE https://app.datarobot.com/api/v2/automatedDocuments/5ec4ea7e41054c158c5b002f/ HTTP/1.1
        Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/automatedDocuments/{documentId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	Unique identifier of the generated document.

Responses¶

Status	Meaning	Description	Schema
204	No Content	Document successfully deleted.	None
404	Not Found	Provided document ID not found.	None

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

BearerAuth

GET /api/v2/automatedDocuments/{documentId}/¶

Download a generated Automated Documentation file.

.. code-block:: text

GET https://app.datarobot.com/api/v2/automatedDocuments/5ec4ea7e41054c158c5b002f/ HTTP/1.1
Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4

In response, you will get a file containing the generated documentation.

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/automatedDocuments/{documentId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	Unique identifier of the generated document.

Responses¶

Status	Meaning	Description	Schema
200	OK	Download request succeeded.	None
404	Not Found	Documentation record not found.	None

Response Headers¶

Status	Header	Type	Format	Description
200	Content-Disposition	string		Autogenerated filename ("attachment;filename=report_name.outputFormat").
200	Content-Type	string		MIME type corresponding to document file format

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

BearerAuth

GET /api/v2/complianceDocTemplates/¶

List user's custom-built compliance documentation templates.

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/complianceDocTemplates/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Number of results to skip.
limit	query	integer	false	At most this many results are returned. The default may change without notice.
namePart	query	string	false	When present, only return templates with names that contain the given substring.
orderBy	query	string	false	Sort order to apply to the dataset list. Prefix the attribute name with a dash to sort in descending order (e.g., orderBy='-id').
labels	query	string	false	Name of labels to filter by.
projectType	query	string	false	Type of project templates to search for. If not specified, returns all project templates types.

Enumerated Values¶

Parameter	Value
orderBy	[`id`, `-id`]
projectType	[`autoMl`, `textGeneration`, `timeSeries`]

Example responses¶

200 Response

{
  "count": 0,
  "data": [
    {
      "creatorId": "string",
      "creatorUsername": "string",
      "dateModified": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "instructions": "string",
      "labels": [
        "string"
      ],
      "name": "string",
      "orgId": "string",
      "permissions": {
        "CAN_DELETE_TEMPLATE": true,
        "CAN_EDIT_TEMPLATE": true,
        "CAN_SHARE": true,
        "CAN_USE_TEMPLATE": true,
        "CAN_VIEW": true
      },
      "projectType": "autoMl",
      "sections": [
        {
          "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
          "description": "string",
          "instructions": {
            "owner": "string",
            "user": "string"
          },
          "locked": true,
          "sections": [
            {}
          ],
          "title": "string",
          "type": "datarobot"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Successfully returned list of templates	ComplianceDocTemplateListResponse

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

BearerAuth

POST /api/v2/complianceDocTemplates/¶

Create a new compliance documentation template. One can retrieve the default DataRobot template via GET /api/v2/complianceDocTemplates/default/ endpoint.

Code samples¶

curl -X POST https://app.datarobot.com/api/v2/complianceDocTemplates/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{ComplianceDocTemplateCreate}'

Body parameter¶

{
  "labels": [
    "string"
  ],
  "name": "string",
  "projectType": "autoMl",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ComplianceDocTemplateCreate	false	none

Example responses¶

201 Response

{
  "dateModified": "2019-08-24T14:15:22Z",
  "id": "string"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Model compliance documentation template created successfully	ComplianceDocTemplateCreateResponse
422	Unprocessable Entity	Template cannot be created, e.g., invalid sections or name already exists	None

Response Headers¶

Status	Header	Type	Format	Description
201	Location	string	url	URL location of the newly created template.

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

BearerAuth

GET /api/v2/complianceDocTemplates/default/¶

Retrieve the default documentation template.

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/complianceDocTemplates/default/?type=normal \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
type	query	string	true	Specifies the type of the default template to retrieve. The `normal` template is applicable for all AutoML projects that are not time series. The `timeSeries` template is only applicable to time series projects.The `textGeneration` template is only applicable to text generation registry models.

Enumerated Values¶

Parameter	Value
type	[`normal`, `textGeneration`, `timeSeries`]

Example responses¶

200 Response

{
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Successfully retrieved default template	ComplianceDocTemplateDefaultRetrieveResponse

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

BearerAuth

DELETE /api/v2/complianceDocTemplates/{templateId}/¶

Delete a compliance documentation template. Documentation previously generated using this template will remain unchanged.

Code samples¶

curl -X DELETE https://app.datarobot.com/api/v2/complianceDocTemplates/{templateId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The Id of a model compliance document template accessible by the user

Responses¶

Status	Meaning	Description	Schema
204	No Content	Template deleted successfully	None
403	Forbidden	Insufficient permissions to delete template	None
404	Not Found	Template not found	None

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

BearerAuth

GET /api/v2/complianceDocTemplates/{templateId}/¶

Retrieve a JSON representation of a custom Compliance Documentation template.

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/complianceDocTemplates/{templateId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The Id of a model compliance document template accessible by the user

Example responses¶

200 Response

{
  "creatorId": "string",
  "creatorUsername": "string",
  "dateModified": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "instructions": "string",
  "labels": [
    "string"
  ],
  "name": "string",
  "orgId": "string",
  "permissions": {
    "CAN_DELETE_TEMPLATE": true,
    "CAN_EDIT_TEMPLATE": true,
    "CAN_SHARE": true,
    "CAN_USE_TEMPLATE": true,
    "CAN_VIEW": true
  },
  "projectType": "autoMl",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Successfully retrieved template	TemplateResponse
404	Not Found	No matching template owned by this user was found	None

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

BearerAuth

PATCH /api/v2/complianceDocTemplates/{templateId}/¶

Update an existing model compliance documentation template with the given templateId. The template must be accessible by the user. If the templateId is not found for the user, the update cannot be performed. For a description of the template sections object options, see the sample sections on the schema below.

Code samples¶

curl -X PATCH https://app.datarobot.com/api/v2/complianceDocTemplates/{templateId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶

{
  "description": "string",
  "labels": [
    "string"
  ],
  "name": "string",
  "projectType": "autoMl",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The Id of a model compliance document template accessible by the user
body	body	ComplianceDocTemplateUpdate	false	none

Responses¶

Status	Meaning	Description	Schema
204	No Content	Model compliance documentation template updated successfully	None
403	Forbidden	Not enough permissions to edit template	None
404	Not Found	Template not found	None

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

BearerAuth

GET /api/v2/complianceDocTemplates/{templateId}/sharedRoles/¶

Get a list of users, groups and organizations who have access to this template and their roles on the template.

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/complianceDocTemplates/{templateId}/sharedRoles/?offset=0&limit=10 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
id	query	string	false	Only return roles for a user, group or organization with this identifier.
offset	query	integer	true	This many results will be skipped
limit	query	integer	true	At most this many results are returned
name	query	string	false	Only return roles for a user, group or organization with this name.
shareRecipientType	query	string	false	List access controls for recipients with this type.
templateId	path	string	true	The template identifier

Enumerated Values¶

Parameter	Value
shareRecipientType	[`user`, `group`, `organization`]

Example responses¶

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	The template's access control list.	SharingListV2Response
404	Not Found	Either the template does not exist or the user does not have permissions to view the template.	None
422	Unprocessable Entity	Both username and userId were specified	None

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

BearerAuth

PATCH /api/v2/complianceDocTemplates/{templateId}/sharedRoles/¶

Set roles for users on this template.

Code samples¶

curl -X PATCH https://app.datarobot.com/api/v2/complianceDocTemplates/{templateId}/sharedRoles/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶

{
  "operation": "updateRoles",
  "roles": [
    {
      "role": "string",
      "shareRecipientType": "user",
      "username": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
templateId	path	string	true	The template identifier
body	body	SharedRolesUpdate	false	none

Responses¶

Status	Meaning	Description	Schema
204	No Content	Roles updated successfully.	None
409	Conflict	The request would leave the template without an owner.	None
422	Unprocessable Entity	One of the users in the request does not exist, or the request is otherwise invalid	None

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

BearerAuth

GET /api/v2/modelComplianceDocsInitializations/{entityId}/¶

Check if compliance documentation pre-processing is initialized for the current model. This is only required for custom models.

Code samples¶

curl -X GET https://app.datarobot.com/api/v2/modelComplianceDocsInitializations/{entityId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
entityId	path	string	true	The ID of the model or model package the document corresponds to.

Example responses¶

200 Response

{
  "initialized": true,
  "status": "initialized"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Retrieve information about the status of the compliance documentation pre-preprocessing initialization.	ModelComplianceDocsInitializationsResponse
404	Not Found	Model not found.	None

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

BearerAuth

POST /api/v2/modelComplianceDocsInitializations/{entityId}/¶

Initialize compliance documentation pre-processing for the current model. This route must be called before generating documentation for a custom model.

Code samples¶

curl -X POST https://app.datarobot.com/api/v2/modelComplianceDocsInitializations/{entityId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶

{}

Parameters

Name	In	Type	Required	Description
entityId	path	string	true	The ID of the model or model package the document corresponds to.
body	body	Empty	false	none

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Job to initialize compliance documentation pre-processing successfully started.	None
404	Not Found	Model not found.	None
422	Unprocessable Entity	Cannot prepare model for compliance document generation.	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		URL to poll for getting a status of the job: GET /api/v2/status/{statusId}/

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

BearerAuth

Schemas¶

AccessControlV2

{
  "id": "string",
  "name": "string",
  "role": "ADMIN",
  "shareRecipientType": "user"
}

Properties¶

Name	Type	Required	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`]

AutomatedDocCreate

{
  "documentType": "AUTOPILOT_SUMMARY",
  "documentTypeSpecificParameters": {
    "bucketSize": "string",
    "end": "2019-08-24T14:15:22Z",
    "modelId": "string",
    "start": "2019-08-24T14:15:22Z"
  },
  "entityId": "string",
  "locale": "EN_US",
  "outputFormat": "docx",
  "templateId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
documentType	string	true		Type of the automated document you want to generate.
documentTypeSpecificParameters	any	false		Set parameters unique for a specific document type. Currently, only these document types can have document-specific parameters: ['DEPLOYMENT_REPORT']

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	AutomatedDocCreateDeploymentReport	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	AutomatedDocCreateModelComplianceDocs	false		none

continued

Name	Type	Required	Description
entityId	string	true	ID of the entity to generate the document for. It can be a model ID, a project ID.
locale	string	false	Localization of the document. Defaults to EN_US.
outputFormat	string	true	Format to generate the document in.
templateId	string	false	Template ID to use for the document outline. Defaults to standard Datarobot template.

Enumerated Values¶

Property	Value
documentType	[`AUTOPILOT_SUMMARY`, `MODEL_COMPLIANCE`, `DEPLOYMENT_REPORT`, `MODEL_COMPLIANCE_GEN_AI`]
locale	[`EN_US`, `JA_JP`]
outputFormat	[`docx`, `html`]

AutomatedDocCreateDeploymentReport

{
  "bucketSize": "string",
  "end": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "start": "2019-08-24T14:15:22Z"
}

Properties¶

Name	Type	Required	Description
bucketSize	string(duration)	false	You can regulate the size of the buckets in charts. One bucket reflects some duration period and you can set the exact duration with this parameter. Bucket size gets defaulted to either a month, a week, or a day, based on the time range of the report. We use `ISO 8601 <https://www.digi.com/resources/documentation/digidocs/90001437-13/reference/r_iso_8601_duration_format.htm>`_ duration format to specify values.
end	string(date-time)¦null	false	End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.
modelId	string	false	Provide a model ID to generate a report for a previously deployed model.
start	string(date-time)¦null	false	Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.

AutomatedDocCreateModelComplianceDocs

{}

Properties¶

None

AutomatedDocItem

{
  "createdAt": "2019-08-24T14:15:22Z",
  "docTypeSpecificInfo": {
    "endDate": "2019-08-24T14:15:22Z",
    "modelName": "string",
    "startDate": "2019-08-24T14:15:22Z"
  },
  "documentType": "AUTOPILOT_SUMMARY",
  "entityId": "string",
  "id": "string",
  "locale": "EN_US",
  "outputFormat": "docx",
  "templateId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
createdAt	string(date-time)	true		Timestamp for the document creation time.
docTypeSpecificInfo	any	false		Information that is specific for a certain document type.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	DocTypeSpecificInfoDeploymentReport	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	DocTypeSpecificInfoModelCompliance	false		none

continued

Name	Type	Required	Description
documentType	string	true	Type of the generated document.
entityId	string	true	Unique identifier of the entity the document was generated for.
id	string	true	Unique identifier of the generated document.
locale	string	false	Locale of the generated document.
outputFormat	string	true	File format of the generated document.
templateId	string	true	Unique identifier of the template used for the document outline.

Enumerated Values¶

Property	Value
documentType	[`AUTOPILOT_SUMMARY`, `MODEL_COMPLIANCE`, `DEPLOYMENT_REPORT`, `MODEL_COMPLIANCE_GEN_AI`]
locale	[`EN_US`, `JA_JP`]
outputFormat	[`docx`, `html`]

AutomatedDocListResponse

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "docTypeSpecificInfo": {
        "endDate": "2019-08-24T14:15:22Z",
        "modelName": "string",
        "startDate": "2019-08-24T14:15:22Z"
      },
      "documentType": "AUTOPILOT_SUMMARY",
      "entityId": "string",
      "id": "string",
      "locale": "EN_US",
      "outputFormat": "docx",
      "templateId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[AutomatedDocItem]	true	List of generated documents.
next	string(uri)¦null	true	URL pointing to the next page (if null, there is no next page).
previous	string(uri)¦null	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

AutomatedDocOptions

{
  "documentType": "AUTOPILOT_SUMMARY",
  "locale": "EN_US"
}

Properties¶

Name	Type	Required	Restrictions	Description
documentType	string	true		Type of document available for generation.
locale	string	true		Locale available for the document generation.

Enumerated Values¶

Property	Value
documentType	[`AUTOPILOT_SUMMARY`, `MODEL_COMPLIANCE`, `DEPLOYMENT_REPORT`, `MODEL_COMPLIANCE_GEN_AI`]
locale	[`EN_US`, `JA_JP`]

AutomatedDocOptionsResponse

{
  "data": [
    {
      "documentType": "AUTOPILOT_SUMMARY",
      "locale": "EN_US"
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
data	[AutomatedDocOptions]	true		List of document types available for generation.

ComplianceDocTemplateCreate

{
  "labels": [
    "string"
  ],
  "name": "string",
  "projectType": "autoMl",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Properties¶

Name	Type	Required	Description
labels	[string]	false	Names of the labels to assign to the template.
name	string	true	Name of the new template. Must be unique among templates created by the user.
projectType	string	false	Type of project template.
sections	[oneOf]	true	List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, i.e., the structure is recursive. The number of nested sections allowed is 5. The total number of sections allowed is 500.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	SectionDataRobot	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionUser	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionCustom	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionTableOfContents	false		none

Enumerated Values¶

Property	Value
projectType	[`autoMl`, `textGeneration`, `timeSeries`]

ComplianceDocTemplateCreateResponse

{
  "dateModified": "2019-08-24T14:15:22Z",
  "id": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
dateModified	string(date-time)	true		Timestamp of the created template
id	string	true		Created template Id

ComplianceDocTemplateDefaultRetrieveResponse

{
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
sections	[oneOf]	true		List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, i.e., the structure is recursive. The number of nested sections allowed is 5. The total number of sections allowed is 500.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	SectionDataRobot	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionUser	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionCustom	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionTableOfContents	false		none

ComplianceDocTemplateListResponse

{
  "count": 0,
  "data": [
    {
      "creatorId": "string",
      "creatorUsername": "string",
      "dateModified": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "instructions": "string",
      "labels": [
        "string"
      ],
      "name": "string",
      "orgId": "string",
      "permissions": {
        "CAN_DELETE_TEMPLATE": true,
        "CAN_EDIT_TEMPLATE": true,
        "CAN_SHARE": true,
        "CAN_USE_TEMPLATE": true,
        "CAN_VIEW": true
      },
      "projectType": "autoMl",
      "sections": [
        {
          "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
          "description": "string",
          "instructions": {
            "owner": "string",
            "user": "string"
          },
          "locked": true,
          "sections": [
            {}
          ],
          "title": "string",
          "type": "datarobot"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	true	Number of items returned on this page.
data	[TemplateResponse]	true	List of templates.
next	string(uri)¦null	true	URL pointing to the previous page. If null, there is no next page.
previous	string(uri)¦null	true	URL pointing to the previous page. If null, there is no previous page.
totalCount	integer	true	Total number of templates.

ComplianceDocTemplateUpdate

{
  "description": "string",
  "labels": [
    "string"
  ],
  "name": "string",
  "projectType": "autoMl",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Properties¶

Name	Type	Required	Description
description	string	false	New description for the template.
labels	[string]	false	Names of the labels to assign to the template.
name	string	false	New name for the template. Must be unique among templates created by the user.
projectType	string	false	Type of project template.
sections	[oneOf]	false	List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, i.e., the structure is recursive. The number of nested sections allowed is 5. The total number of sections allowed is 500.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	SectionDataRobot	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionUser	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionCustom	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionTableOfContents	false		none

Enumerated Values¶

Property	Value
projectType	[`autoMl`, `textGeneration`, `timeSeries`]

DocTypeSpecificInfoDeploymentReport

{
  "endDate": "2019-08-24T14:15:22Z",
  "modelName": "string",
  "startDate": "2019-08-24T14:15:22Z"
}

Properties¶

Name	Type	Required	Description
endDate	string(date-time)	true	End date of selected data in the document.
modelName	string	false	Name of the deployed model.
startDate	string(date-time)	true	Start date of selected data in the document.

DocTypeSpecificInfoModelCompliance

{}

Properties¶

None

Empty

{}

Properties¶

None

GrantAccessControlWithId

{
  "id": "string",
  "role": "string",
  "shareRecipientType": "user"
}

Properties¶

Name	Type	Required	Description
id	string	true	The ID of the recipient.
role	string	true	The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType	string	true	Describes the recipient type, either user, group, or organization.

Enumerated Values¶

Property	Value
shareRecipientType	[`user`, `group`, `organization`]

GrantAccessControlWithUsername

{
  "role": "string",
  "shareRecipientType": "user",
  "username": "string"
}

Properties¶

Name	Type	Required	Description
role	string	true	The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType	string	true	Describes the recipient type, either user, group, or organization.
username	string	true	Username of the user to update the access role for.

Enumerated Values¶

Property	Value
shareRecipientType	[`user`, `group`, `organization`]

InstructionsField

{
  "owner": "string",
  "user": "string"
}

Section instructions

Properties¶

Name	Type	Required	Restrictions	Description
owner	string	true		Instructions owner
user	string	true		Instructions user

ModelComplianceDocsInitializationsResponse

{
  "initialized": true,
  "status": "initialized"
}

Properties¶

Name	Type	Required	Restrictions	Description
initialized	boolean	true		Whether compliance documentation pre-preprocessing is initialized for the model
status	string	true		Compliance documentation pre-processing initialization status

Enumerated Values¶

Property	Value
status	[`initialized`, `initializationInProgress`, `notRequested`, `noTrainingData`, `trainingDataAssignmentInProgress`, `initializationError`]

SampleSection

{}

Properties¶

None

SectionCustom

{
  "description": "string",
  "highlightedText": "string",
  "instructions": {
    "owner": "string",
    "user": "string"
  },
  "locked": true,
  "regularText": "string",
  "sections": [
    {}
  ],
  "title": "string",
  "type": "custom"
}

Properties¶

Name	Type	Required	Restrictions	Description
description	string¦null	false		Section description
highlightedText	string	true	maxLength: 5000	Highlighted text of the section, optionally separated by `\n` to split paragraphs.
instructions	InstructionsField	false		Section instructions
locked	boolean	false		Locked section flag
regularText	string	true	maxLength: 5000	Regular text of the section, optionally separated by `\n` to split paragraphs.
sections	[SampleSection]¦null	false		List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, e.g. the structure is recursive. The limit of nesting sections is 5. Total number of sections is limited to 500.
title	string	true	maxLength: 500	Section Title
type	string	true		Section with user-defined content. It can be a section title or summary.

Enumerated Values¶

Property	Value
type	`custom`

SectionDataRobot

{
  "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
  "description": "string",
  "instructions": {
    "owner": "string",
    "user": "string"
  },
  "locked": true,
  "sections": [
    {}
  ],
  "title": "string",
  "type": "datarobot"
}

Properties¶

Name	Type	Required	Restrictions	Description
contentId	string	true		The identifier of the content in the section. This attribute identifies what is going to be rendered in the section.
description	string¦null	false		Section description
instructions	InstructionsField	false		Section instructions
locked	boolean	false		Locked section flag
sections	[SampleSection]¦null	false		List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, e.g. the structure is recursive. The limit of nesting sections is 5. Total number of sections is limited to 500.
title	string	true	maxLength: 500	Section Title
type	string	true		Section owned by DataRobot. The content of this section type is controlled by DataRobot (see `contentId` attribute). Users can add sub-sections to it.

Enumerated Values¶

Property Value

contentId [MODEL_DESCRIPTION_AND_OVERVIEW, MODEL_DESCRIPTION_AND_OVERVIEW_EXTERNAL_PREDICTION, OVERVIEW_OF_MODEL_RESULTS, MODEL_DEVELOPMENT_OVERVIEW_SUB, TS_MODEL_DEVELOPMENT_OVERVIEW_SUB, AD_MODEL_DEVELOPMENT_OVERVIEW_SUB, MODEL_DEVELOPMENT_OVERVIEW_SUB_EXTERNAL_PREDICTION, MODEL_METHODOLOGY, MODEL_METHODOLOGY_EXTERNAL_PREDICTION, LITERATURE_REVIEW_AND_REFERENCES, ALTERNATIVE_MODEL_FRAMEWORKS_AND_THEORIES_CONSIDERED, PERSONALLY_IDENTIFIABLE_INFORMATION, DATA_PARTITIONING_METHODOLOGY, AD_DATA_PARTITIONING_METHODOLOGY, TS_DATA_PARTITIONING_METHODOLOGY, QUANTITATIVE_ANALYSIS, FINAL_MODEL_VARIABLES, VALIDATION_STABILITY, MODEL_PERFORMANCE, ACCURACY_LIFT_CHART, MULTICLASS_ACCURACY_LIFT_CHART, SENSITIVITY_ANALYSIS, SENSITIVITY_ANALYSIS_NO_NULL_IMPUTATION, AD_SENSITIVITY_ANALYSIS, ACCURACY_OVER_TIME, ANOMALY_OVER_TIME, ACCURACY_ROC, MULTICLASS_CONFUSION, MODEL_VERSION_CONTROL, CUSTOM_INFERENCE_VERSION_CONTROL, FEATURE_ASSOCIATION_MATRIX, BIAS_AND_FAIRNESS, BIAS_AND_FAIRNESS_EXTERNAL_PREDICTION, HOW_TO_USE, PREFACE, TS_MODEL_PERFORMANCE, EXECUTIVE_SUMMARY_AND_MODEL_OVERVIEW, MODEL_DATA_OVERVIEW, MODEL_THEORETICAL_FRAMEWORK_AND_METHODOLOGY, MODEL_PERFORMANCE_AND_STABILITY, CUSTOM_INFERENCE_PERFORMANCE_AND_STABILITY, SENSITIVITY_TESTING_AND_ANALYSIS, MODEL_IMPLEMENTATION_AND_OUTPUT_REPORTING, MODEL_STAKEHOLDERS, MODEL_DEVELOPMENT_PURPOSE_AND_INTENDED_USE, MODEL_INTERDEPENDENCIES, DATA_SOURCE_OVERVIEW_AND_APPROPRIATENESS, INPUT_DATA_EXTRACTION_PREPARATION, DATA_ASSUMPTIONS, CUSTOM_INFERENCE_MODELING_FEATURES, MODEL_ASSUMPTIONS, VARIABLE_SELECTION, VARIABLE_SELECTION_EXTERNAL_PREDICTION, TS_VARIABLE_SELECTION, EXPERT_JUDGEMENT_AND_VAR_SELECTION, KEY_RELATIONSHIPS, AD_KEY_RELATIONSHIPS, LLM_SYSTEM_STAKEHOLDERS, LLM_DEVELOPMENT_PURPOSE_AND_INTENDED_USE, GEN_AI_LLM_SYSTEM_DESCRIPTION_AND_OVERVIEW, LLM_DATA_OVERVIEW, LLM_RAG_DATA, LLM_FINE_TUNING_DATA, LLM_OVERVIEW, LLM_MODEL_CARD, LLM_RISKS_AND_LIMITATIONS, LLM_INTERDEPENDENCIES, LLM_LITERATURE_REFERENCES, LLM_EVALUATION, LLM_COPYRIGHT_CONCERNS, LLM_REGISTRY_GOVERNANCE, LLM_REGISTRY_VERSION_CONTROL]

type datarobot

SectionTableOfContents

{
  "locked": true,
  "title": "string",
  "type": "table_of_contents"
}

Properties¶

Name	Type	Required	Restrictions	Description
locked	boolean	false		Locked section flag
title	string	true	maxLength: 500	Section Title
type	string	true		Table of contents. This section has no additional attributes.

Enumerated Values¶

Property	Value
type	`table_of_contents`

SectionUser

{
  "description": "string",
  "highlightedText": "string",
  "instructions": {
    "owner": "string",
    "user": "string"
  },
  "locked": true,
  "regularText": "string",
  "sections": [
    {}
  ],
  "title": "string",
  "type": "user"
}

Properties¶

Name	Type	Required	Restrictions	Description
description	string¦null	false		Section description
highlightedText	string	true	maxLength: 5000	Highlighted text of the section, optionally separated by `\n` to split paragraphs.
instructions	InstructionsField	false		Section instructions
locked	boolean	false		Locked section flag
regularText	string	true	maxLength: 5000	Regular text of the section, optionally separated by `\n` to split paragraphs.
sections	[SampleSection]¦null	false		List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, e.g. the structure is recursive. The limit of nesting sections is 5. Total number of sections is limited to 500.
title	string	true	maxLength: 500	Section Title
type	string	true		Section with user-defined content. Those sections may contain text generated by the user.

Enumerated Values¶

Property	Value
type	`user`

SharedRolesUpdate

{
  "operation": "updateRoles",
  "roles": [
    {
      "role": "string",
      "shareRecipientType": "user",
      "username": "string"
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
operation	string	true		Name of the action being taken. The only operation is 'updateRoles'.
roles	[oneOf]	true	maxItems: 100 minItems: 1	Array of GrantAccessControl objects., up to maximum 100 objects.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	GrantAccessControlWithUsername	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	GrantAccessControlWithId	false		none

Enumerated Values¶

Property	Value
operation	`updateRoles`

SharingListV2Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

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.

TemplatePermissionsResponse

{
  "CAN_DELETE_TEMPLATE": true,
  "CAN_EDIT_TEMPLATE": true,
  "CAN_SHARE": true,
  "CAN_USE_TEMPLATE": true,
  "CAN_VIEW": true
}

The level of permissions for the user viewing this template.

Properties¶

Name	Type	Required	Description
CAN_DELETE_TEMPLATE	boolean	true	Whether the current user can delete this template
CAN_EDIT_TEMPLATE	boolean	true	Whether the current user can edit this template
CAN_SHARE	boolean	true	Whether the current user can share this template
CAN_USE_TEMPLATE	boolean	true	Whether the current user can generate documents with this template
CAN_VIEW	boolean	true	Whether the current user can view this template

TemplateResponse

{
  "creatorId": "string",
  "creatorUsername": "string",
  "dateModified": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "instructions": "string",
  "labels": [
    "string"
  ],
  "name": "string",
  "orgId": "string",
  "permissions": {
    "CAN_DELETE_TEMPLATE": true,
    "CAN_EDIT_TEMPLATE": true,
    "CAN_SHARE": true,
    "CAN_USE_TEMPLATE": true,
    "CAN_VIEW": true
  },
  "projectType": "autoMl",
  "sections": [
    {
      "contentId": "MODEL_DESCRIPTION_AND_OVERVIEW",
      "description": "string",
      "instructions": {
        "owner": "string",
        "user": "string"
      },
      "locked": true,
      "sections": [
        {}
      ],
      "title": "string",
      "type": "datarobot"
    }
  ]
}

Properties¶

Name	Type	Required	Description
creatorId	string	true	The ID of the user who created the template
creatorUsername	string	true	The username of the user who created the template
dateModified	string(date-time)¦null	true	Last date/time of template modification.
description	string¦null	true	An overview of the template
id	string	true	The ID of the template accessible by the user
instructions	string¦null	true	Currently always returns `null`. Maintained as a placeholder for future functionality.
labels	[string]¦null	true	User-added filtering labels for the template
name	string	true	The name of the template
orgId	string	true	The ID of the organization the user who created the template belongs to
permissions	TemplatePermissionsResponse	true	The level of permissions for the user viewing this template.
projectType	string¦null	true	Type of project template.
sections	[oneOf]	true	List of section objects representing the structure of the document. Each section can have sub-sections that have the same schema as the parent section, i.e., the structure is recursive. The number of nested sections allowed is 5. The total number of sections allowed is 500.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	SectionDataRobot	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionUser	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionCustom	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	SectionTableOfContents	false		none

Enumerated Values¶

Property	Value
projectType	[`autoMl`, `textGeneration`, `timeSeries`]

更新しました February 7, 2025

このページは役に立ちましたか？

ありがとうございます。どのような点が役に立ちましたか？

より良いコンテンツを提供するには、どうすればよいでしょうか？

アンケートにご協力いただき、ありがとうございました。