Method
createBatchPrediction POST
Copy POST

Creates a batch prediction job description for the given deployment.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes deploymentId str Unique string identifier for the deployment.
No tableName str Name of the feature group table to write the results of the batch prediction. Can only be specified if outputLocation and databaseConnectorId are not specified. If tableName is specified, the outputType will be enforced as CSV.
No name str Name of the batch prediction job.
No globalPredictionArgs BatchPredictionArgs None
KEY TYPE Description
problemType None None
kwargs None None
SupportKwargs None None
No batchPredictionArgs BatchPredictionArgs Batch Prediction args specific to problem type.
KEY TYPE Description
problemType None None
kwargs None None
SupportKwargs None None
No explanations boolean None
No outputFormat str Format of the batch prediction output (CSV or JSON).
No outputLocation str Location to write the prediction results. Otherwise, results will be stored in Abacus.AI.
No databaseConnectorId str Unique identifier of a Database Connection to write predictions to. Cannot be specified in conjunction with outputLocation.
No databaseOutputConfig dict Key-value pair of columns/values to write to the database connector. Only available if databaseConnectorId is specified.
No refreshSchedule str Cron-style string that describes a schedule in UTC to automatically run the batch prediction.
No csvInputPrefix str Prefix to prepend to the input columns, only applies when output format is CSV.
No csvPredictionPrefix str Prefix to prepend to the prediction columns, only applies when output format is CSV.
No csvExplanationsPrefix str Prefix to prepend to the explanation columns, only applies when output format is CSV.
No outputIncludesMetadata bool If true, output will contain columns including prediction start time, batch prediction version, and model version.
No resultInputColumns list If present, will limit result files or feature groups to only include columns present in this list.
No inputFeatureGroups dict A dict of {'': ''} which overrides the default input data of that type for the Batch Prediction. Default input data is the training data that was used for training the deployed model.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result BatchPrediction
KEY TYPE Description
batchPredictionId str The unique identifier of the batch prediction request.
createdAt str When the batch prediction was created, in ISO-8601 format.
name str Name given to the batch prediction object.
deploymentId str The deployment used to make the predictions.
fileConnectorOutputLocation str Contains information about where the batch predictions are written to.
databaseConnectorId str The database connector to write the results to.
databaseOutputConfiguration dict Contains information about where the batch predictions are written to.
fileOutputFormat str The format of the batch prediction output (CSV or JSON).
connectorType str Null if writing to internal console, else FEATURE_GROUP | FILE_CONNECTOR | DATABASE_CONNECTOR.
legacyInputLocation str The location of the input data.
outputFeatureGroupId str The Batch Prediction output feature group ID if applicable
featureGroupTableName str The table name of the Batch Prediction output feature group.
outputFeatureGroupTableName str The table name of the Batch Prediction output feature group.
summaryFeatureGroupTableName str The table name of the metrics summary feature group output by Batch Prediction.
csvInputPrefix str A prefix to prepend to the input columns, only applies when output format is CSV.
csvPredictionPrefix str A prefix to prepend to the prediction columns, only applies when output format is CSV.
csvExplanationsPrefix str A prefix to prepend to the explanation columns, only applies when output format is CSV.
outputIncludesMetadata bool If true, output will contain columns including prediction start time, batch prediction version, and model version.
resultInputColumns list If present, will limit result files or feature groups to only include columns present in this list.
modelMonitorId str The model monitor for this batch prediction.
modelVersion str The model instance used in the deployment for the batch prediction.
bpAcrossVersionsMonitorId str The model monitor for this batch prediction across versions.
algorithm str The algorithm that is currently deployed.
batchPredictionArgsType str The type of batch prediction arguments used for this batch prediction.
batchInputs PredictionInput Inputs to the batch prediction.
KEY TYPE Description
featureGroupDatasetIds list The list of dataset IDs to use as input
datasetIdRemap dict Replacement datasets to swap as prediction input
featureGroups PredictionFeatureGroup List of prediction feature groups
KEY TYPE Description
featureGroupId str The unique identifier of the feature group
featureGroupVersion str The unique identifier of the feature group version used for predictions
datasetType str dataset type
default bool If true, this feature group is the default feature group in the model
required bool If true, this feature group is required for the batch prediction
datasets PredictionDataset List of prediction datasets
KEY TYPE Description
datasetId str The unique identifier of the dataset
datasetType str dataset type
datasetVersion str The unique identifier of the dataset version used for predictions
default bool If true, this dataset is the default dataset in the model
required bool If true, this dataset is required for the batch prediction
latestBatchPredictionVersion BatchPredictionVersion The latest batch prediction version.
KEY TYPE Description
batchPredictionVersion str The unique identifier of the batch prediction version
batchPredictionId str The unique identifier of the batch prediction
status str The current status of the batch prediction
driftMonitorStatus str The status of the drift monitor for this batch prediction version
deploymentId str The deployment used to make the predictions
modelId str The model used to make the predictions
modelVersion str The model version used to make the predictions
predictionsStartedAt str Predictions start date and time
predictionsCompletedAt str Predictions completion date and time
databaseOutputError bool If true, there were errors reported by the database connector while writing
totalPredictions int Number of predictions performed in this batch prediction job
failedPredictions int Number of predictions that failed
databaseConnectorId str The database connector to write the results to
databaseOutputConfiguration dict Contains information about where the batch predictions are written to
fileConnectorOutputLocation str Contains information about where the batch predictions are written to
fileOutputFormat str The format of the batch prediction output (CSV or JSON)
connectorType str Null if writing to internal console, else FEATURE_GROUP | FILE_CONNECTOR | DATABASE_CONNECTOR
legacyInputLocation str The location of the input data
error str Relevant error if the status is FAILED
driftMonitorError str Error message for the drift monitor of this batch predcition
monitorWarnings str Relevant warning if there are issues found in drift or data integrity
csvInputPrefix str A prefix to prepend to the input columns, only applies when output format is CSV
csvPredictionPrefix str A prefix to prepend to the prediction columns, only applies when output format is CSV
csvExplanationsPrefix str A prefix to prepend to the explanation columns, only applies when output format is CSV
databaseOutputTotalWrites int The total number of rows attempted to write (may be less than total_predictions if write mode is UPSERT and multiple rows share the same ID)
databaseOutputFailedWrites int The number of failed writes to the Database Connector
outputIncludesMetadata bool If true, output will contain columns including prediction start time, batch prediction version, and model version
resultInputColumns List[str] If present, will limit result files or feature groups to only include columns present in this list
modelMonitorVersion str The version of the model monitor
algoName str The name of the algorithm used to train the model
algorithm str The algorithm that is currently deployed.
outputFeatureGroupId str The Batch Prediction output feature group ID if applicable
outputFeatureGroupVersion str The Batch Prediction output feature group version if applicable
outputFeatureGroupTableName str The Batch Prediction output feature group name if applicable
batchPredictionWarnings str Relevant warnings if any issues are found
bpAcrossVersionsMonitorVersion str The version of the batch prediction across versions monitor
batchPredictionArgsType str The type of the batch prediction args
batchInputs PredictionInput Inputs to the batch prediction
KEY TYPE Description
featureGroupDatasetIds list The list of dataset IDs to use as input
datasetIdRemap dict Replacement datasets to swap as prediction input
featureGroups PredictionFeatureGroup List of prediction feature groups
KEY TYPE Description
featureGroupId str The unique identifier of the feature group
featureGroupVersion str The unique identifier of the feature group version used for predictions
datasetType str dataset type
default bool If true, this feature group is the default feature group in the model
required bool If true, this feature group is required for the batch prediction
datasets PredictionDataset List of prediction datasets
KEY TYPE Description
datasetId str The unique identifier of the dataset
datasetType str dataset type
datasetVersion str The unique identifier of the dataset version used for predictions
default bool If true, this dataset is the default dataset in the model
required bool If true, this dataset is required for the batch prediction
inputFeatureGroups PredictionFeatureGroup List of prediction feature groups
KEY TYPE Description
featureGroupId str The unique identifier of the feature group
featureGroupVersion str The unique identifier of the feature group version used for predictions
datasetType str dataset type
default bool If true, this feature group is the default feature group in the model
required bool If true, this feature group is required for the batch prediction
globalPredictionArgs BatchPredictionArgs None
KEY TYPE Description
problemType None None
kwargs None None
SupportKwargs None None
batchPredictionArgs BatchPredictionArgs Argument(s) passed to every prediction call
KEY TYPE Description
problemType None None
kwargs None None
SupportKwargs None None
refreshSchedules RefreshSchedule List of refresh schedules that dictate the next time the batch prediction will be run.
KEY TYPE Description
refreshPolicyId str The unique identifier of the refresh policy
nextRunTime str The next run time of the refresh policy. If null, the policy is paused.
cron str A cron-style string that describes the when this refresh policy is to be executed in UTC
refreshType str The type of refresh that will be run
error str An error message for the last pipeline run of a policy
inputFeatureGroups PredictionFeatureGroup List of prediction feature groups.
KEY TYPE Description
featureGroupId str The unique identifier of the feature group
featureGroupVersion str The unique identifier of the feature group version used for predictions
datasetType str dataset type
default bool If true, this feature group is the default feature group in the model
required bool If true, this feature group is required for the batch prediction
globalPredictionArgs BatchPredictionArgs None
KEY TYPE Description
problemType None None
kwargs None None
SupportKwargs None None
batchPredictionArgs BatchPredictionArgs Argument(s) passed to every prediction call.
KEY TYPE Description
problemType None None
kwargs None None
SupportKwargs None None

Exceptions:

TYPE WHEN
DataNotFoundError

deploymentId is not found.
DataNotFoundError

databaseConnectorId is not found.
InvalidEnumParameterError

An invalid value is passed for outputFormat.
ConflictError

A file already exists at the specified output location.
Language:

© Copyright