Abacus.AI - BatchPrediction

Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference API Classes AbacusApi Address Agent AgentChatMessage AgentConversation AgentDataDocumentInfo AgentDataExecutionResult AgentVersion AiBuildingTask Algorithm Annotation AnnotationConfig AnnotationDocument AnnotationEntry AnnotationsStatus ApiEndpoint ApiKey AppUserGroup ApplicationConnector BatchPrediction BatchPredictionVersion BatchPredictionVersionLogs BotInfo CategoricalRangeViolation ChatMessage ChatSession ChatllmReferralInvite CodeAutocompleteResponse NlpChatResponse CodeEditResponse CodeSource ComputePointInfo ConcatenationConfig CustomChatInstructions CustomLossFunction CustomMetric CustomMetricVersion CustomTrainFunctionInfo DataConsistencyDuplication DataMetrics DataPrepLogs DataQualityResults DataUploadResult DatabaseColumnFeatureMapping DatabaseConnector DatabaseConnectorColumn DatabaseConnectorSchema Dataset DatasetColumn DatasetVersion DatasetVersionLogs Deployment DeploymentAuthToken DeploymentConversation DeploymentConversationEvent DeploymentConversationExport DeploymentStatistics DocumentData DocumentRetriever DocumentRetrieverConfig DocumentRetrieverLookupResult DocumentRetrieverVersion DriftDistribution DriftDistributions Eda EdaChartDescription EdaCollinearity EdaDataConsistency EdaFeatureAssociation EdaFeatureCollinearity EdaForecastingAnalysis EdaVersion EmbeddingFeatureDriftDistribution ExecuteFeatureGroupOperation ExternalApplication ExternalInvite ExtractedFields Feature FeatureDistribution FeatureDriftRecord FeatureDriftSummary FeatureGroup FeatureGroupDocument FeatureGroupExport FeatureGroupExportConfig FeatureGroupRefreshExportConfig FeatureGroupExportDownloadUrl IndexingConfig FeatureGroupLineage FeatureGroupRow FeatureGroupRowProcess FeatureGroupRowProcessLogs FeatureGroupRowProcessSummary FeatureGroupTemplate FeatureGroupTemplateVariableOptions FeatureGroupVersion FeatureGroupVersionLogs FeatureImportance FeatureMapping FeaturePerformanceAnalysis FeatureRecord Schema FileConnector FileConnectorInstructions FileConnectorVerification FinetunedPretrainedModel ForecastingAnalysisGraphData ForecastingMonitorItemAnalysis ForecastingMonitorSummary FunctionLogs GeneratedPitFeatureConfigOption GraphDashboard HoldoutAnalysis HoldoutAnalysisVersion HostedModelToken ImageGenSettings InferredDatabaseColumnToFeatureMappings InferredFeatureMappings ItemStatistics LlmApp LlmCodeBlock LlmExecutionPreview LlmExecutionResult LlmGeneratedCode LlmInput LlmParameters LlmResponse MemoryOptions CpuGpuMemorySpecs MessagingConnectorResponse Model ModelArtifactsExport ModelBlueprintExport ModelBlueprintStage ModelLocation ModelMetrics ModelMonitor ModelMonitorOrgSummary ModelMonitorSummary ModelMonitorSummaryFromOrg ModelMonitorVersion ModelMonitorVersionMetricData ModelTrainingTypeForDeployment ModelUpload ModelVersion ModelVersionFeatureGroupSchema ModificationLockInfo Module MonitorAlert MonitorAlertVersion MonitorDriftAndDistributions NaturalLanguageExplanation NestedFeature NestedFeatureSchema NewsSearchResult NotebookCompletion NotebookTemplate NullViolation OrganizationExternalApplicationSettings OrganizationGroup OrganizationSearchResult OrganizationSecret PageData Pipeline PipelineReference PipelineStep PipelineStepVersion PipelineStepVersionReference PipelineVersion PipelineVersionLogs PlaygroundText PointInTimeFeature PointInTimeFeatureInfo PointInTimeGroup PointInTimeGroupFeature PredictionDataset PredictionFeatureGroup PredictionInput PredictionLogRecord PredictionOperator PredictionOperatorVersion ProblemType Project ProjectConfig ProjectFeatureGroup ProjectFeatureGroupSchema ProjectValidation PythonFunction PythonPlotFunction RangeViolation RealtimeMonitor RefreshPipelineRun RefreshPolicy RefreshSchedule RegenerateLlmExternalApplication ResolvedFeatureGroupTemplate RoutingAction ProjectFeatureGroupSchemaVersion PipelineStepVersionLogs StreamingAuthToken StreamingConnector StreamingRowCount StreamingSampleCode TemplateNodeDetails TestPointPredictions ToneDetails TrainingConfigOptions TwitterSearchResult Upload UploadPart UseCase UseCaseRequirements User UserException VideoGenSettings VideoSearchResult WebSearchResponse WebSearchResult Webhook WorkflowNodeTemplate API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

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.
latestBatchPredictionVersion	BatchPredictionVersion	The latest batch prediction version.
refreshSchedules	RefreshSchedule	List of refresh schedules that dictate the next time the batch prediction will be run.
inputFeatureGroups	PredictionFeatureGroup	List of prediction feature groups.
globalPredictionArgs	BatchPredictionArgs	None
batchPredictionArgs	BatchPredictionArgs	Argument(s) passed to every prediction call.