Author: Drew Shea, Created: 2025-09-07
Xperiflow Jobs Documentation
Xperiflow Version: 4.0.2 Generated: 2025-09-06 20:41:10 UTC
This document provides comprehensive documentation for all registered jobs in the Xperiflow system.
Table of Contents
- AutoAssign
- AutoGenerateBlocks
- BackgroundCheckpoint
- CleanupPipeline
- CleanupPrediction
- DataSourceSnapshot
- DataSourceUpdate
- Deploy
- EventLocationUpload
- EventPackageUpload
- EventTargetDimensionUpload
- EventTargetUpload
- EventUpload
- FeatureDataLoad
- FeatureDataValidation
- FeatureEffectExport
- FeatureImpactExport
- FeaturePipeline
- FrequencyResample
- ImportGeneratorPackages
- IndexRebuild
- LocationUpload
- ModelForecastBacktestExport
- ModelForecastExport
- ModelForecastV1Export
- ModelRebuild
- ModelingPipeline
- Pipeline
- Prediction
- PredictionExplanationsBacktestExport
- PredictionExplanationsExport
- ProjectCopy
- ProjectCreation
- ProjectDatabaseUpgrade
- ProjectDeletion
- Restore
- RoutineExecution
- RunNSeconds
- ScenarioExcelCreation
- TargetDataLoad
- TargetDataValidation
- TimeSeriesCompetition
- TracerTracker
1. AutoAssign
Description
Automatically assign events to targets based on geographic location resolution for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- AutoAssignTaskStorageContext Example using AutoAssignTaskStorageContext
{
"task_storage": {
"buildinfo_id": 8737
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"AutoAssignTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
}
},
"required": [
"buildinfo_id"
],
"title": "AutoAssignTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/AutoAssignTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "AutoAssignMetadataContext",
"type": "object"
}
2. AutoGenerateBlocks
Description
Auto generate blocks of given types of generators based on build information for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
No examples could be generated for this job.
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"AutoGenerateBlocksStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
},
"generator_typenames": {
"items": {
"type": "string"
},
"title": "Generator Typenames",
"type": "array"
}
},
"required": [
"buildinfo_id",
"generator_typenames"
],
"title": "AutoGenerateBlocksStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/AutoGenerateBlocksStorageContext"
}
},
"required": [
"task_storage"
],
"title": "AutoGenerateBlocksMetadataContext",
"type": "object"
}
3. BackgroundCheckpoint
Description
Create a data checkpoint that can be used to restore the state of an application to a previous point in time.
Session Type
framework
Parameters (Communication Metadata Context)
Example Payloads
- CheckpointTaskStorageContext Example using CheckpointTaskStorageContext
{
"task_storage": {
"checkpoint_name": "GBtEiQtPVpZkIVfQudKs",
"n_seconds": null
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"CheckpointTaskStorageContext": {
"properties": {
"checkpoint_name": {
"title": "Checkpoint Name",
"type": "string"
},
"n_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "N Seconds"
}
},
"required": [
"checkpoint_name"
],
"title": "CheckpointTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/CheckpointTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "CheckpointMetadataContext",
"type": "object"
}
4. CleanupPipeline
Description
Cleanup and delete old data from prior SensibleAI Forecast pipeline runs.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- CleanupPipelineMetadataContext Example using CleanupPipelineMetadataContext
{}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"properties": {},
"title": "CleanupPipelineMetadataContext",
"type": "object"
}
5. CleanupPrediction
Description
Cleanup and delete old data from prior SensibleAI Forecast prediction runs.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- CleanupPredictionMetadataContext Example using CleanupPredictionMetadataContext
{}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"properties": {},
"title": "CleanupPredictionMetadataContext",
"type": "object"
}
6. DataSourceSnapshot
Description
Create a snapshot of metadata and statistics for feature and target data sources within a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- DataSourceSnapshotTaskStorageContext Example using DataSourceSnapshotTaskStorageContext
{
"task_storage": {
"datasource_name": "GBtEiQtPVpZkIVfQudKs"
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"DataSourceSnapshotTaskStorageContext": {
"properties": {
"datasource_name": {
"title": "Datasource Name",
"type": "string"
}
},
"required": [
"datasource_name"
],
"title": "DataSourceSnapshotTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/DataSourceSnapshotTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "DataSourceSnapshotMetadataContext",
"type": "object"
}
7. DataSourceUpdate
Description
Update the configuration of a target or feature data source within a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- DataSourceUpdateOrchestratorTaskStorageContext Example using DataSourceUpdateOrchestratorTaskStorageContext
{
"task_storage": {
"datasource_update_config": {
"update_type": {
"tabular_connection": {
"database_resource": "GBtEiQtPVpZkIVfQudKs",
"database_schema": "uPPIRExXPqJVxnkdBGEc",
"tables": [
"vHGJHkoxVPqPFwPCOCHS"
]
}
}
}
}
}
- SMLDataSourceUpdate Example using SMLDataSourceUpdate
{
"task_storage": {
"datasource_update_config": {
"update_type": {
"tabular_connection": {
"database_resource": "GBtEiQtPVpZkIVfQudKs",
"database_schema": "uPPIRExXPqJVxnkdBGEc",
"tables": [
"vHGJHkoxVPqPFwPCOCHS"
]
}
}
}
}
}
- FeatureDataSourceUpdate Example using FeatureDataSourceUpdate
{
"task_storage": {
"datasource_update_config": {
"update_type": {
"datasource_name": "GBtEiQtPVpZkIVfQudKs",
"tabular_connection": {
"file_paths": [
"uPPIRExXPqJVxnkdBGEc"
]
}
}
}
}
}
- SqlServerDataSource Example using SqlServerDataSource
{
"task_storage": {
"datasource_update_config": {
"update_type": {
"tabular_connection": {
"database_resource": "GBtEiQtPVpZkIVfQudKs",
"database_schema": "uPPIRExXPqJVxnkdBGEc",
"tables": [
"vHGJHkoxVPqPFwPCOCHS"
]
}
}
}
}
}
- FileDataSource Example using FileDataSource
{
"task_storage": {
"datasource_update_config": {
"update_type": {
"tabular_connection": {
"file_paths": [
"GBtEiQtPVpZkIVfQudKs"
]
}
}
}
}
}
- TargetDataSourceUpdate Example using TargetDataSourceUpdate
{
"task_storage": {
"datasource_update_config": {
"update_type": {
"tabular_connection": {
"file_paths": [
"GBtEiQtPVpZkIVfQudKs"
]
}
}
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"DataSourceUpdateOrchestratorTaskStorageContext": {
"properties": {
"datasource_update_config": {
"$ref": "#/$defs/SMLDataSourceUpdate"
}
},
"required": [
"datasource_update_config"
],
"title": "DataSourceUpdateOrchestratorTaskStorageContext",
"type": "object"
},
"FeatureDataSourceUpdate": {
"properties": {
"datasource_name": {
"description": "The feature dataset we are updating.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FeatureDataSourceUpdate.get_feature_datasource_names",
"options_callback_kwargs": null,
"state_name": "datasource_select",
"title": "Source Data Name",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"tabular_connection": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerDataSource"
},
{
"$ref": "#/$defs/FileDataSource"
}
],
"description": "The connection type to use to access the source data.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": null,
"options_callback_kwargs": null,
"state_name": "source_connection",
"title": "Source Data Connection Type",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime."
}
},
"required": [
"datasource_name",
"tabular_connection"
],
"title": "FeatureDataSourceUpdate",
"type": "object"
},
"FileDataSource": {
"properties": {
"file_paths": {
"description": "The full file path to the file to ingest.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": true
},
"items": {
"type": "string"
},
"long_description": null,
"minItems": 1,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:FileDataSource.get_file_path_bound_options",
"options_callback_kwargs": null,
"state_name": "file_path",
"title": "File Path",
"tooltip": "Validation Constraints:\nThe input must have a minimum length of 1.\n\nThis input may be subject to other validation constraints at runtime.",
"type": "array"
}
},
"required": [
"file_paths"
],
"title": "FileDataSource",
"type": "object"
},
"SMLDataSourceUpdate": {
"properties": {
"update_type": {
"anyOf": [
{
"$ref": "#/$defs/FeatureDataSourceUpdate"
},
{
"$ref": "#/$defs/TargetDataSourceUpdate"
}
],
"description": "The type of update to perform.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": null,
"options_callback_kwargs": null,
"state_name": "update_type",
"title": "Data Source Type",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime."
}
},
"required": [
"update_type"
],
"title": "SMLDataSourceUpdate",
"type": "object"
},
"SqlServerDataSource": {
"properties": {
"database_resource": {
"description": "The database resource to connect to, this is also known as the server name.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:SqlServerDataSource.get_database_resources",
"options_callback_kwargs": null,
"state_name": "database_resource",
"title": "Database Resource",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"database_schema": {
"description": "The database schema to connect to, this is also known as the database name.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:SqlServerDataSource.get_database_schemas",
"options_callback_kwargs": null,
"state_name": "database_schema",
"title": "Database Schema",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"tables": {
"description": "The table(s) from the database to connect to.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"items": {
"type": "string"
},
"long_description": null,
"minItems": 1,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:SqlServerDataSource.get_tables",
"options_callback_kwargs": null,
"state_name": "tables",
"title": "Tables",
"tooltip": "Validation Constraints:\nThe input must have a minimum length of 1.\n\nThis input may be subject to other validation constraints at runtime.",
"type": "array"
}
},
"required": [
"database_resource",
"database_schema",
"tables"
],
"title": "SqlServerDataSource",
"type": "object"
},
"TargetDataSourceUpdate": {
"properties": {
"tabular_connection": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerDataSource"
},
{
"$ref": "#/$defs/FileDataSource"
}
],
"description": "The connection type to use to access the source data.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": null,
"options_callback_kwargs": null,
"state_name": "source_connection",
"title": "Source Data Connection Type",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime."
}
},
"required": [
"tabular_connection"
],
"title": "TargetDataSourceUpdate",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/DataSourceUpdateOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "DataSourceUpdateOrchestratorMetadataContext",
"type": "object"
}
8. Deploy
Description
Deploy time series forecasting models into 'production' and calculate relevant deployment statistics for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- DeployOrchestratorTaskStorageContext Example using DeployOrchestratorTaskStorageContext
{
"task_storage": {
"buildinfo_id": 8737
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"DeployOrchestratorTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
}
},
"required": [
"buildinfo_id"
],
"title": "DeployOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/DeployOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "DeployOrchestratorMetadataContext",
"type": "object"
}
9. EventLocationUpload
Description
Create event-to-location assignments via a database or file upload for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- EventLocationMapperUploadTaskStorageContext Example using EventLocationMapperUploadTaskStorageContext
{
"task_storage": {
"file_string": "GBtEiQtPVpZkIVfQudKs",
"buildinfo_id": 6612
}
}
- SqlServerTableConnectionContext Example using SqlServerTableConnectionContext
{
"database_storage": {
"database_resource": "GBtEiQtPVpZkIVfQudKs",
"database_schema": "uPPIRExXPqJVxnkdBGEc",
"retrieval": {
"tables": [
"vHGJHkoxVPqPFwPCOCHS"
]
}
}
}
- TableRetrievalContext Example using TableRetrievalContext
{
"database_storage": {
"retrieval": {
"tables": [
"GBtEiQtPVpZkIVfQudKs"
]
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"EventLocationMapperUploadTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
},
"file_string": {
"title": "File String",
"type": "string"
}
},
"required": [
"file_string",
"buildinfo_id"
],
"title": "EventLocationMapperUploadTaskStorageContext",
"type": "object"
},
"SqlServerTableConnectionContext": {
"properties": {
"database_resource": {
"title": "Database Resource",
"type": "string"
},
"database_schema": {
"title": "Database Schema",
"type": "string"
},
"retrieval": {
"$ref": "#/$defs/TableRetrievalContext"
}
},
"required": [
"database_resource",
"database_schema",
"retrieval"
],
"title": "SqlServerTableConnectionContext",
"type": "object"
},
"TableRetrievalContext": {
"properties": {
"tables": {
"items": {
"type": "string"
},
"title": "Tables",
"type": "array"
}
},
"required": [
"tables"
],
"title": "TableRetrievalContext",
"type": "object"
}
},
"properties": {
"database_storage": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerTableConnectionContext"
},
{
"type": "null"
}
],
"default": null
},
"task_storage": {
"anyOf": [
{
"$ref": "#/$defs/EventLocationMapperUploadTaskStorageContext"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "EventLocationMapperUploadMetadataContext",
"type": "object"
}
10. EventPackageUpload
Description
Create event packages via a database or file data upload for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- EventPackageMapperUploadTaskStorageContext Example using EventPackageMapperUploadTaskStorageContext
{
"task_storage": {
"file_string": "GBtEiQtPVpZkIVfQudKs"
}
}
- SqlServerTableConnectionContext Example using SqlServerTableConnectionContext
{
"database_storage": {
"database_resource": "uPPIRExXPqJVxnkdBGEc",
"database_schema": "vHGJHkoxVPqPFwPCOCHS",
"retrieval": {
"tables": [
"lYBBOczMxUPzNLsDDndg"
]
}
}
}
- TableRetrievalContext Example using TableRetrievalContext
{
"database_storage": {
"retrieval": {
"tables": [
"diQjXRTCwFTWwMiGsdsJ"
]
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"EventPackageMapperUploadTaskStorageContext": {
"properties": {
"file_string": {
"title": "File String",
"type": "string"
}
},
"required": [
"file_string"
],
"title": "EventPackageMapperUploadTaskStorageContext",
"type": "object"
},
"SqlServerTableConnectionContext": {
"properties": {
"database_resource": {
"title": "Database Resource",
"type": "string"
},
"database_schema": {
"title": "Database Schema",
"type": "string"
},
"retrieval": {
"$ref": "#/$defs/TableRetrievalContext"
}
},
"required": [
"database_resource",
"database_schema",
"retrieval"
],
"title": "SqlServerTableConnectionContext",
"type": "object"
},
"TableRetrievalContext": {
"properties": {
"tables": {
"items": {
"type": "string"
},
"title": "Tables",
"type": "array"
}
},
"required": [
"tables"
],
"title": "TableRetrievalContext",
"type": "object"
}
},
"properties": {
"database_storage": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerTableConnectionContext"
},
{
"type": "null"
}
],
"default": null
},
"task_storage": {
"anyOf": [
{
"$ref": "#/$defs/EventPackageMapperUploadTaskStorageContext"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "EventPackageMapperUploadMetadataContext",
"type": "object"
}
11. EventTargetDimensionUpload
Description
Create event-to-target assignments via a database or file data upload based on target dimensions for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- EventTargetDimensionMapperUploadTaskStorageContext Example using EventTargetDimensionMapperUploadTaskStorageContext
{
"task_storage": {
"file_string": "GBtEiQtPVpZkIVfQudKs",
"buildinfo_id": 6612
}
}
- SqlServerTableConnectionContext Example using SqlServerTableConnectionContext
{
"database_storage": {
"database_resource": "uMqasgmiSJVFFPCHYYOd",
"database_schema": "YUcakfkMZDaWrDlcYLpU",
"retrieval": {
"tables": [
"FjBjIMKEYbBCIWMPHnKX"
]
}
}
}
- TableRetrievalContext Example using TableRetrievalContext
{
"database_storage": {
"retrieval": {
"tables": [
"UqewCnchsLVcoYcxtkIH"
]
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"EventTargetDimensionMapperUploadTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
},
"file_string": {
"title": "File String",
"type": "string"
}
},
"required": [
"file_string",
"buildinfo_id"
],
"title": "EventTargetDimensionMapperUploadTaskStorageContext",
"type": "object"
},
"SqlServerTableConnectionContext": {
"properties": {
"database_resource": {
"title": "Database Resource",
"type": "string"
},
"database_schema": {
"title": "Database Schema",
"type": "string"
},
"retrieval": {
"$ref": "#/$defs/TableRetrievalContext"
}
},
"required": [
"database_resource",
"database_schema",
"retrieval"
],
"title": "SqlServerTableConnectionContext",
"type": "object"
},
"TableRetrievalContext": {
"properties": {
"tables": {
"items": {
"type": "string"
},
"title": "Tables",
"type": "array"
}
},
"required": [
"tables"
],
"title": "TableRetrievalContext",
"type": "object"
}
},
"properties": {
"database_storage": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerTableConnectionContext"
},
{
"type": "null"
}
],
"default": null
},
"task_storage": {
"anyOf": [
{
"$ref": "#/$defs/EventTargetDimensionMapperUploadTaskStorageContext"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "EventTargetDimensionMapperUploadMetadataContext",
"type": "object"
}
12. EventTargetUpload
Description
Create event-to-target assignments via a database or file data upload based on target names for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- EventTargetMapperUploadTaskStorageContext Example using EventTargetMapperUploadTaskStorageContext
{
"task_storage": {
"file_string": "GBtEiQtPVpZkIVfQudKs",
"buildinfo_id": 6612
}
}
- SqlServerTableConnectionContext Example using SqlServerTableConnectionContext
{
"database_storage": {
"database_resource": "uMqasgmiSJVFFPCHYYOd",
"database_schema": "YUcakfkMZDaWrDlcYLpU",
"retrieval": {
"tables": [
"FjBjIMKEYbBCIWMPHnKX"
]
}
}
}
- TableRetrievalContext Example using TableRetrievalContext
{
"database_storage": {
"retrieval": {
"tables": [
"UqewCnchsLVcoYcxtkIH"
]
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"EventTargetMapperUploadTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
},
"file_string": {
"title": "File String",
"type": "string"
}
},
"required": [
"file_string",
"buildinfo_id"
],
"title": "EventTargetMapperUploadTaskStorageContext",
"type": "object"
},
"SqlServerTableConnectionContext": {
"properties": {
"database_resource": {
"title": "Database Resource",
"type": "string"
},
"database_schema": {
"title": "Database Schema",
"type": "string"
},
"retrieval": {
"$ref": "#/$defs/TableRetrievalContext"
}
},
"required": [
"database_resource",
"database_schema",
"retrieval"
],
"title": "SqlServerTableConnectionContext",
"type": "object"
},
"TableRetrievalContext": {
"properties": {
"tables": {
"items": {
"type": "string"
},
"title": "Tables",
"type": "array"
}
},
"required": [
"tables"
],
"title": "TableRetrievalContext",
"type": "object"
}
},
"properties": {
"database_storage": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerTableConnectionContext"
},
{
"type": "null"
}
],
"default": null
},
"task_storage": {
"anyOf": [
{
"$ref": "#/$defs/EventTargetMapperUploadTaskStorageContext"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "EventTargetMapperUploadMetadataContext",
"type": "object"
}
13. EventUpload
Description
Create events and event occurrences via a database or file data upload for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- EventUploadTaskStorageContext Example using EventUploadTaskStorageContext
{
"task_storage": {
"file_string": "GBtEiQtPVpZkIVfQudKs",
"buildinfo_id": 6612
}
}
- SqlServerTableConnectionContext Example using SqlServerTableConnectionContext
{
"database_storage": {
"database_resource": "uMqasgmiSJVFFPCHYYOd",
"database_schema": "YUcakfkMZDaWrDlcYLpU",
"retrieval": {
"tables": [
"FjBjIMKEYbBCIWMPHnKX"
]
}
}
}
- TableRetrievalContext Example using TableRetrievalContext
{
"database_storage": {
"retrieval": {
"tables": [
"UqewCnchsLVcoYcxtkIH"
]
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"EventUploadTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
},
"file_string": {
"title": "File String",
"type": "string"
}
},
"required": [
"file_string",
"buildinfo_id"
],
"title": "EventUploadTaskStorageContext",
"type": "object"
},
"SqlServerTableConnectionContext": {
"properties": {
"database_resource": {
"title": "Database Resource",
"type": "string"
},
"database_schema": {
"title": "Database Schema",
"type": "string"
},
"retrieval": {
"$ref": "#/$defs/TableRetrievalContext"
}
},
"required": [
"database_resource",
"database_schema",
"retrieval"
],
"title": "SqlServerTableConnectionContext",
"type": "object"
},
"TableRetrievalContext": {
"properties": {
"tables": {
"items": {
"type": "string"
},
"title": "Tables",
"type": "array"
}
},
"required": [
"tables"
],
"title": "TableRetrievalContext",
"type": "object"
}
},
"properties": {
"database_storage": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerTableConnectionContext"
},
{
"type": "null"
}
],
"default": null
},
"task_storage": {
"anyOf": [
{
"$ref": "#/$defs/EventUploadTaskStorageContext"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "EventUploadMetadataContext",
"type": "object"
}
14. FeatureDataLoad
Description
Load source feature data for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- SourceFeatureDataLoadOrchestratorTaskStorageContext Example using SourceFeatureDataLoadOrchestratorTaskStorageContext
{
"task_storage": {
"buildinfo_id": 8737
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"SourceFeatureDataLoadOrchestratorTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
}
},
"required": [
"buildinfo_id"
],
"title": "SourceFeatureDataLoadOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/SourceFeatureDataLoadOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "SourceFeatureDataLoadOrchestratorMetadataContext",
"type": "object"
}
15. FeatureDataValidation
Description
Validate the structure and metadata of a feature data source within a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- FeatureDataSourceValidationCommitTaskStorageContext Example using FeatureDataSourceValidationCommitTaskStorageContext
{
"task_storage": {
"buildinfo_id": 8737,
"datasource_config": {
"datasource_name": "KDMOrHsZuKNSswHUAIUu",
"tabular_connection": {
"file_paths": [
"MqasgmiSJVFFPCHYYOdY"
]
},
"intersection_dimensions": [
"UcakfkMZDaWrDlcYLpUF"
],
"date": "jBjIMKEYbBCIWMPHnKXU",
"value": "qewCnchsLVcoYcxtkIHn",
"location": "lhuwnlZrGPXWWLGGcCjw",
"hierarchy_groupings": [
"NXqusVUEYtGoMuKxaeWz"
]
}
}
}
- FORDataSourceFeatureCommit Example using FORDataSourceFeatureCommit
{
"task_storage": {
"datasource_config": {
"datasource_name": "GBtEiQtPVpZkIVfQudKs",
"tabular_connection": {
"file_paths": [
"uPPIRExXPqJVxnkdBGEc"
]
},
"intersection_dimensions": [
"vHGJHkoxVPqPFwPCOCHS"
],
"date": "lYBBOczMxUPzNLsDDndg",
"value": "diQjXRTCwFTWwMiGsdsJ",
"location": "FLjzFCiKRukNGviyKqbF",
"hierarchy_groupings": [
"HpXCOTlpwtHhQNmQeKrR"
]
}
}
}
- SqlServerDataSource Example using SqlServerDataSource
{
"task_storage": {
"datasource_config": {
"tabular_connection": {
"database_resource": "oBEuhSAtHfmcPlBWEfSX",
"database_schema": "AEHHzahYVHFWMbPiNHKP",
"tables": [
"xPJNbwPfiLVGSikeCVEm"
]
}
}
}
}
- FileDataSource Example using FileDataSource
{
"task_storage": {
"datasource_config": {
"tabular_connection": {
"file_paths": [
"VdlOrCykdSIsEbWJXdCf"
]
}
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"FORDataSourceFeatureCommit": {
"description": "An SML DataSource ParameterBaseModel. Applies to Feature source data creation.\nThis replaces SqlServerConnectionContext, previously used within SML.\n\nPreviously we had a SqlServerConnectionContext, which was a subclass of ISqlServerConnectionContext, this defined\n - database_resource\n - database_schema\n - retrieval: TableRetrievalContext\n - tables: List[str]\nTo be replaced by the new tabular_connection parameter.\n\nThe behavior around metadata (selected columns for date, target dims, location) are to now be handled as part of this component workflow step\nPreviously this was handled by TimeSeriesDataFormContext which was provided in addition to the SqlServerConnectionContext to a job.\nThis defined\n - intersection_dimensions: List[str]\n - date: str\n - value: str\n - location: Optional[str] = None",
"properties": {
"datasource_name": {
"description": "A name used to identify the data source.",
"field_type": "input",
"input_component": {
"component_type": "textbox",
"height": null,
"multiline": false
},
"long_description": null,
"options_callback": null,
"options_callback_kwargs": null,
"state_name": "source_connection_name",
"title": "Data Source Name",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"date": {
"description": "The date column.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FORDataSourceFeatureCommit.get_column_names",
"options_callback_kwargs": null,
"state_name": "dim_config",
"title": "Date Column",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"hierarchy_groupings": {
"description": "The optional hierarchies to apply to the data.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"items": {
"type": "string"
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FORDataSourceFeatureCommit.get_hierarchies",
"options_callback_kwargs": null,
"state_name": "hierarchies",
"title": "Hierarchies",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "array"
},
"intersection_dimensions": {
"description": "The target intersection dimensions.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"items": {
"type": "string"
},
"long_description": null,
"minItems": 1,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FORDataSourceFeatureCommit.get_column_names",
"options_callback_kwargs": null,
"state_name": "dim_config",
"title": "Intersection Dimensions",
"tooltip": "Validation Constraints:\nThe input must have a minimum length of 1.\n\nThis input may be subject to other validation constraints at runtime.",
"type": "array"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The optional location column.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FORDataSourceFeatureCommit.get_column_names",
"options_callback_kwargs": null,
"state_name": "dim_config",
"title": "Location Column",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime."
},
"tabular_connection": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerDataSource"
},
{
"$ref": "#/$defs/FileDataSource"
}
],
"description": "The connection type to use to access the source data.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": null,
"options_callback_kwargs": null,
"state_name": "source_connection",
"title": "Source Data Connection Type",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime."
},
"value": {
"description": "The value column.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FORDataSourceFeatureCommit.get_column_names",
"options_callback_kwargs": null,
"state_name": "dim_config",
"title": "Value Column",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
}
},
"required": [
"datasource_name",
"tabular_connection",
"intersection_dimensions",
"date",
"value",
"location",
"hierarchy_groupings"
],
"title": "FORDataSourceFeatureCommit",
"type": "object"
},
"FeatureDataSourceValidationCommitTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
},
"datasource_config": {
"$ref": "#/$defs/FORDataSourceFeatureCommit"
}
},
"required": [
"buildinfo_id",
"datasource_config"
],
"title": "FeatureDataSourceValidationCommitTaskStorageContext",
"type": "object"
},
"FileDataSource": {
"properties": {
"file_paths": {
"description": "The full file path to the file to ingest.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": true
},
"items": {
"type": "string"
},
"long_description": null,
"minItems": 1,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:FileDataSource.get_file_path_bound_options",
"options_callback_kwargs": null,
"state_name": "file_path",
"title": "File Path",
"tooltip": "Validation Constraints:\nThe input must have a minimum length of 1.\n\nThis input may be subject to other validation constraints at runtime.",
"type": "array"
}
},
"required": [
"file_paths"
],
"title": "FileDataSource",
"type": "object"
},
"SqlServerDataSource": {
"properties": {
"database_resource": {
"description": "The database resource to connect to, this is also known as the server name.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:SqlServerDataSource.get_database_resources",
"options_callback_kwargs": null,
"state_name": "database_resource",
"title": "Database Resource",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"database_schema": {
"description": "The database schema to connect to, this is also known as the database name.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:SqlServerDataSource.get_database_schemas",
"options_callback_kwargs": null,
"state_name": "database_schema",
"title": "Database Schema",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"tables": {
"description": "The table(s) from the database to connect to.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"items": {
"type": "string"
},
"long_description": null,
"minItems": 1,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:SqlServerDataSource.get_tables",
"options_callback_kwargs": null,
"state_name": "tables",
"title": "Tables",
"tooltip": "Validation Constraints:\nThe input must have a minimum length of 1.\n\nThis input may be subject to other validation constraints at runtime.",
"type": "array"
}
},
"required": [
"database_resource",
"database_schema",
"tables"
],
"title": "SqlServerDataSource",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/FeatureDataSourceValidationCommitTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "FeatureDataSourceValidationCommitMetadataContext",
"type": "object"
}
16. FeatureEffectExport
Description
Export feature effect data to an external source.
Session Type
project
Parameters (Communication Metadata Context)
No examples could be generated for this job.
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"FeatureEffectExportAggregatorOrchestratorTaskStorageContext": {
"properties": {
"all_deployed": {
"default": false,
"title": "All Deployed",
"type": "boolean"
},
"buildinfo_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Buildinfo Id"
},
"consumption_id": {
"title": "Consumption Id",
"type": "integer"
},
"drop_original_output_table": {
"default": false,
"title": "Drop Original Output Table",
"type": "boolean"
}
},
"required": [
"consumption_id"
],
"title": "FeatureEffectExportAggregatorOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/FeatureEffectExportAggregatorOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "FeatureEffectExportAggregatorOrchestratorMetadataContext",
"type": "object"
}
17. FeatureImpactExport
Description
Export feature impact data to an external source.
Session Type
project
Parameters (Communication Metadata Context)
No examples could be generated for this job.
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"FeatureImpactExportAggregatorOrchestratorTaskStorageContext": {
"properties": {
"all_deployed": {
"default": false,
"title": "All Deployed",
"type": "boolean"
},
"buildinfo_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Buildinfo Id"
},
"consumption_id": {
"title": "Consumption Id",
"type": "integer"
},
"drop_original_output_table": {
"default": false,
"title": "Drop Original Output Table",
"type": "boolean"
}
},
"required": [
"consumption_id"
],
"title": "FeatureImpactExportAggregatorOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/FeatureImpactExportAggregatorOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "FeatureImpactExportAggregatorOrchestratorMetadataContext",
"type": "object"
}
18. FeaturePipeline
Description
Run the automated feature engineering pipeline for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- FeaturePipelineOrchestratorTaskStorageContext Example using FeaturePipelineOrchestratorTaskStorageContext
{
"task_storage": {
"buildinfo_id": 8737
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"FeaturePipelineOrchestratorTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
}
},
"required": [
"buildinfo_id"
],
"title": "FeaturePipelineOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/FeaturePipelineOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "FeaturePipelineOrchestratorMetadataContext",
"type": "object"
}
19. FrequencyResample
Description
Resample the time granularity of provided data source.
Session Type
framework
Parameters (Communication Metadata Context)
Example Payloads
- FrequencyAlterationTaskStorageContext Example using FrequencyAlterationTaskStorageContext
{
"task_storage": {
"name": "GBtEiQtPVpZkIVfQudKs",
"origin_frequency": "uPPIRExXPqJVxnkdBGEc",
"target_frequency": "vHGJHkoxVPqPFwPCOCHS",
"datasource_connection_context": {
"database_resource": "lYBBOczMxUPzNLsDDndg",
"database_schema": "diQjXRTCwFTWwMiGsdsJ",
"retrieval": {
"tables": [
"FLjzFCiKRukNGviyKqbF"
]
}
},
"date_col": "HpXCOTlpwtHhQNmQeKrR",
"build_column_store_index": true,
"table_key_columns": null,
"aggregation_type": null
}
}
- SqlServerTableConnectionContext Example using SqlServerTableConnectionContext
{
"task_storage": {
"datasource_connection_context": {
"database_resource": "zQVZbXEkxIpzLsroYJIh",
"database_schema": "OIcDphyeTMzxLjkmlcGw",
"retrieval": {
"tables": [
"LvpqJsGOeapIkJfiHvEV"
]
}
}
}
}
- TableRetrievalContext Example using TableRetrievalContext
{
"task_storage": {
"datasource_connection_context": {
"retrieval": {
"tables": [
"UwJvSyMddHhotaQVmCWR"
]
}
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"FrequencyAlterationTaskStorageContext": {
"properties": {
"aggregation_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Aggregation Type"
},
"build_column_store_index": {
"title": "Build Column Store Index",
"type": "boolean"
},
"datasource_connection_context": {
"$ref": "#/$defs/SqlServerTableConnectionContext"
},
"date_col": {
"title": "Date Col",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"origin_frequency": {
"title": "Origin Frequency",
"type": "string"
},
"table_key_columns": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Table Key Columns"
},
"target_frequency": {
"title": "Target Frequency",
"type": "string"
}
},
"required": [
"name",
"origin_frequency",
"target_frequency",
"datasource_connection_context",
"date_col",
"build_column_store_index"
],
"title": "FrequencyAlterationTaskStorageContext",
"type": "object"
},
"SqlServerTableConnectionContext": {
"properties": {
"database_resource": {
"title": "Database Resource",
"type": "string"
},
"database_schema": {
"title": "Database Schema",
"type": "string"
},
"retrieval": {
"$ref": "#/$defs/TableRetrievalContext"
}
},
"required": [
"database_resource",
"database_schema",
"retrieval"
],
"title": "SqlServerTableConnectionContext",
"type": "object"
},
"TableRetrievalContext": {
"properties": {
"tables": {
"items": {
"type": "string"
},
"title": "Tables",
"type": "array"
}
},
"required": [
"tables"
],
"title": "TableRetrievalContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/FrequencyAlterationTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "FrequencyAlterationMetadataContext",
"type": "object"
}
20. ImportGeneratorPackages
Description
Import feature (generator) packages.
Session Type
framework
Parameters (Communication Metadata Context)
Example Payloads
- DefaultPackagesUploadMetadataContext Example using DefaultPackagesUploadMetadataContext
{}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"properties": {},
"title": "DefaultPackagesUploadMetadataContext",
"type": "object"
}
21. IndexRebuild
Description
Rebuild indices on a given database.
Session Type
framework
Parameters (Communication Metadata Context)
Example Payloads
- IndexRebuildTaskStorageContext Example using IndexRebuildTaskStorageContext
{
"task_storage": {
"database_schema": "GBtEiQtPVpZkIVfQudKs",
"database_resource": "uPPIRExXPqJVxnkdBGEc",
"table_size": null,
"rebuild_level": null,
"reorganize_level": null
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"IndexRebuildTaskStorageContext": {
"properties": {
"database_resource": {
"title": "Database Resource",
"type": "string"
},
"database_schema": {
"title": "Database Schema",
"type": "string"
},
"rebuild_level": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Rebuild Level"
},
"reorganize_level": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Reorganize Level"
},
"table_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Table Size"
}
},
"required": [
"database_schema",
"database_resource"
],
"title": "IndexRebuildTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/IndexRebuildTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "IndexRebuildMetadataContext",
"type": "object"
}
22. LocationUpload
Description
Create locations via a database or file data upload for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- LocationUploadTaskStorageContext Example using LocationUploadTaskStorageContext
{
"task_storage": {
"file_string": "GBtEiQtPVpZkIVfQudKs"
}
}
- SqlServerTableConnectionContext Example using SqlServerTableConnectionContext
{
"database_storage": {
"database_resource": "uPPIRExXPqJVxnkdBGEc",
"database_schema": "vHGJHkoxVPqPFwPCOCHS",
"retrieval": {
"tables": [
"lYBBOczMxUPzNLsDDndg"
]
}
}
}
- TableRetrievalContext Example using TableRetrievalContext
{
"database_storage": {
"retrieval": {
"tables": [
"diQjXRTCwFTWwMiGsdsJ"
]
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"LocationUploadTaskStorageContext": {
"properties": {
"file_string": {
"title": "File String",
"type": "string"
}
},
"required": [
"file_string"
],
"title": "LocationUploadTaskStorageContext",
"type": "object"
},
"SqlServerTableConnectionContext": {
"properties": {
"database_resource": {
"title": "Database Resource",
"type": "string"
},
"database_schema": {
"title": "Database Schema",
"type": "string"
},
"retrieval": {
"$ref": "#/$defs/TableRetrievalContext"
}
},
"required": [
"database_resource",
"database_schema",
"retrieval"
],
"title": "SqlServerTableConnectionContext",
"type": "object"
},
"TableRetrievalContext": {
"properties": {
"tables": {
"items": {
"type": "string"
},
"title": "Tables",
"type": "array"
}
},
"required": [
"tables"
],
"title": "TableRetrievalContext",
"type": "object"
}
},
"properties": {
"database_storage": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerTableConnectionContext"
},
{
"type": "null"
}
],
"default": null
},
"task_storage": {
"anyOf": [
{
"$ref": "#/$defs/LocationUploadTaskStorageContext"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "LocationUploadMetadataContext",
"type": "object"
}
23. ModelForecastBacktestExport
Description
Export backtest prediction data to an external source.
Session Type
project
Parameters (Communication Metadata Context)
No examples could be generated for this job.
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"ModelForecastBacktestExportAggregatorOrchestratorTaskStorageContext": {
"properties": {
"all_deployed": {
"default": false,
"title": "All Deployed",
"type": "boolean"
},
"buildinfo_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Buildinfo Id"
},
"consumption_id": {
"title": "Consumption Id",
"type": "integer"
},
"drop_original_output_table": {
"default": false,
"title": "Drop Original Output Table",
"type": "boolean"
}
},
"required": [
"consumption_id"
],
"title": "ModelForecastBacktestExportAggregatorOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/ModelForecastBacktestExportAggregatorOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "ModelForecastBacktestExportAggregatorOrchestratorMetadataContext",
"type": "object"
}
24. ModelForecastExport
Description
Export deployed prediction data to an external source.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- ModelForecastExportAggregatorOrchestratorTaskStorageContext Example using ModelForecastExportAggregatorOrchestratorTaskStorageContext
{
"task_storage": {
"consumption_id": 8737,
"drop_original_output_table": false
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"ModelForecastExportAggregatorOrchestratorTaskStorageContext": {
"properties": {
"consumption_id": {
"title": "Consumption Id",
"type": "integer"
},
"drop_original_output_table": {
"default": false,
"title": "Drop Original Output Table",
"type": "boolean"
}
},
"required": [
"consumption_id"
],
"title": "ModelForecastExportAggregatorOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/ModelForecastExportAggregatorOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "ModelForecastExportAggregatorOrchestratorMetadataContext",
"type": "object"
}
25. ModelForecastV1Export
Description
Export deployed prediction data to an external source.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- ModelForecastV1ExportAggregatorOrchestratorTaskStorageContext Example using ModelForecastV1ExportAggregatorOrchestratorTaskStorageContext
{
"task_storage": {
"consumption_id": 8737,
"drop_original_output_table": false
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"ModelForecastV1ExportAggregatorOrchestratorTaskStorageContext": {
"properties": {
"consumption_id": {
"title": "Consumption Id",
"type": "integer"
},
"drop_original_output_table": {
"default": false,
"title": "Drop Original Output Table",
"type": "boolean"
}
},
"required": [
"consumption_id"
],
"title": "ModelForecastV1ExportAggregatorOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/ModelForecastV1ExportAggregatorOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "ModelForecastV1ExportAggregatorOrchestratorMetadataContext",
"type": "object"
}
26. ModelRebuild
Description
Rebuild the configurations, engineered features, and models for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- ModelRebuildOrchestratorTaskStorageContext Example using ModelRebuildOrchestratorTaskStorageContext
{
"task_storage": {
"buildinfo_id": 8737
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"ModelRebuildOrchestratorTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
}
},
"required": [
"buildinfo_id"
],
"title": "ModelRebuildOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/ModelRebuildOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "ModelRebuildOrchestratorMetadataContext",
"type": "object"
}
27. ModelingPipeline
Description
Run the automated modeling pipeline for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- ModelingPipelineOrchestratorTaskStorageContext Example using ModelingPipelineOrchestratorTaskStorageContext
{
"task_storage": {
"buildinfo_id": 8737
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"ModelingPipelineOrchestratorTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
}
},
"required": [
"buildinfo_id"
],
"title": "ModelingPipelineOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/ModelingPipelineOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "ModelingPipelineOrchestratorMetadataContext",
"type": "object"
}
28. Pipeline
Description
Run the automated pipeline (both feature engineering and modeling) for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- PipelineOrchestratorTaskStorageContext Example using PipelineOrchestratorTaskStorageContext
{
"task_storage": {
"buildinfo_id": 8737
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"PipelineOrchestratorTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
}
},
"required": [
"buildinfo_id"
],
"title": "PipelineOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/PipelineOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "PipelineOrchestratorMetadataContext",
"type": "object"
}
29. Prediction
Description
Run a forecast for all targets and all deployed models for a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- PredictionClusterOrchestratorTaskStorageContext Example using PredictionClusterOrchestratorTaskStorageContext
{
"task_storage": {
"include_soft_retrain": null,
"forecast_name": null,
"scenario_id": null
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"PredictionClusterOrchestratorTaskStorageContext": {
"properties": {
"forecast_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Forecast Name"
},
"include_soft_retrain": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Include Soft Retrain"
},
"scenario_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Scenario Id"
}
},
"title": "PredictionClusterOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/PredictionClusterOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "PredictionClusterOrchestratorMetadataContext",
"type": "object"
}
30. PredictionExplanationsBacktestExport
Description
Export backtest prediction explanation data to an external source.
Session Type
project
Parameters (Communication Metadata Context)
No examples could be generated for this job.
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"PredictionExplanationsBacktestExportAggregatorOrchestratorTaskStorageContext": {
"properties": {
"all_deployed": {
"default": false,
"title": "All Deployed",
"type": "boolean"
},
"buildinfo_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Buildinfo Id"
},
"consumption_id": {
"title": "Consumption Id",
"type": "integer"
},
"drop_original_output_table": {
"default": false,
"title": "Drop Original Output Table",
"type": "boolean"
}
},
"required": [
"consumption_id"
],
"title": "PredictionExplanationsBacktestExportAggregatorOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/PredictionExplanationsBacktestExportAggregatorOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "PredictionExplanationsBacktestExportAggregatorOrchestratorMetadataContext",
"type": "object"
}
31. PredictionExplanationsExport
Description
Export deployed prediction explanation data to an external source.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- PredictionExplanationsExportAggregatorOrchestratorTaskStorageContext Example using PredictionExplanationsExportAggregatorOrchestratorTaskStorageContext
{
"task_storage": {
"consumption_id": 8737,
"drop_original_output_table": false
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"PredictionExplanationsExportAggregatorOrchestratorTaskStorageContext": {
"properties": {
"consumption_id": {
"title": "Consumption Id",
"type": "integer"
},
"drop_original_output_table": {
"default": false,
"title": "Drop Original Output Table",
"type": "boolean"
}
},
"required": [
"consumption_id"
],
"title": "PredictionExplanationsExportAggregatorOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/PredictionExplanationsExportAggregatorOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "PredictionExplanationsExportAggregatorOrchestratorMetadataContext",
"type": "object"
}
32. ProjectCopy
Description
Create a copy of a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- ProjectCopyTaskStorageContext Example using ProjectCopyTaskStorageContext
{
"task_storage": {
"new_project_name": null,
"new_project_id": null
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"ProjectCopyTaskStorageContext": {
"properties": {
"new_project_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "New Project Id"
},
"new_project_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "New Project Name"
}
},
"title": "ProjectCopyTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/ProjectCopyTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "ProjectCopyMetadataContext",
"type": "object"
}
33. ProjectCreation
Description
Create a new SensibleAI Forecast project.
Session Type
framework
Parameters (Communication Metadata Context)
Example Payloads
- ProjectCreationTaskStorageContext Example using ProjectCreationTaskStorageContext
{
"task_storage": {
"project_name": "GBtEiQtPVpZkIVfQudKs",
"description": "uPPIRExXPqJVxnkdBGEc",
"application": "vHGJHkoxVPqPFwPCOCHS",
"ptype": "regression",
"ttype": "timeseries",
"vtype": "unsupervised",
"viewer_identity_ids": [
3500
],
"editor_identity_ids": null,
"manager_identity_ids": null
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"PType_": {
"description": "The Problem Type.\nAttributes:\n CLASSIFICATION (str): Denotes a classification ML problem.\n REGRESSION (str): Denotes a regression ML problem.\n ALL (Tuple[str]): Signifies both of the above options.",
"enum": [
"classification",
"regression"
],
"title": "PType_",
"type": "string"
},
"ProjectCreationTaskStorageContext": {
"properties": {
"application": {
"title": "Application",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"editor_identity_ids": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Editor Identity Ids"
},
"manager_identity_ids": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Manager Identity Ids"
},
"project_name": {
"title": "Project Name",
"type": "string"
},
"ptype": {
"$ref": "#/$defs/PType_"
},
"ttype": {
"$ref": "#/$defs/TType_"
},
"viewer_identity_ids": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Viewer Identity Ids"
},
"vtype": {
"$ref": "#/$defs/VType_"
}
},
"required": [
"project_name",
"description",
"application",
"ptype",
"ttype",
"vtype"
],
"title": "ProjectCreationTaskStorageContext",
"type": "object"
},
"TType_": {
"description": "The Time Type.\nAttributes:\n TIMESERIES (str): Signifies Time Series.\n NON_TIMESERIES (str): Signifies Non Time Series.\n ALL (Tuple[str]): Signifies both of the above options.",
"enum": [
"timeseries",
"non_timeseries"
],
"title": "TType_",
"type": "string"
},
"VType_": {
"description": "The Vised Type.\nAttributes:\n SUPERVISED (str): Denotes supervised learning.\n UNSUPERVISED (str): Denotes unsupervised learning.\n SEMISUPERVISED (str): Denotes semi-supervised learning.\n ALL (Tuple[str]): Signifies all attributes above.",
"enum": [
"supervised",
"unsupervised",
"semisupervised"
],
"title": "VType_",
"type": "string"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/ProjectCreationTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "ProjectCreationMetadataContext",
"type": "object"
}
34. ProjectDatabaseUpgrade
Description
Upgrade a SensibleAI Forecast project to a new version.
Session Type
framework
Parameters (Communication Metadata Context)
Example Payloads
- UpgradeProjectDatabaseOrchestratorTaskStorageContext Example using UpgradeProjectDatabaseOrchestratorTaskStorageContext
{
"task_storage": {
"version_start": "GBtEiQtPVpZkIVfQudKs",
"version_end": "uPPIRExXPqJVxnkdBGEc"
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"UpgradeProjectDatabaseOrchestratorTaskStorageContext": {
"properties": {
"version_end": {
"title": "Version End",
"type": "string"
},
"version_start": {
"title": "Version Start",
"type": "string"
}
},
"required": [
"version_start",
"version_end"
],
"title": "UpgradeProjectDatabaseOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/UpgradeProjectDatabaseOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "UpgradeProjectDatabaseOrchestratorMetadataContext",
"type": "object"
}
35. ProjectDeletion
Description
Delete a SensibleAI Forecast project.
Session Type
framework
Parameters (Communication Metadata Context)
Example Payloads
- ProjectDeletionMetadataContext Example using ProjectDeletionMetadataContext
{}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"properties": {},
"title": "ProjectDeletionMetadataContext",
"type": "object"
}
36. Restore
Description
Restore a SensibleAI Forecast project to a prior checkpoint.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- RestartJobTaskStorageContext Example using RestartJobTaskStorageContext
{
"task_storage": {
"checkpoint_task_id": 8737
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"RestartJobTaskStorageContext": {
"properties": {
"checkpoint_task_id": {
"title": "Checkpoint Task Id",
"type": "integer"
}
},
"required": [
"checkpoint_task_id"
],
"title": "RestartJobTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/RestartJobTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "RestartJobMetadataContext",
"type": "object"
}
37. RoutineExecution
Description
Execute a Routine. Note is it not recommended to run this job directly, but rather execute through Routine services.
Session Type
framework
Parameters (Communication Metadata Context)
Example Payloads
- RoutineExecutionTaskStorageContext Example using RoutineExecutionTaskStorageContext
{
"task_storage": {
"routine_instance_id": "GBtEiQtPVpZkIVfQudKs",
"routine_run_id": "uPPIRExXPqJVxnkdBGEc"
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"RoutineExecutionTaskStorageContext": {
"properties": {
"routine_instance_id": {
"title": "Routine Instance Id",
"type": "string"
},
"routine_run_id": {
"title": "Routine Run Id",
"type": "string"
}
},
"required": [
"routine_instance_id",
"routine_run_id"
],
"title": "RoutineExecutionTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/RoutineExecutionTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "RoutineExecutionMetadataContext",
"type": "object"
}
38. RunNSeconds
Description
A job that runs for a specified number of seconds.
Session Type
framework
Parameters (Communication Metadata Context)
Example Payloads
- RunNSecondsTaskStorageContext Example using RunNSecondsTaskStorageContext
{
"task_storage": {
"n_seconds": -74839.7835625582
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"RunNSecondsTaskStorageContext": {
"properties": {
"n_seconds": {
"title": "N Seconds",
"type": "number"
}
},
"required": [
"n_seconds"
],
"title": "RunNSecondsTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/RunNSecondsTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "RunNSecondsMetadataContext",
"type": "object"
}
39. ScenarioExcelCreation
Description
Create an excel file that can be used to fill out scenario features of a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- ScenarioExcelCreationTaskStorageContext Example using ScenarioExcelCreationTaskStorageContext
{
"task_storage": {
"scenario_id": 8737,
"fill_with_forecasted_data": false,
"hashkeys": null
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"ScenarioExcelCreationTaskStorageContext": {
"properties": {
"fill_with_forecasted_data": {
"default": true,
"title": "Fill With Forecasted Data",
"type": "boolean"
},
"hashkeys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"default": null,
"title": "Hashkeys"
},
"scenario_id": {
"title": "Scenario Id",
"type": "integer"
}
},
"required": [
"scenario_id"
],
"title": "ScenarioExcelCreationTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/ScenarioExcelCreationTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "ScenarioExcelCreationMetadataContext",
"type": "object"
}
40. TargetDataLoad
Description
Load source target data into the SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- TargetDataLoadOrchestratorTaskStorageContext Example using TargetDataLoadOrchestratorTaskStorageContext
{
"task_storage": {
"buildinfo_id": 8737
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"TargetDataLoadOrchestratorTaskStorageContext": {
"properties": {
"buildinfo_id": {
"title": "Buildinfo Id",
"type": "integer"
}
},
"required": [
"buildinfo_id"
],
"title": "TargetDataLoadOrchestratorTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/TargetDataLoadOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "TargetDataLoadOrchestratorMetadataContext",
"type": "object"
}
41. TargetDataValidation
Description
Validate the structure and metadata of the target data source within a SensibleAI Forecast project.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- TargetDataSourceValidationCommitTaskStorageContext Example using TargetDataSourceValidationCommitTaskStorageContext
{
"task_storage": {
"datasource_config": {
"tabular_connection": {
"file_paths": [
"GBtEiQtPVpZkIVfQudKs"
]
},
"intersection_dimensions": [
"uPPIRExXPqJVxnkdBGEc"
],
"date": "vHGJHkoxVPqPFwPCOCHS",
"value": "lYBBOczMxUPzNLsDDndg",
"location": "diQjXRTCwFTWwMiGsdsJ"
}
}
}
- FORDataSourceTargetCommit Example using FORDataSourceTargetCommit
{
"task_storage": {
"datasource_config": {
"tabular_connection": {
"file_paths": [
"GBtEiQtPVpZkIVfQudKs"
]
},
"intersection_dimensions": [
"uPPIRExXPqJVxnkdBGEc"
],
"date": "vHGJHkoxVPqPFwPCOCHS",
"value": "lYBBOczMxUPzNLsDDndg",
"location": "diQjXRTCwFTWwMiGsdsJ"
}
}
}
- SqlServerDataSource Example using SqlServerDataSource
{
"task_storage": {
"datasource_config": {
"tabular_connection": {
"database_resource": "FLjzFCiKRukNGviyKqbF",
"database_schema": "HpXCOTlpwtHhQNmQeKrR",
"tables": [
"oBEuhSAtHfmcPlBWEfSX"
]
}
}
}
}
- FileDataSource Example using FileDataSource
{
"task_storage": {
"datasource_config": {
"tabular_connection": {
"file_paths": [
"AEHHzahYVHFWMbPiNHKP"
]
}
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"FORDataSourceTargetCommit": {
"description": "A SensibleAI Forecast DataSource ParameterBaseModel. Applies to Target source data creation.\nThis replaces SqlServerConnectionContext, previously used within FOR.\n\nPreviously we had a SqlServerConnectionContext, which was a subclass of ISqlServerConnectionContext, this defined\n - database_resource\n - database_schema\n - retrieval: TableRetrievalContext\n - tables: List[str]\nTo be replaced by the new tabular_connection parameter.\n\nThe behavior around metadata (selected columns for date, target dims, location) are to now be handled as part of this component workflow step\nPreviously this was handled by TimeSeriesDataFormContext which was provided in addition to the SqlServerConnectionContext to a job.\nThis defined\n - intersection_dimensions: List[str]\n - date: str\n - value: str\n - location: Optional[str] = None",
"properties": {
"date": {
"description": "The date column.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FORDataSourceTargetCommit.get_column_names",
"options_callback_kwargs": null,
"state_name": "dim_config",
"title": "Date Column",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"intersection_dimensions": {
"description": "The target intersection dimensions.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"items": {
"type": "string"
},
"long_description": null,
"minItems": 1,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FORDataSourceTargetCommit.get_column_names",
"options_callback_kwargs": null,
"state_name": "dim_config",
"title": "Intersection Dimensions",
"tooltip": "Validation Constraints:\nThe input must have a minimum length of 1.\n\nThis input may be subject to other validation constraints at runtime.",
"type": "array"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The optional location column.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FORDataSourceTargetCommit.get_column_names",
"options_callback_kwargs": null,
"state_name": "dim_config",
"title": "Location Column",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime."
},
"tabular_connection": {
"anyOf": [
{
"$ref": "#/$defs/SqlServerDataSource"
},
{
"$ref": "#/$defs/FileDataSource"
}
],
"description": "The connection type to use to access the source data.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": null,
"options_callback_kwargs": null,
"state_name": "source_connection",
"title": "Source Data Connection Type",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime."
},
"value": {
"description": "The value column.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.jobs:FORDataSourceTargetCommit.get_column_names",
"options_callback_kwargs": null,
"state_name": "dim_config",
"title": "Value Column",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
}
},
"required": [
"tabular_connection",
"intersection_dimensions",
"date",
"value",
"location"
],
"title": "FORDataSourceTargetCommit",
"type": "object"
},
"FileDataSource": {
"properties": {
"file_paths": {
"description": "The full file path to the file to ingest.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": true
},
"items": {
"type": "string"
},
"long_description": null,
"minItems": 1,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:FileDataSource.get_file_path_bound_options",
"options_callback_kwargs": null,
"state_name": "file_path",
"title": "File Path",
"tooltip": "Validation Constraints:\nThe input must have a minimum length of 1.\n\nThis input may be subject to other validation constraints at runtime.",
"type": "array"
}
},
"required": [
"file_paths"
],
"title": "FileDataSource",
"type": "object"
},
"SqlServerDataSource": {
"properties": {
"database_resource": {
"description": "The database resource to connect to, this is also known as the server name.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:SqlServerDataSource.get_database_resources",
"options_callback_kwargs": null,
"state_name": "database_resource",
"title": "Database Resource",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"database_schema": {
"description": "The database schema to connect to, this is also known as the database name.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"long_description": null,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:SqlServerDataSource.get_database_schemas",
"options_callback_kwargs": null,
"state_name": "database_schema",
"title": "Database Schema",
"tooltip": "Validation Constraints:\nThis input may be subject to other validation constraints at runtime.",
"type": "string"
},
"tables": {
"description": "The table(s) from the database to connect to.",
"field_type": "input",
"input_component": {
"component_type": "combobox",
"show_search": false
},
"items": {
"type": "string"
},
"long_description": null,
"minItems": 1,
"options_callback": "xperiflow.source.managers.datasource.pbm.dataretriever:SqlServerDataSource.get_tables",
"options_callback_kwargs": null,
"state_name": "tables",
"title": "Tables",
"tooltip": "Validation Constraints:\nThe input must have a minimum length of 1.\n\nThis input may be subject to other validation constraints at runtime.",
"type": "array"
}
},
"required": [
"database_resource",
"database_schema",
"tables"
],
"title": "SqlServerDataSource",
"type": "object"
},
"TargetDataSourceValidationCommitTaskStorageContext": {
"properties": {
"datasource_config": {
"$ref": "#/$defs/FORDataSourceTargetCommit"
}
},
"required": [
"datasource_config"
],
"title": "TargetDataSourceValidationCommitTaskStorageContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/TargetDataSourceValidationCommitTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "TargetDataSourceValidationCommitMetadataContext",
"type": "object"
}
42. TimeSeriesCompetition
Description
Runs and compares different SensibleAI Forecast simulations against eachother.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- TimeSeriesCompetitionOrchestratorTaskStorageContext Example using TimeSeriesCompetitionOrchestratorTaskStorageContext
{
"task_storage": {
"competition_submission": {
"competition": {
"name": "GBtEiQtPVpZkIVfQudKs",
"description": "uPPIRExXPqJVxnkdBGEc",
"version": "vHGJHkoxVPqPFwPCOCHS",
"tracker": {
"name": "lYBBOczMxUPzNLsDDndg",
"description": "diQjXRTCwFTWwMiGsdsJ",
"tag": "FLjzFCiKRukNGviyKqbF",
"output_metadata": {},
"etl_name": "HpXCOTlpwtHhQNmQeKrR",
"etl_kwargs": null
}
},
"experiment": {
"name": "oBEuhSAtHfmcPlBWEfSX",
"description": "AEHHzahYVHFWMbPiNHKP",
"version": "xPJNbwPfiLVGSikeCVEm",
"tags": [
"VdlOrCykdSIsEbWJXdCf"
],
"user_defined_attributes": null
},
"experiment_submission": {
"experiment_name": "HuoDoJaSptNqNcNcNPGu",
"competition_name": "jzJjdjYHOilFeljbXBNf",
"trials": 5265,
"trial_name": "oZTtZbsEVlUbXuBYPaHJ",
"trial": 7111
}
}
}
}
- CompetitionSubmissionBundleContext Example using CompetitionSubmissionBundleContext
{
"task_storage": {
"competition_submission": {
"competition": {
"name": "GBtEiQtPVpZkIVfQudKs",
"description": "uPPIRExXPqJVxnkdBGEc",
"version": "vHGJHkoxVPqPFwPCOCHS",
"tracker": {
"name": "lYBBOczMxUPzNLsDDndg",
"description": "diQjXRTCwFTWwMiGsdsJ",
"tag": "FLjzFCiKRukNGviyKqbF",
"output_metadata": {},
"etl_name": "HpXCOTlpwtHhQNmQeKrR",
"etl_kwargs": null
}
},
"experiment": {
"name": "oBEuhSAtHfmcPlBWEfSX",
"description": "AEHHzahYVHFWMbPiNHKP",
"version": "xPJNbwPfiLVGSikeCVEm",
"tags": [
"VdlOrCykdSIsEbWJXdCf"
],
"user_defined_attributes": null
},
"experiment_submission": {
"experiment_name": "HuoDoJaSptNqNcNcNPGu",
"competition_name": "jzJjdjYHOilFeljbXBNf",
"trials": 5265,
"trial_name": "oZTtZbsEVlUbXuBYPaHJ",
"trial": 7111
}
}
}
}
- CompetitionDefinitionContext Example using CompetitionDefinitionContext
{
"task_storage": {
"competition_submission": {
"competition": {
"name": "GBtEiQtPVpZkIVfQudKs",
"description": "uPPIRExXPqJVxnkdBGEc",
"version": "vHGJHkoxVPqPFwPCOCHS",
"tracker": {
"name": "lYBBOczMxUPzNLsDDndg",
"description": "diQjXRTCwFTWwMiGsdsJ",
"tag": "FLjzFCiKRukNGviyKqbF",
"output_metadata": {},
"etl_name": "HpXCOTlpwtHhQNmQeKrR",
"etl_kwargs": null
}
}
}
}
}
- TrackerContext Example using TrackerContext
{
"task_storage": {
"competition_submission": {
"competition": {
"tracker": {
"name": "GBtEiQtPVpZkIVfQudKs",
"description": "uPPIRExXPqJVxnkdBGEc",
"tag": "vHGJHkoxVPqPFwPCOCHS",
"output_metadata": {},
"etl_name": "lYBBOczMxUPzNLsDDndg",
"etl_kwargs": null
}
}
}
}
}
- ITrackerOutputMetadataContext Example using ITrackerOutputMetadataContext
{
"task_storage": {
"competition_submission": {
"competition": {
"tracker": {
"output_metadata": {}
}
}
}
}
}
- ExperimentDefinitionContext Example using ExperimentDefinitionContext
{
"task_storage": {
"competition_submission": {
"experiment": {
"name": "GBtEiQtPVpZkIVfQudKs",
"description": "uPPIRExXPqJVxnkdBGEc",
"version": "vHGJHkoxVPqPFwPCOCHS",
"tags": [
"lYBBOczMxUPzNLsDDndg"
],
"user_defined_attributes": null
}
}
}
}
- ExperimentSubmissionTrialContext Example using ExperimentSubmissionTrialContext
{
"task_storage": {
"competition_submission": {
"experiment_submission": {
"experiment_name": "GBtEiQtPVpZkIVfQudKs",
"competition_name": "uPPIRExXPqJVxnkdBGEc",
"trials": 6675,
"trial_name": "YUcakfkMZDaWrDlcYLpU",
"trial": 2962
}
}
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"CompetitionDefinitionContext": {
"description": "Defines a competition.\n\nDefined By: Competition Admin\n\nAttributes:\n name: The name of the competition\n description: The description of the competition. This should a comprehensive breakdown.\n tracker: The tracker context of the competition. This is the tracker that will be used to track the competition.\n\nNotes:\n This should never be set by competitors. This is the standard definition context of a competition",
"properties": {
"description": {
"title": "Description",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"tracker": {
"$ref": "#/$defs/TrackerContext"
},
"version": {
"title": "Version",
"type": "string"
}
},
"required": [
"name",
"description",
"version",
"tracker"
],
"title": "CompetitionDefinitionContext",
"type": "object"
},
"CompetitionSubmissionBundleContext": {
"description": "Bundles together all the contexts for a competition submission.\n\nAttributes:\n competition: The competition context\n experiment: The experiment context\n experiment_submission: The experiment submission context",
"properties": {
"competition": {
"$ref": "#/$defs/CompetitionDefinitionContext"
},
"experiment": {
"$ref": "#/$defs/ExperimentDefinitionContext"
},
"experiment_submission": {
"$ref": "#/$defs/ExperimentSubmissionTrialContext"
}
},
"required": [
"competition",
"experiment",
"experiment_submission"
],
"title": "CompetitionSubmissionBundleContext",
"type": "object"
},
"ExperimentDefinitionContext": {
"description": "Defines an experiment of the Competition\n\nDefined By: Competitor\n\nAttributes:\n name: The name of the experiment. This should be a short, descriptive name of the experiment.\n description: The description of the experiment. This should a comprehensive breakdown describing what the experiment is and how it\n is different from other experiments.\n tags: The tags to be applied to the experiment. These are often attributes or one-off values that can further contextualize the experiment.\n user_defined_attributes: Other configuration attributes of the experiment. Note that this will be combined with more detailed configuration parameters\n more specific to the properties of the run. This is most commonly used to defined additional key-value metadata. Within Weights and\n Biases, this will be logged as part of the config for the run",
"properties": {
"description": {
"title": "Description",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"user_defined_attributes": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "User Defined Attributes"
},
"version": {
"title": "Version",
"type": "string"
}
},
"required": [
"name",
"description",
"version",
"tags"
],
"title": "ExperimentDefinitionContext",
"type": "object"
},
"ExperimentSubmissionTrialContext": {
"description": "Defines a trial of an experiment.\n\nDefined By: System\n\nAttributes:\n trial: The number of the round. This is the number of times the experiment has been run.",
"properties": {
"competition_name": {
"title": "Competition Name",
"type": "string"
},
"experiment_name": {
"title": "Experiment Name",
"type": "string"
},
"trial": {
"title": "Trial",
"type": "integer"
},
"trial_name": {
"title": "Trial Name",
"type": "string"
},
"trials": {
"title": "Trials",
"type": "integer"
}
},
"required": [
"experiment_name",
"competition_name",
"trials",
"trial_name",
"trial"
],
"title": "ExperimentSubmissionTrialContext",
"type": "object"
},
"ITrackerOutputMetadataContext": {
"additionalProperties": true,
"properties": {},
"title": "ITrackerOutputMetadataContext",
"type": "object"
},
"TimeSeriesCompetitionOrchestratorTaskStorageContext": {
"properties": {
"competition_submission": {
"$ref": "#/$defs/CompetitionSubmissionBundleContext"
}
},
"required": [
"competition_submission"
],
"title": "TimeSeriesCompetitionOrchestratorTaskStorageContext",
"type": "object"
},
"TrackerContext": {
"description": "This is a Tracker definition. This is used to define how to track data within XperiFlow and how to route to an external tracking system.\n\nAttributes:\n name: The name of the tracker\n description: The description of the tracker\n tag: A tag to help further qualify the tracker\n output_metadata: The output metadata of the tracker. This is used to define how to track data within XperiFlow and how to route to an external tracking system.\n etl_name: The name of the ETL that this tracker is associated with\n etl_kwargs: The kwargs to pass to the ETL\n\nSee Also:\n ITrackerOutputMetadataContext\n ExtractTransformLoaderContext\n IExtractTransformLoader",
"properties": {
"description": {
"title": "Description",
"type": "string"
},
"etl_kwargs": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Etl Kwargs"
},
"etl_name": {
"title": "Etl Name",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"output_metadata": {
"$ref": "#/$defs/ITrackerOutputMetadataContext"
},
"tag": {
"title": "Tag",
"type": "string"
}
},
"required": [
"name",
"description",
"tag",
"output_metadata",
"etl_name"
],
"title": "TrackerContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/TimeSeriesCompetitionOrchestratorTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "TimeSeriesCompetitionOrchestratorMetadataContext",
"type": "object"
}
43. TracerTracker
Description
Collects metrics of different SensibleAI Forecast simulations.
Session Type
project
Parameters (Communication Metadata Context)
Example Payloads
- TracerTrackerTaskStorageContext Example using TracerTrackerTaskStorageContext
{
"task_storage": {
"project_id": 8737,
"trackers": [
{
"name": "KDMOrHsZuKNSswHUAIUu",
"description": "MqasgmiSJVFFPCHYYOdY",
"tag": "UcakfkMZDaWrDlcYLpUF",
"output_metadata": {},
"etl_name": "jBjIMKEYbBCIWMPHnKXU",
"etl_kwargs": null
}
]
}
}
JSON Schema
The following JSON schema defines the parameters for this job:
{
"$defs": {
"ITrackerOutputMetadataContext": {
"additionalProperties": true,
"properties": {},
"title": "ITrackerOutputMetadataContext",
"type": "object"
},
"TracerTrackerTaskStorageContext": {
"properties": {
"project_id": {
"title": "Project Id",
"type": "integer"
},
"trackers": {
"items": {
"$ref": "#/$defs/TrackerContext"
},
"title": "Trackers",
"type": "array"
}
},
"required": [
"project_id",
"trackers"
],
"title": "TracerTrackerTaskStorageContext",
"type": "object"
},
"TrackerContext": {
"description": "This is a Tracker definition. This is used to define how to track data within XperiFlow and how to route to an external tracking system.\n\nAttributes:\n name: The name of the tracker\n description: The description of the tracker\n tag: A tag to help further qualify the tracker\n output_metadata: The output metadata of the tracker. This is used to define how to track data within XperiFlow and how to route to an external tracking system.\n etl_name: The name of the ETL that this tracker is associated with\n etl_kwargs: The kwargs to pass to the ETL\n\nSee Also:\n ITrackerOutputMetadataContext\n ExtractTransformLoaderContext\n IExtractTransformLoader",
"properties": {
"description": {
"title": "Description",
"type": "string"
},
"etl_kwargs": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Etl Kwargs"
},
"etl_name": {
"title": "Etl Name",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"output_metadata": {
"$ref": "#/$defs/ITrackerOutputMetadataContext"
},
"tag": {
"title": "Tag",
"type": "string"
}
},
"required": [
"name",
"description",
"tag",
"output_metadata",
"etl_name"
],
"title": "TrackerContext",
"type": "object"
}
},
"properties": {
"task_storage": {
"$ref": "#/$defs/TracerTrackerTaskStorageContext"
}
},
"required": [
"task_storage"
],
"title": "TracerTrackerMetadataContext",
"type": "object"
}
This documentation was automatically generated from the XperiFlow job registry.
Total jobs documented: 43 XperiFlow Version: 4.0.2