Data drift
Use the endpoints described below to manage drift. When deploying a model, there is a chance that the dataset used for training and validation differs from the prediction data. DataRobot monitors both target and feature drift information.
GET /api/v2/deployments/{deploymentId}/featureDrift/
Retrieve drift scores for features of the deployment.
Parameters
| Name |
In |
Type |
Required |
Description |
| start |
query |
string,null(date-time) |
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. |
| end |
query |
string,null(date-time) |
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 |
query |
string |
false |
ID of the model in the deployment. If not set, defaults to the deployment current model. |
| metric |
query |
string |
false |
Name of the metric used to calculate the drift. Can be one of psi, kl_divergence, dissimilarity, hellinger, and js_divergence. Defaults to psi. |
| offset |
query |
integer |
false |
The number of features to skip, defaults to 0. |
| limit |
query |
integer |
false |
The number of features to return, defaults to 25. |
| segmentAttribute |
query |
string |
false |
The name of a segment attribute used for segment analysis. |
| segmentValue |
query |
string,null |
false |
The value of the segmentAttribute to segment on. |
| batchId |
query |
any |
false |
The id of the batch for which metrics are being retrieved. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| metric |
[psi, kl_divergence, dissimilarity, hellinger, js_divergence] |
Example responses
200 Response
{
"properties": {
"batchId": {
"default": [],
"description": "The id of the batch for which metrics are being retrieved.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 25,
"type": "array"
}
]
},
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "An array [DriftObject], each in the form described below",
"items": {
"properties": {
"baselineSampleSize": {
"description": "The sample size of the training data.",
"type": "integer"
},
"driftScore": {
"description": "The drift score for this feature.",
"type": [
"number",
"null"
]
},
"featureImpact": {
"description": "The feature impact score for this feature.",
"type": [
"number",
"null"
]
},
"name": {
"description": "The name of the feature.",
"type": "string"
},
"sampleSize": {
"description": "The number of predictions used to compute the drift score.",
"type": "integer"
},
"type": {
"description": "Type of the feature.",
"enum": [
"numeric",
"categorical",
"text"
],
"type": "string",
"x-versionadded": "v2.30"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"featureImpact",
"name",
"sampleSize",
"type"
],
"type": "object"
},
"type": "array"
},
"metric": {
"description": "Metric used to calculate drift score.",
"enum": [
"psi",
"kl_divergence",
"dissimilarity",
"hellinger",
"js_divergence"
],
"type": "string"
},
"modelId": {
"description": "The id of the model for which the features drift is being retrieved.",
"type": "string"
},
"next": {
"description": "A URL pointing to the next page (if null, there is no next page)",
"type": [
"string",
"null"
]
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"previous": {
"description": "A URL pointing to the previous page (if null, there is no previous page)",
"type": [
"string",
"null"
]
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
]
},
"segmentValue": {
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"modelId"
],
"type": "object"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
Features drift over specified time period retrieved. |
FeatureDriftResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDriftOverBatch/
Retrieve drift over batch info for a feature of the deployment.
Parameters
| Name |
In |
Type |
Required |
Description |
| segmentAttribute |
query |
string,null |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string,null |
false |
The value of the segmentAttribute to segment on. |
| batchId |
query |
any |
false |
The id of the batch for which metrics are being retrieved. |
| featureNames |
query |
any |
true |
List of feature names, limited to two per request. |
| driftMetric |
query |
string,null |
false |
The metric used to calculate data drift scores. |
| modelId |
query |
string |
false |
The id of the model for which metrics are being retrieved. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| driftMetric |
[psi, kl_divergence, dissimilarity, hellinger, js_divergence] |
Example responses
200 Response
{
"properties": {
"buckets": {
"description": "A list of buckets to display feature drift over batch.",
"items": {
"properties": {
"baselineSampleSize": {
"description": "The sample size in the baseline used to calculate drift score.",
"type": "integer",
"x-versionadded": "v2.33"
},
"batch": {
"description": "Info of the batch associated with the bucket.",
"properties": {
"earliestPredictionTimestamp": {
"description": "Earliest prediction timestamp of a batch.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "Batch ID.",
"type": "string",
"x-versionadded": "v2.33"
},
"latestPredictionTimestamp": {
"description": "Latest prediction timestamp of a batch.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "Batch name.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"earliestPredictionTimestamp",
"id",
"latestPredictionTimestamp",
"name"
],
"type": "object"
},
"driftScore": {
"description": "Drift score of the feature.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"featureImpact": {
"description": "The feature impact score of the feature.",
"type": "number",
"x-versionadded": "v2.33"
},
"featureName": {
"description": "Feature name.",
"type": "string",
"x-versionadded": "v2.33"
},
"sampleSize": {
"description": "The sample size in the batch used to calculate drift score.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"baselineSampleSize",
"batch",
"driftScore",
"featureImpact",
"featureName",
"sampleSize"
],
"type": "object"
},
"type": "array",
"x-versionadded": "v2.33"
},
"driftMetric": {
"description": "The metric used to calculate data drift scores.",
"enum": [
"psi",
"kl_divergence",
"dissimilarity",
"hellinger",
"js_divergence"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"buckets"
],
"type": "object"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDriftOverSpace/
Retrieve drift scores for a feature of the deployment over the geospatial feature data.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
| Feature Flag |
Maturity |
Enabled by default |
Description |
| MMM_GEOSPATIAL_FEATURES_MONITORING |
PUBLIC_PREVIEW |
true |
Enables monitoring geospatial features. |
Parameters
| Name |
In |
Type |
Required |
Description |
| start |
query |
string,null(date-time) |
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. |
| end |
query |
string,null(date-time) |
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. |
| geoFeatureName |
query |
string |
false |
The name of the geospatial feature. Segmented analysis must be enabled for the feature specified. |
| featureName |
query |
string |
false |
The name of the feature to retrieve drift scores for. Defaults to the target or, if there is no target, the most important feature. |
| modelId |
query |
string |
false |
The ID of the model that feature drift is being retrieved from. |
| metric |
query |
string |
false |
The metric used to calculate drift score. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| metric |
[psi, klDivergence, dissimilarity, hellinger, jsDivergence] |
Example responses
200 Response
{
"properties": {
"data": {
"description": "An array [DriftObject], each in the form described below",
"items": {
"properties": {
"baselineSampleSize": {
"description": "The baseline sample size for the hexagon.",
"type": "integer"
},
"driftScore": {
"description": "The drift score for this feature.",
"type": "number"
},
"hexagon": {
"description": "h3 hexagon.",
"type": "string"
},
"sampleSize": {
"description": "The sample size for the hexagon.",
"type": "integer"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"hexagon",
"sampleSize"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 10000,
"type": "array"
},
"featureName": {
"description": "The name of the feature to retrieve drift scores for. Defaults to the target or, if there is no target, the most important feature.",
"type": "string"
},
"geoFeatureName": {
"description": "The name of the geospatial feature. Segmented analysis must be enabled for the feature specified.",
"type": "string"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"required": [
"data",
"featureName",
"geoFeatureName"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
The retrieved drift scores for the specified feature over the specified geospatial feature data. |
FeatureDriftOverSpaceResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDriftOverTime/
Retrieve drift over time info for a feature of the deployment.
Parameters
| Name |
In |
Type |
Required |
Description |
| start |
query |
string,null(date-time) |
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. |
| end |
query |
string,null(date-time) |
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. |
| bucketSize |
query |
string(duration) |
false |
The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time. |
| modelId |
query |
string |
false |
The id of the model for which the features drift is being retrieved. |
| featureNames |
query |
any |
true |
List of feature names, limited to two per request. |
| metric |
query |
string |
false |
Name of the metric used to calculate the drift. Can be one of psi, kl_divergence, dissimilarity, hellinger, and js_divergence. Defaults to psi. |
| segmentAttribute |
query |
string,null |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string,null |
false |
The value of the segmentAttribute to segment on. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| metric |
[psi, kl_divergence, dissimilarity, hellinger, js_divergence] |
Example responses
200 Response
{
"properties": {
"buckets": {
"description": "A list of aggregated drift scores by feature over a given period.",
"items": {
"properties": {
"baselineSampleSize": {
"description": "The sample size of the training data used during model creation",
"type": "integer"
},
"driftScore": {
"description": "The aggregated drift score for the target.",
"type": [
"number",
"null"
]
},
"featureImpact": {
"description": "The feature impact score of the feature.",
"type": "number"
},
"featureName": {
"description": "Name of the feature.",
"type": "string"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"sampleSize": {
"description": "The sample size in the query period used to calculate drift score.",
"type": "integer"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"featureImpact",
"featureName",
"period",
"sampleSize"
],
"type": "object"
},
"type": "array"
},
"features": {
"description": "A list of the requested features and their feature type.",
"items": {
"properties": {
"featureName": {
"description": "Name of the requested feature.",
"type": "string"
},
"featureType": {
"description": "Data type of the requested feature.",
"enum": [
"numeric",
"categorical",
"text"
],
"type": "string"
}
},
"required": [
"featureName",
"featureType"
],
"type": "object"
},
"type": "array"
},
"metric": {
"description": "Name of requested metric.",
"type": "string"
},
"summaries": {
"description": "A list of aggregated drift scores by feature over a given period.",
"items": {
"properties": {
"featureImpact": {
"description": "The feature impact score of the feature.",
"type": "number"
},
"featureName": {
"description": "Name of the feature.",
"type": "string"
}
},
"required": [
"featureImpact",
"featureName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"buckets",
"features",
"metric",
"summaries"
],
"type": "object"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
Feature drift over time info of the deployment retrieved. |
FeatureDriftOverTimeResponse |
| 400 |
Bad Request |
Request invalid, refer to messages for detail. |
None |
| 403 |
Forbidden |
Model Deployments and/or Monitoring are not enabled. |
None |
| 404 |
Not Found |
Either the deployment does not exist or user does not have permission to view the deployment. |
None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsOverBatch/
Retrieve metrics about predictions, such as row count, mean predicted value, mean probabilities, and class distribution, over batches.
Parameters
| Name |
In |
Type |
Required |
Description |
| segmentAttribute |
query |
string,null |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string,null |
false |
The value of the segmentAttribute to segment on. |
| batchId |
query |
any |
false |
The id of the batch for which metrics are being retrieved. |
| modelId |
query |
string |
false |
The id of the model for which metrics are being retrieved. |
| includePercentiles |
query |
string |
false |
Include percentiles in the response, only applicable to deployments with binary classification, location and regression target. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| includePercentiles |
[false, False, true, True] |
Example responses
200 Response
{
"properties": {
"baselines": {
"description": "Target baselines",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"modelId",
"rowCount"
],
"type": "object"
},
"type": "array",
"x-versionadded": "v2.33"
},
"buckets": {
"description": "Predictions over batch buckets",
"items": {
"properties": {
"batch": {
"description": "Info of the batch associated with the bucket.",
"properties": {
"earliestPredictionTimestamp": {
"description": "Earliest prediction timestamp of a batch.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "Batch ID.",
"type": "string",
"x-versionadded": "v2.33"
},
"latestPredictionTimestamp": {
"description": "Latest prediction timestamp of a batch.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "Batch name.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"earliestPredictionTimestamp",
"id",
"latestPredictionTimestamp",
"name"
],
"type": "object"
},
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array",
"x-versionadded": "v2.33"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array",
"x-versionadded": "v2.33"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array",
"x-versionadded": "v2.33"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"batch",
"rowCount"
],
"type": "object"
},
"type": "array",
"x-versionadded": "v2.33"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
},
"segmentValue": {
"default": "",
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
}
},
"required": [
"baselines",
"buckets"
],
"type": "object"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsOverSpace/
Retrieve predictions stats for the deployment over the geospatial feature data.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
| Feature Flag |
Maturity |
Enabled by default |
Description |
| MMM_GEOSPATIAL_FEATURES_MONITORING |
PUBLIC_PREVIEW |
true |
Enables monitoring geospatial features. |
Parameters
| Name |
In |
Type |
Required |
Description |
| start |
query |
string,null(date-time) |
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. |
| end |
query |
string,null(date-time) |
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. |
| geoFeatureName |
query |
string |
false |
The name of the geospatial feature. Segmented analysis must be enabled for the feature specified. |
| modelId |
query |
string |
false |
The ID of the model that feature drift is being retrieved from. |
| targetClass |
query |
any |
false |
Target class to filter out results. |
| includePercentiles |
query |
string |
false |
Include percentiles in the response, only applicable to deployments with binary classification, location and regression target. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| includePercentiles |
[false, False, true, True] |
Example responses
200 Response
{
"properties": {
"baselines": {
"description": "Baseline predictions per geospatial hexagon.",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"hexagon": {
"description": "h3 hexagon.",
"type": [
"string",
"null"
]
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"rowCount"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 10000,
"type": "array"
},
"buckets": {
"description": "Predictions per geospatial hexagon.",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"hexagon": {
"description": "h3 hexagon.",
"type": [
"string",
"null"
]
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"rowCount"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 10000,
"type": "array"
},
"geoFeatureName": {
"description": "The name of the geospatial feature. Segmented analysis must be enabled for the feature specified.",
"type": "string"
},
"modelId": {
"description": "The ID of the model that predictions are being retrieved from.",
"type": "string"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"required": [
"baselines",
"buckets",
"geoFeatureName"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
The retrieved prediction stats for the specified feature over the specified geospatial feature data. |
PredictionsOverSpaceResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsOverTime/
Retrieve metrics about predictions, such as row count, mean predicted value, mean probabilities, and class distribution, over a specific time range.
Parameters
| Name |
In |
Type |
Required |
Description |
| start |
query |
string,null(date-time) |
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. |
| end |
query |
string,null(date-time) |
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. |
| bucketSize |
query |
string |
false |
Time duration of buckets |
| segmentAttribute |
query |
string,null |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string,null |
false |
The value of the segmentAttribute to segment on. |
| modelId |
query |
any |
false |
The ID of the models for which metrics are being retrieved. |
| targetClass |
query |
any |
false |
Target class to filter out results. |
| includePercentiles |
query |
string |
false |
Include percentiles in the response, only applicable to deployments with binary classification, location and regression target. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| bucketSize |
[PT1H, P1D, P7D, P1M] |
| includePercentiles |
[false, False, true, True] |
Example responses
200 Response
{
"properties": {
"baselines": {
"description": "Target baselines",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"modelId",
"rowCount"
],
"type": "object"
},
"type": "array"
},
"buckets": {
"description": "Predictions over time buckets",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"modelId",
"period",
"rowCount"
],
"type": "object"
},
"type": "array"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
},
"segmentValue": {
"default": "",
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
}
},
"required": [
"baselines",
"buckets"
],
"type": "object"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/targetDrift/
Retrieve target drift data.
Parameters
| Name |
In |
Type |
Required |
Description |
| start |
query |
string,null(date-time) |
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. |
| end |
query |
string,null(date-time) |
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 |
query |
string |
false |
An ID of the model in the deployment. If not set, defaults to the deployment current model. |
| metric |
query |
string |
false |
Metric used to calculate drift score. |
| segmentAttribute |
query |
string |
false |
The name of a segment attribute used for segment analysis. |
| segmentValue |
query |
string,null |
false |
The value of the segmentAttribute to segment on. |
| batchId |
query |
any |
false |
The id of the batch for which metrics are being retrieved. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| metric |
[psi, kl_divergence, dissimilarity, hellinger, js_divergence] |
Example responses
200 Response
{
"properties": {
"baselineSampleSize": {
"description": "sample size of the training data.",
"type": "integer"
},
"batchId": {
"default": [],
"description": "The id of the batch for which metrics are being retrieved.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 25,
"type": "array"
}
]
},
"driftScore": {
"description": "drift score for the target.",
"type": [
"number",
"null"
]
},
"metric": {
"description": "Metric used to calculate drift score.",
"enum": [
"psi",
"kl_divergence",
"dissimilarity",
"hellinger",
"js_divergence"
],
"type": "string"
},
"modelId": {
"description": "id of the model for which data drift is being retrieved.",
"type": "string"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"sampleSize": {
"description": "number of predictions used to compute the drift score.",
"type": "integer"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
]
},
"segmentValue": {
"default": "",
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
},
"targetName": {
"description": "name of the target feature.",
"type": "string"
},
"type": {
"description": "Type of the feature.",
"enum": [
"numeric",
"categorical",
"text"
],
"type": "string"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"modelId",
"sampleSize",
"targetName",
"type"
],
"type": "object"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
Target drift over specified time period retrieved. |
TargetDriftResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas
ClassDistribution
{
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| className |
string |
true |
|
Name of the class |
| count |
integer |
true |
|
Count of rows labeled with a class in the bucket |
| percent |
number |
true |
|
Percent of rows labeled with a class in the bucket |
DriftBatch
{
"description": "Info of the batch associated with the bucket.",
"properties": {
"earliestPredictionTimestamp": {
"description": "Earliest prediction timestamp of a batch.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "Batch ID.",
"type": "string",
"x-versionadded": "v2.33"
},
"latestPredictionTimestamp": {
"description": "Latest prediction timestamp of a batch.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "Batch name.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"earliestPredictionTimestamp",
"id",
"latestPredictionTimestamp",
"name"
],
"type": "object"
}
Info of the batch associated with the bucket.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| earliestPredictionTimestamp |
string(date-time) |
true |
|
Earliest prediction timestamp of a batch. |
| id |
string |
true |
|
Batch ID. |
| latestPredictionTimestamp |
string,null(date-time) |
true |
|
Latest prediction timestamp of a batch. |
| name |
string |
true |
|
Batch name. |
FeatureDrift
{
"properties": {
"baselineSampleSize": {
"description": "The sample size of the training data.",
"type": "integer"
},
"driftScore": {
"description": "The drift score for this feature.",
"type": [
"number",
"null"
]
},
"featureImpact": {
"description": "The feature impact score for this feature.",
"type": [
"number",
"null"
]
},
"name": {
"description": "The name of the feature.",
"type": "string"
},
"sampleSize": {
"description": "The number of predictions used to compute the drift score.",
"type": "integer"
},
"type": {
"description": "Type of the feature.",
"enum": [
"numeric",
"categorical",
"text"
],
"type": "string",
"x-versionadded": "v2.30"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"featureImpact",
"name",
"sampleSize",
"type"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineSampleSize |
integer |
true |
|
The sample size of the training data. |
| driftScore |
number,null |
true |
|
The drift score for this feature. |
| featureImpact |
number,null |
true |
|
The feature impact score for this feature. |
| name |
string |
true |
|
The name of the feature. |
| sampleSize |
integer |
true |
|
The number of predictions used to compute the drift score. |
| type |
string |
true |
|
Type of the feature. |
Enumerated Values
| Property |
Value |
| type |
[numeric, categorical, text] |
FeatureDriftOverBatchBucket
{
"properties": {
"baselineSampleSize": {
"description": "The sample size in the baseline used to calculate drift score.",
"type": "integer",
"x-versionadded": "v2.33"
},
"batch": {
"description": "Info of the batch associated with the bucket.",
"properties": {
"earliestPredictionTimestamp": {
"description": "Earliest prediction timestamp of a batch.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "Batch ID.",
"type": "string",
"x-versionadded": "v2.33"
},
"latestPredictionTimestamp": {
"description": "Latest prediction timestamp of a batch.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "Batch name.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"earliestPredictionTimestamp",
"id",
"latestPredictionTimestamp",
"name"
],
"type": "object"
},
"driftScore": {
"description": "Drift score of the feature.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"featureImpact": {
"description": "The feature impact score of the feature.",
"type": "number",
"x-versionadded": "v2.33"
},
"featureName": {
"description": "Feature name.",
"type": "string",
"x-versionadded": "v2.33"
},
"sampleSize": {
"description": "The sample size in the batch used to calculate drift score.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"baselineSampleSize",
"batch",
"driftScore",
"featureImpact",
"featureName",
"sampleSize"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineSampleSize |
integer |
true |
|
The sample size in the baseline used to calculate drift score. |
| batch |
DriftBatch |
true |
|
Info of the batch associated with the bucket. |
| driftScore |
number,null |
true |
|
Drift score of the feature. |
| featureImpact |
number |
true |
|
The feature impact score of the feature. |
| featureName |
string |
true |
|
Feature name. |
| sampleSize |
integer |
true |
|
The sample size in the batch used to calculate drift score. |
FeatureDriftOverBatchResponse
{
"properties": {
"buckets": {
"description": "A list of buckets to display feature drift over batch.",
"items": {
"properties": {
"baselineSampleSize": {
"description": "The sample size in the baseline used to calculate drift score.",
"type": "integer",
"x-versionadded": "v2.33"
},
"batch": {
"description": "Info of the batch associated with the bucket.",
"properties": {
"earliestPredictionTimestamp": {
"description": "Earliest prediction timestamp of a batch.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "Batch ID.",
"type": "string",
"x-versionadded": "v2.33"
},
"latestPredictionTimestamp": {
"description": "Latest prediction timestamp of a batch.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "Batch name.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"earliestPredictionTimestamp",
"id",
"latestPredictionTimestamp",
"name"
],
"type": "object"
},
"driftScore": {
"description": "Drift score of the feature.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"featureImpact": {
"description": "The feature impact score of the feature.",
"type": "number",
"x-versionadded": "v2.33"
},
"featureName": {
"description": "Feature name.",
"type": "string",
"x-versionadded": "v2.33"
},
"sampleSize": {
"description": "The sample size in the batch used to calculate drift score.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"baselineSampleSize",
"batch",
"driftScore",
"featureImpact",
"featureName",
"sampleSize"
],
"type": "object"
},
"type": "array",
"x-versionadded": "v2.33"
},
"driftMetric": {
"description": "The metric used to calculate data drift scores.",
"enum": [
"psi",
"kl_divergence",
"dissimilarity",
"hellinger",
"js_divergence"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"buckets"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| buckets |
[FeatureDriftOverBatchBucket] |
true |
|
A list of buckets to display feature drift over batch. |
| driftMetric |
string |
false |
|
The metric used to calculate data drift scores. |
Enumerated Values
| Property |
Value |
| driftMetric |
[psi, kl_divergence, dissimilarity, hellinger, js_divergence] |
FeatureDriftOverSpaceBucket
{
"properties": {
"baselineSampleSize": {
"description": "The baseline sample size for the hexagon.",
"type": "integer"
},
"driftScore": {
"description": "The drift score for this feature.",
"type": "number"
},
"hexagon": {
"description": "h3 hexagon.",
"type": "string"
},
"sampleSize": {
"description": "The sample size for the hexagon.",
"type": "integer"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"hexagon",
"sampleSize"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineSampleSize |
integer |
true |
|
The baseline sample size for the hexagon. |
| driftScore |
number |
true |
|
The drift score for this feature. |
| hexagon |
string |
true |
|
h3 hexagon. |
| sampleSize |
integer |
true |
|
The sample size for the hexagon. |
FeatureDriftOverSpaceResponse
{
"properties": {
"data": {
"description": "An array [DriftObject], each in the form described below",
"items": {
"properties": {
"baselineSampleSize": {
"description": "The baseline sample size for the hexagon.",
"type": "integer"
},
"driftScore": {
"description": "The drift score for this feature.",
"type": "number"
},
"hexagon": {
"description": "h3 hexagon.",
"type": "string"
},
"sampleSize": {
"description": "The sample size for the hexagon.",
"type": "integer"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"hexagon",
"sampleSize"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 10000,
"type": "array"
},
"featureName": {
"description": "The name of the feature to retrieve drift scores for. Defaults to the target or, if there is no target, the most important feature.",
"type": "string"
},
"geoFeatureName": {
"description": "The name of the geospatial feature. Segmented analysis must be enabled for the feature specified.",
"type": "string"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"required": [
"data",
"featureName",
"geoFeatureName"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| data |
[FeatureDriftOverSpaceBucket] |
true |
maxItems: 10000
|
An array [DriftObject], each in the form described below |
| featureName |
string |
true |
|
The name of the feature to retrieve drift scores for. Defaults to the target or, if there is no target, the most important feature. |
| geoFeatureName |
string |
true |
|
The name of the geospatial feature. Segmented analysis must be enabled for the feature specified. |
| period |
TimeRange |
false |
|
An object with the keys "start" and "end" defining the period. |
FeatureDriftOverTimeBucket
{
"properties": {
"baselineSampleSize": {
"description": "The sample size of the training data used during model creation",
"type": "integer"
},
"driftScore": {
"description": "The aggregated drift score for the target.",
"type": [
"number",
"null"
]
},
"featureImpact": {
"description": "The feature impact score of the feature.",
"type": "number"
},
"featureName": {
"description": "Name of the feature.",
"type": "string"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"sampleSize": {
"description": "The sample size in the query period used to calculate drift score.",
"type": "integer"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"featureImpact",
"featureName",
"period",
"sampleSize"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineSampleSize |
integer |
true |
|
The sample size of the training data used during model creation |
| driftScore |
number,null |
true |
|
The aggregated drift score for the target. |
| featureImpact |
number |
true |
|
The feature impact score of the feature. |
| featureName |
string |
true |
|
Name of the feature. |
| period |
TimeRange |
true |
|
An object with the keys "start" and "end" defining the period. |
| sampleSize |
integer |
true |
|
The sample size in the query period used to calculate drift score. |
FeatureDriftOverTimeFeature
{
"properties": {
"featureName": {
"description": "Name of the requested feature.",
"type": "string"
},
"featureType": {
"description": "Data type of the requested feature.",
"enum": [
"numeric",
"categorical",
"text"
],
"type": "string"
}
},
"required": [
"featureName",
"featureType"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| featureName |
string |
true |
|
Name of the requested feature. |
| featureType |
string |
true |
|
Data type of the requested feature. |
Enumerated Values
| Property |
Value |
| featureType |
[numeric, categorical, text] |
FeatureDriftOverTimeResponse
{
"properties": {
"buckets": {
"description": "A list of aggregated drift scores by feature over a given period.",
"items": {
"properties": {
"baselineSampleSize": {
"description": "The sample size of the training data used during model creation",
"type": "integer"
},
"driftScore": {
"description": "The aggregated drift score for the target.",
"type": [
"number",
"null"
]
},
"featureImpact": {
"description": "The feature impact score of the feature.",
"type": "number"
},
"featureName": {
"description": "Name of the feature.",
"type": "string"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"sampleSize": {
"description": "The sample size in the query period used to calculate drift score.",
"type": "integer"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"featureImpact",
"featureName",
"period",
"sampleSize"
],
"type": "object"
},
"type": "array"
},
"features": {
"description": "A list of the requested features and their feature type.",
"items": {
"properties": {
"featureName": {
"description": "Name of the requested feature.",
"type": "string"
},
"featureType": {
"description": "Data type of the requested feature.",
"enum": [
"numeric",
"categorical",
"text"
],
"type": "string"
}
},
"required": [
"featureName",
"featureType"
],
"type": "object"
},
"type": "array"
},
"metric": {
"description": "Name of requested metric.",
"type": "string"
},
"summaries": {
"description": "A list of aggregated drift scores by feature over a given period.",
"items": {
"properties": {
"featureImpact": {
"description": "The feature impact score of the feature.",
"type": "number"
},
"featureName": {
"description": "Name of the feature.",
"type": "string"
}
},
"required": [
"featureImpact",
"featureName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"buckets",
"features",
"metric",
"summaries"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| buckets |
[FeatureDriftOverTimeBucket] |
true |
|
A list of aggregated drift scores by feature over a given period. |
| features |
[FeatureDriftOverTimeFeature] |
true |
|
A list of the requested features and their feature type. |
| metric |
string |
true |
|
Name of requested metric. |
| summaries |
[FeatureDriftOverTimeSummary] |
true |
|
A list of aggregated drift scores by feature over a given period. |
FeatureDriftOverTimeSummary
{
"properties": {
"featureImpact": {
"description": "The feature impact score of the feature.",
"type": "number"
},
"featureName": {
"description": "Name of the feature.",
"type": "string"
}
},
"required": [
"featureImpact",
"featureName"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| featureImpact |
number |
true |
|
The feature impact score of the feature. |
| featureName |
string |
true |
|
Name of the feature. |
FeatureDriftResponse
{
"properties": {
"batchId": {
"default": [],
"description": "The id of the batch for which metrics are being retrieved.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 25,
"type": "array"
}
]
},
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "An array [DriftObject], each in the form described below",
"items": {
"properties": {
"baselineSampleSize": {
"description": "The sample size of the training data.",
"type": "integer"
},
"driftScore": {
"description": "The drift score for this feature.",
"type": [
"number",
"null"
]
},
"featureImpact": {
"description": "The feature impact score for this feature.",
"type": [
"number",
"null"
]
},
"name": {
"description": "The name of the feature.",
"type": "string"
},
"sampleSize": {
"description": "The number of predictions used to compute the drift score.",
"type": "integer"
},
"type": {
"description": "Type of the feature.",
"enum": [
"numeric",
"categorical",
"text"
],
"type": "string",
"x-versionadded": "v2.30"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"featureImpact",
"name",
"sampleSize",
"type"
],
"type": "object"
},
"type": "array"
},
"metric": {
"description": "Metric used to calculate drift score.",
"enum": [
"psi",
"kl_divergence",
"dissimilarity",
"hellinger",
"js_divergence"
],
"type": "string"
},
"modelId": {
"description": "The id of the model for which the features drift is being retrieved.",
"type": "string"
},
"next": {
"description": "A URL pointing to the next page (if null, there is no next page)",
"type": [
"string",
"null"
]
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"previous": {
"description": "A URL pointing to the previous page (if null, there is no previous page)",
"type": [
"string",
"null"
]
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
]
},
"segmentValue": {
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"modelId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| batchId |
any |
false |
|
The id of the batch for which metrics are being retrieved. |
oneOf
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
string |
false |
|
none |
xor
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
[string] |
false |
maxItems: 25
|
none |
continued
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[FeatureDrift] |
true |
|
An array [DriftObject], each in the form described below |
| metric |
string |
false |
|
Metric used to calculate drift score. |
| modelId |
string |
true |
|
The id of the model for which the features drift is being retrieved. |
| next |
string,null |
false |
|
A URL pointing to the next page (if null, there is no next page) |
| period |
TimeRange |
false |
|
An object with the keys "start" and "end" defining the period. |
| previous |
string,null |
false |
|
A URL pointing to the previous page (if null, there is no previous page) |
| segmentAttribute |
string,null |
false |
|
The name of the segment on which segment analysis is being performed. |
| segmentValue |
string,null |
false |
|
The value of the segmentAttribute to segment on. |
Enumerated Values
| Property |
Value |
| metric |
[psi, kl_divergence, dissimilarity, hellinger, js_divergence] |
GeoPoint
{
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
}
Geo centroid.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| latitude |
number |
true |
|
Latitude. |
| longitude |
number |
true |
|
Longitude. |
MeanProbability
{
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| className |
string |
true |
|
Name of the class |
| value |
number |
true |
|
Mean predicted probability for a class for all rows in the bucket |
Percentile
{
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| geoCentroid |
GeoPoint |
false |
|
Geo centroid. |
| percent |
number |
true |
|
Percent of the percentile |
| value |
number,null |
false |
|
Predicted value or probability at a percentile |
PredictionsOverBatchBucket
{
"properties": {
"batch": {
"description": "Info of the batch associated with the bucket.",
"properties": {
"earliestPredictionTimestamp": {
"description": "Earliest prediction timestamp of a batch.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "Batch ID.",
"type": "string",
"x-versionadded": "v2.33"
},
"latestPredictionTimestamp": {
"description": "Latest prediction timestamp of a batch.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "Batch name.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"earliestPredictionTimestamp",
"id",
"latestPredictionTimestamp",
"name"
],
"type": "object"
},
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array",
"x-versionadded": "v2.33"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array",
"x-versionadded": "v2.33"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array",
"x-versionadded": "v2.33"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"batch",
"rowCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| batch |
DriftBatch |
true |
|
Info of the batch associated with the bucket. |
| classDistribution |
[ClassDistribution] |
false |
maxItems: 10000
|
Class distribution for all classes in the bucket, only for classification deployments. |
| meanGeoCentroid |
GeoPoint |
false |
|
Geo centroid. |
| meanPredictedValue |
number,null |
false |
|
Mean predicted value for all rows in the bucket, only for regression deployments. |
| meanProbabilities |
[MeanProbability] |
false |
maxItems: 10000
|
Mean predicted probabilities for all classes in the bucket, only for classification deployments |
| percentiles |
[Percentile] |
false |
maxItems: 10
|
Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments. |
| predictionsWarningCount |
integer,null |
false |
|
The number of predictions with warning in the bucket |
| rowCount |
integer,null |
true |
|
Number of rows in the bucket. |
PredictionsOverBatchResponse
{
"properties": {
"baselines": {
"description": "Target baselines",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"modelId",
"rowCount"
],
"type": "object"
},
"type": "array",
"x-versionadded": "v2.33"
},
"buckets": {
"description": "Predictions over batch buckets",
"items": {
"properties": {
"batch": {
"description": "Info of the batch associated with the bucket.",
"properties": {
"earliestPredictionTimestamp": {
"description": "Earliest prediction timestamp of a batch.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "Batch ID.",
"type": "string",
"x-versionadded": "v2.33"
},
"latestPredictionTimestamp": {
"description": "Latest prediction timestamp of a batch.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "Batch name.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"earliestPredictionTimestamp",
"id",
"latestPredictionTimestamp",
"name"
],
"type": "object"
},
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array",
"x-versionadded": "v2.33"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array",
"x-versionadded": "v2.33"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array",
"x-versionadded": "v2.33"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"batch",
"rowCount"
],
"type": "object"
},
"type": "array",
"x-versionadded": "v2.33"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
},
"segmentValue": {
"default": "",
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
}
},
"required": [
"baselines",
"buckets"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselines |
[TargetBaseline] |
true |
|
Target baselines |
| buckets |
[PredictionsOverBatchBucket] |
true |
|
Predictions over batch buckets |
| segmentAttribute |
string,null |
false |
|
The name of the segment on which segment analysis is being performed. |
| segmentValue |
string,null |
false |
|
The value of the segmentAttribute to segment on. |
PredictionsOverSpaceBucket
{
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"hexagon": {
"description": "h3 hexagon.",
"type": [
"string",
"null"
]
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"rowCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| classDistribution |
[ClassDistribution] |
false |
maxItems: 10000
|
Class distribution for all classes in the bucket, only for classification deployments. |
| hexagon |
string,null |
false |
|
h3 hexagon. |
| meanGeoCentroid |
GeoPoint |
false |
|
Geo centroid. |
| meanPredictedValue |
number,null |
false |
|
Mean predicted value for all rows in the bucket, only for regression deployments. |
| meanProbabilities |
[MeanProbability] |
false |
maxItems: 10000
|
Mean predicted probabilities for all classes in the bucket, only for classification deployments |
| percentiles |
[Percentile] |
false |
maxItems: 10
|
Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments. |
| predictionsWarningCount |
integer,null |
false |
|
The number of predictions with warning in the bucket |
| rowCount |
integer,null |
true |
|
Number of rows in the bucket. |
PredictionsOverSpaceResponse
{
"properties": {
"baselines": {
"description": "Baseline predictions per geospatial hexagon.",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"hexagon": {
"description": "h3 hexagon.",
"type": [
"string",
"null"
]
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"rowCount"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 10000,
"type": "array"
},
"buckets": {
"description": "Predictions per geospatial hexagon.",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"hexagon": {
"description": "h3 hexagon.",
"type": [
"string",
"null"
]
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"rowCount"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 10000,
"type": "array"
},
"geoFeatureName": {
"description": "The name of the geospatial feature. Segmented analysis must be enabled for the feature specified.",
"type": "string"
},
"modelId": {
"description": "The ID of the model that predictions are being retrieved from.",
"type": "string"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"required": [
"baselines",
"buckets",
"geoFeatureName"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselines |
[PredictionsOverSpaceBucket] |
true |
maxItems: 10000
|
Baseline predictions per geospatial hexagon. |
| buckets |
[PredictionsOverSpaceBucket] |
true |
maxItems: 10000
|
Predictions per geospatial hexagon. |
| geoFeatureName |
string |
true |
|
The name of the geospatial feature. Segmented analysis must be enabled for the feature specified. |
| modelId |
string |
false |
|
The ID of the model that predictions are being retrieved from. |
| period |
TimeRange |
false |
|
An object with the keys "start" and "end" defining the period. |
PredictionsOverTimeBucket
{
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"modelId",
"period",
"rowCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| classDistribution |
[ClassDistribution] |
false |
maxItems: 10000
|
Class distribution for all classes in the bucket, only for classification deployments. |
| meanGeoCentroid |
GeoPoint |
false |
|
Geo centroid. |
| meanPredictedValue |
number,null |
false |
|
Mean predicted value for all rows in the bucket, only for regression deployments. |
| meanProbabilities |
[MeanProbability] |
false |
maxItems: 10000
|
Mean predicted probabilities for all classes in the bucket, only for classification deployments |
| modelId |
string |
true |
|
ID of the model |
| percentiles |
[Percentile] |
false |
maxItems: 10
|
Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments. |
| period |
TimeRange |
true |
|
An object with the keys "start" and "end" defining the period. |
| predictionsWarningCount |
integer,null |
false |
|
The number of predictions with warning in the bucket |
| rowCount |
integer,null |
true |
|
Number of rows in the bucket. |
PredictionsOverTimeResponse
{
"properties": {
"baselines": {
"description": "Target baselines",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"modelId",
"rowCount"
],
"type": "object"
},
"type": "array"
},
"buckets": {
"description": "Predictions over time buckets",
"items": {
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"modelId",
"period",
"rowCount"
],
"type": "object"
},
"type": "array"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
},
"segmentValue": {
"default": "",
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
}
},
"required": [
"baselines",
"buckets"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselines |
[TargetBaseline] |
true |
|
Target baselines |
| buckets |
[PredictionsOverTimeBucket] |
true |
|
Predictions over time buckets |
| segmentAttribute |
string,null |
false |
|
The name of the segment on which segment analysis is being performed. |
| segmentValue |
string,null |
false |
|
The value of the segmentAttribute to segment on. |
TargetBaseline
{
"properties": {
"classDistribution": {
"description": "Class distribution for all classes in the bucket, only for classification deployments.",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"count": {
"description": "Count of rows labeled with a class in the bucket",
"type": "integer"
},
"percent": {
"description": "Percent of rows labeled with a class in the bucket",
"type": "number"
}
},
"required": [
"className",
"count",
"percent"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"meanGeoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"meanPredictedValue": {
"description": "Mean predicted value for all rows in the bucket, only for regression deployments.",
"type": [
"number",
"null"
]
},
"meanProbabilities": {
"description": "Mean predicted probabilities for all classes in the bucket, only for classification deployments",
"items": {
"properties": {
"className": {
"description": "Name of the class",
"type": "string"
},
"value": {
"description": "Mean predicted probability for a class for all rows in the bucket",
"type": "number"
}
},
"required": [
"className",
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"modelId": {
"description": "ID of the model",
"type": "string"
},
"percentiles": {
"description": "Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.",
"items": {
"properties": {
"geoCentroid": {
"description": "Geo centroid.",
"properties": {
"latitude": {
"description": "Latitude.",
"type": "number"
},
"longitude": {
"description": "Longitude.",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-versionadded": "v2.36"
},
"percent": {
"description": "Percent of the percentile",
"type": "number"
},
"value": {
"description": "Predicted value or probability at a percentile",
"type": [
"number",
"null"
]
}
},
"required": [
"percent"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"predictionsWarningCount": {
"description": "The number of predictions with warning in the bucket",
"type": [
"integer",
"null"
]
},
"rowCount": {
"description": "Number of rows in the bucket.",
"type": [
"integer",
"null"
]
}
},
"required": [
"modelId",
"rowCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| classDistribution |
[ClassDistribution] |
false |
maxItems: 10000
|
Class distribution for all classes in the bucket, only for classification deployments. |
| meanGeoCentroid |
GeoPoint |
false |
|
Geo centroid. |
| meanPredictedValue |
number,null |
false |
|
Mean predicted value for all rows in the bucket, only for regression deployments. |
| meanProbabilities |
[MeanProbability] |
false |
maxItems: 10000
|
Mean predicted probabilities for all classes in the bucket, only for classification deployments |
| modelId |
string |
true |
|
ID of the model |
| percentiles |
[Percentile] |
false |
maxItems: 10
|
Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments. |
| predictionsWarningCount |
integer,null |
false |
|
The number of predictions with warning in the bucket |
| rowCount |
integer,null |
true |
|
Number of rows in the bucket. |
TargetDriftResponse
{
"properties": {
"baselineSampleSize": {
"description": "sample size of the training data.",
"type": "integer"
},
"batchId": {
"default": [],
"description": "The id of the batch for which metrics are being retrieved.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 25,
"type": "array"
}
]
},
"driftScore": {
"description": "drift score for the target.",
"type": [
"number",
"null"
]
},
"metric": {
"description": "Metric used to calculate drift score.",
"enum": [
"psi",
"kl_divergence",
"dissimilarity",
"hellinger",
"js_divergence"
],
"type": "string"
},
"modelId": {
"description": "id of the model for which data drift is being retrieved.",
"type": "string"
},
"period": {
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"sampleSize": {
"description": "number of predictions used to compute the drift score.",
"type": "integer"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
]
},
"segmentValue": {
"default": "",
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.20"
},
"targetName": {
"description": "name of the target feature.",
"type": "string"
},
"type": {
"description": "Type of the feature.",
"enum": [
"numeric",
"categorical",
"text"
],
"type": "string"
}
},
"required": [
"baselineSampleSize",
"driftScore",
"modelId",
"sampleSize",
"targetName",
"type"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineSampleSize |
integer |
true |
|
sample size of the training data. |
| batchId |
any |
false |
|
The id of the batch for which metrics are being retrieved. |
oneOf
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
string |
false |
|
none |
xor
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
[string] |
false |
maxItems: 25
|
none |
continued
| Name |
Type |
Required |
Restrictions |
Description |
| driftScore |
number,null |
true |
|
drift score for the target. |
| metric |
string |
false |
|
Metric used to calculate drift score. |
| modelId |
string |
true |
|
id of the model for which data drift is being retrieved. |
| period |
TimeRange |
false |
|
An object with the keys "start" and "end" defining the period. |
| sampleSize |
integer |
true |
|
number of predictions used to compute the drift score. |
| segmentAttribute |
string,null |
false |
|
The name of the segment on which segment analysis is being performed. |
| segmentValue |
string,null |
false |
|
The value of the segmentAttribute to segment on. |
| targetName |
string |
true |
|
name of the target feature. |
| type |
string |
true |
|
Type of the feature. |
Enumerated Values
| Property |
Value |
| metric |
[psi, kl_divergence, dissimilarity, hellinger, js_divergence] |
| type |
[numeric, categorical, text] |
TimeRange
{
"description": "An object with the keys \"start\" and \"end\" defining the period.",
"properties": {
"end": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"start": {
"description": "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``.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
An object with the keys "start" and "end" defining the period.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| end |
string,null(date-time) |
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. |
| start |
string,null(date-time) |
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. |