Actuals configuration
Use the endpoints described below to manage deployment configuration. Configure capabilities of your current deployment based on the data provided, for example, training data, prediction data, or actuals. After you create and configure a deployment, you can use the deployment settings to add or update deployment functionality that wasn't configured during deployment creation.
POST /api/v2/deployments/{deploymentId}/actuals/fromDataset/
Submit actuals values for processing using catalog item. Submission of actuals is limited to 10,000,000 actuals per hour. For time series deployments, total actuals = number of actuals * number of forecast distances. For example, submitting 10 actuals for a deployment with 50 forecast distances = 500 total actuals. For multiclass deployments, a similar calculation is made where total actuals = number of actuals * number of classes. For example, submitting 10 actuals for a deployment with 20 classes = 200 actuals.
Body parameter
{
"properties": {
"actualValueColumn": {
"description": "Column name that contains actual values.",
"type": "string"
},
"associationIdColumn": {
"description": "Column name that contains unique identifiers used with a predicted rows.",
"type": "string"
},
"datasetId": {
"description": "The ID of dataset from catalog.",
"type": "string"
},
"datasetVersionId": {
"description": "Version of dataset to retrieve.",
"type": [
"string",
"null"
]
},
"keepActualsWithoutPredictions": {
"default": true,
"description": "Indicates if actual without predictions are kept.",
"type": "boolean"
},
"password": {
"description": "The password for database authentication.",
"type": "string"
},
"timestampColumn": {
"description": "Column name that contain datetime when actual values were obtained.",
"type": "string",
"x-versiondeprecated": "v2.32"
},
"user": {
"description": "The username for database authentication.",
"type": "string"
},
"wasActedOnColumn": {
"description": "Column name that contains boolean values if any action was made based on predictions data.",
"type": "string",
"x-versiondeprecated": "v2.32"
}
},
"required": [
"actualValueColumn",
"associationIdColumn",
"datasetId"
],
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
| body |
body |
DeploymentDatasetCreate |
false |
none |
Responses
| Status |
Meaning |
Description |
Schema |
| 202 |
Accepted |
Submitted successfully. See Location header. |
None |
| 422 |
Unprocessable Entity |
Unable to process the Actuals submission request. |
None |
| 429 |
Too Many Requests |
The number of actuals uploaded this hour exceeds the limit of 10000000 rows. |
None |
| Status |
Header |
Type |
Format |
Description |
| 202 |
Location |
string |
|
URL for tracking async job status. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/actuals/fromJSON/
Submit actuals values for processing. Values are not processed immediately and may take some time to propagate through deployment systems. Submission of actuals is limited to 10,000,000 actuals per hour. For time series deployments, total actuals = number of actuals * number of forecast distances. For example, submitting 10 actuals for a deployment with 50 forecast distances = 500 total actuals. For multiclass deployments, a similar calculation is made where total actuals = number of actuals * number of classes. For example, submitting 10 actuals for a deployment with 20 classes = 200 actuals.
Body parameter
{
"properties": {
"data": {
"description": "A list of `actual` objects that describes actual values. Minimum size of the list is 1 and maximum size is 10000 items. An `actual` object has the following schema.",
"items": {
"properties": {
"actualValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
],
"description": "The actual value of a prediction. Will be numeric for regression models and a string label for classification models."
},
"associationId": {
"description": "A unique identifier used with a predicted row.",
"maxLength": 128,
"type": "string"
},
"timestamp": {
"description": "The datetime when actual values were obtained, formatted according to RFC3339.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versiondeprecated": "v2.32"
},
"wasActedOn": {
"description": "Indicates if the prediction was acted on in a way that could have affected the actual outcome. For example, if a hospital patient is predicted to be readmitted in 30 days, extra procedures or new medication might be given to mitigate this problem, influencing the actual outcome of the prediction.",
"type": [
"boolean",
"null"
],
"x-versiondeprecated": "v2.32"
}
},
"required": [
"actualValue",
"associationId"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"keepActualsWithoutPredictions": {
"default": true,
"description": "Indicates if actual without predictions are kept.",
"type": "boolean"
}
},
"required": [
"data"
],
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
| body |
body |
DeploymentActuals |
false |
none |
Responses
| Status |
Meaning |
Description |
Schema |
| 202 |
Accepted |
Submitted successfully. See Location header. |
None |
| 422 |
Unprocessable Entity |
Unable to process the Actuals submission request. |
None |
| 429 |
Too Many Requests |
The number of actuals uploaded this hour exceeds the limit of 10000000 rows. |
None |
| Status |
Header |
Type |
Format |
Description |
| 202 |
Location |
string |
|
URL for tracking async job status. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/monitoringDataDeletions/
Delete deployment monitoring data.
Body parameter
{
"properties": {
"end": {
"description": "End of the period to delete 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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"modelId": {
"description": "The id of the model for which monitoring data are being deleted.",
"type": "string"
},
"start": {
"description": "Start of the period to delete 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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"modelId"
],
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
| body |
body |
MonitoringDataDeletePayload |
false |
none |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
| 404 |
Not Found |
Deployment or model not found. |
None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/segmentAttributes/
Retrieve deployment segment attributes.
Parameters
| Name |
In |
Type |
Required |
Description |
| monitoringType |
query |
string |
false |
The monitoring type for which segment attributes are being retrieved. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| monitoringType |
[serviceHealth, dataDrift, accuracy, humility, customMetrics, geospatial] |
Example responses
200 Response
{
"properties": {
"data": {
"description": "The segment attributes that were retrieved.",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
},
"monitoringType": {
"description": "The monitoring type for which segment attributes are being retrieved.",
"enum": [
"serviceHealth",
"dataDrift",
"accuracy",
"humility",
"customMetrics",
"geospatial"
],
"type": "string"
}
},
"required": [
"data",
"monitoringType"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/segmentValues/
Retrieve deployment segment values.
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. |
| segmentAttribute |
query |
string |
false |
The name of the segment attribute whose values the user wants to retrieve. |
| search |
query |
string |
false |
The search query to filter the list of segment values. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of segment values.",
"items": {
"properties": {
"segmentAttribute": {
"description": "Name of the segment attribute.",
"type": "string"
},
"value": {
"description": "The segment value.",
"type": "string",
"x-versionadded": "v2.35"
}
},
"required": [
"segmentAttribute",
"value"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas
Actual
{
"properties": {
"actualValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
],
"description": "The actual value of a prediction. Will be numeric for regression models and a string label for classification models."
},
"associationId": {
"description": "A unique identifier used with a predicted row.",
"maxLength": 128,
"type": "string"
},
"timestamp": {
"description": "The datetime when actual values were obtained, formatted according to RFC3339.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versiondeprecated": "v2.32"
},
"wasActedOn": {
"description": "Indicates if the prediction was acted on in a way that could have affected the actual outcome. For example, if a hospital patient is predicted to be readmitted in 30 days, extra procedures or new medication might be given to mitigate this problem, influencing the actual outcome of the prediction.",
"type": [
"boolean",
"null"
],
"x-versiondeprecated": "v2.32"
}
},
"required": [
"actualValue",
"associationId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| actualValue |
any |
true |
|
The actual value of a prediction. Will be numeric for regression models and a string label for classification models. |
anyOf
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
integer |
false |
|
none |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
number |
false |
|
none |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
string |
false |
|
none |
continued
| Name |
Type |
Required |
Restrictions |
Description |
| associationId |
string |
true |
maxLength: 128
|
A unique identifier used with a predicted row. |
| timestamp |
string,null(date-time) |
false |
|
The datetime when actual values were obtained, formatted according to RFC3339. |
| wasActedOn |
boolean,null |
false |
|
Indicates if the prediction was acted on in a way that could have affected the actual outcome. For example, if a hospital patient is predicted to be readmitted in 30 days, extra procedures or new medication might be given to mitigate this problem, influencing the actual outcome of the prediction. |
DeploymentActuals
{
"properties": {
"data": {
"description": "A list of `actual` objects that describes actual values. Minimum size of the list is 1 and maximum size is 10000 items. An `actual` object has the following schema.",
"items": {
"properties": {
"actualValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
],
"description": "The actual value of a prediction. Will be numeric for regression models and a string label for classification models."
},
"associationId": {
"description": "A unique identifier used with a predicted row.",
"maxLength": 128,
"type": "string"
},
"timestamp": {
"description": "The datetime when actual values were obtained, formatted according to RFC3339.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versiondeprecated": "v2.32"
},
"wasActedOn": {
"description": "Indicates if the prediction was acted on in a way that could have affected the actual outcome. For example, if a hospital patient is predicted to be readmitted in 30 days, extra procedures or new medication might be given to mitigate this problem, influencing the actual outcome of the prediction.",
"type": [
"boolean",
"null"
],
"x-versiondeprecated": "v2.32"
}
},
"required": [
"actualValue",
"associationId"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"keepActualsWithoutPredictions": {
"default": true,
"description": "Indicates if actual without predictions are kept.",
"type": "boolean"
}
},
"required": [
"data"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| data |
[Actual] |
true |
minItems: 1
|
A list of actual objects that describes actual values. Minimum size of the list is 1 and maximum size is 10000 items. An actual object has the following schema. |
| keepActualsWithoutPredictions |
boolean |
false |
|
Indicates if actual without predictions are kept. |
DeploymentDatasetCreate
{
"properties": {
"actualValueColumn": {
"description": "Column name that contains actual values.",
"type": "string"
},
"associationIdColumn": {
"description": "Column name that contains unique identifiers used with a predicted rows.",
"type": "string"
},
"datasetId": {
"description": "The ID of dataset from catalog.",
"type": "string"
},
"datasetVersionId": {
"description": "Version of dataset to retrieve.",
"type": [
"string",
"null"
]
},
"keepActualsWithoutPredictions": {
"default": true,
"description": "Indicates if actual without predictions are kept.",
"type": "boolean"
},
"password": {
"description": "The password for database authentication.",
"type": "string"
},
"timestampColumn": {
"description": "Column name that contain datetime when actual values were obtained.",
"type": "string",
"x-versiondeprecated": "v2.32"
},
"user": {
"description": "The username for database authentication.",
"type": "string"
},
"wasActedOnColumn": {
"description": "Column name that contains boolean values if any action was made based on predictions data.",
"type": "string",
"x-versiondeprecated": "v2.32"
}
},
"required": [
"actualValueColumn",
"associationIdColumn",
"datasetId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| actualValueColumn |
string |
true |
|
Column name that contains actual values. |
| associationIdColumn |
string |
true |
|
Column name that contains unique identifiers used with a predicted rows. |
| datasetId |
string |
true |
|
The ID of dataset from catalog. |
| datasetVersionId |
string,null |
false |
|
Version of dataset to retrieve. |
| keepActualsWithoutPredictions |
boolean |
false |
|
Indicates if actual without predictions are kept. |
| password |
string |
false |
|
The password for database authentication. |
| timestampColumn |
string |
false |
|
Column name that contain datetime when actual values were obtained. |
| user |
string |
false |
|
The username for database authentication. |
| wasActedOnColumn |
string |
false |
|
Column name that contains boolean values if any action was made based on predictions data. |
MonitoringDataDeletePayload
{
"properties": {
"end": {
"description": "End of the period to delete 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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"modelId": {
"description": "The id of the model for which monitoring data are being deleted.",
"type": "string"
},
"start": {
"description": "Start of the period to delete 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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"modelId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| end |
string,null(date-time) |
false |
|
End of the period to delete 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 |
true |
|
The id of the model for which monitoring data are being deleted. |
| start |
string,null(date-time) |
false |
|
Start of the period to delete 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. |
SegmentAttributesRetrieveResponse
{
"properties": {
"data": {
"description": "The segment attributes that were retrieved.",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
},
"monitoringType": {
"description": "The monitoring type for which segment attributes are being retrieved.",
"enum": [
"serviceHealth",
"dataDrift",
"accuracy",
"humility",
"customMetrics",
"geospatial"
],
"type": "string"
}
},
"required": [
"data",
"monitoringType"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| data |
[string] |
true |
maxItems: 100
minItems: 1
|
The segment attributes that were retrieved. |
| monitoringType |
string |
true |
|
The monitoring type for which segment attributes are being retrieved. |
Enumerated Values
| Property |
Value |
| monitoringType |
[serviceHealth, dataDrift, accuracy, humility, customMetrics, geospatial] |
SegmentValue
{
"properties": {
"segmentAttribute": {
"description": "Name of the segment attribute.",
"type": "string"
},
"value": {
"description": "The segment value.",
"type": "string",
"x-versionadded": "v2.35"
}
},
"required": [
"segmentAttribute",
"value"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| segmentAttribute |
string |
true |
|
Name of the segment attribute. |
| value |
string |
true |
|
The segment value. |
SegmentValuesRetrieveResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of segment values.",
"items": {
"properties": {
"segmentAttribute": {
"description": "Name of the segment attribute.",
"type": "string"
},
"value": {
"description": "The segment value.",
"type": "string",
"x-versionadded": "v2.35"
}
},
"required": [
"segmentAttribute",
"value"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
Number of items returned on this page. |
| data |
[SegmentValue] |
true |
maxItems: 100
|
List of segment values. |
| next |
string,null(uri) |
true |
|
URL pointing to the next page (if null, there is no next page). |
| previous |
string,null(uri) |
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. |