sdk.algorithm_config.list()

Query a list of Algorithm Configs.

Retrieve the metadata for all Algorithm Configs that this user has access to and that match the provided search filters. By default, deactivated Algorithm Configs are not returned. Setting include_deactivated to true will also return any Algorithm Configs that had been deactivated.

Parameters

algorithm_id (str) - query Algorithm Configs for a certain Algorithm
algorithm_version_id (str) - query Algorithm Configs for a certain Algorithm Version
search_text (str) - search text to apply to Algorithm Config metadata
min_created_on (datetime) - filter for Algorithm Configs created after this date
max_created_on (datetime) - filter for Algorithm Configs created before this date
include_deactivated (bool) - flag to include deactivated Algorithm Configs
[Optional] pagination (Pagination) - Pagination object only with page size field set

Returns

List[AlgorithmConfig]

Example(s)

# List Algorithm Configs for a certain algorithm_version_id
await sdk.algorithm_config.list(
  algorithm_version_id="9e8abbd9-0675-49ff-81f2-2766d49cdedb"
)

# Output (List[AlgorithmConfig])
[{
    "algorithm": {
        "author": "[email protected]",
        "displayName": "Traffic",
        "id": "ddd8536b-d4b8-4fb7-8675-8f7e8d00cafc",
        "name": "traffic-ce76862f"
    },
    "algorithmVersion": {
        "createdOn": "2022-10-26T19:14:00.028115Z",
        "id": "9e8abbd9-0675-49ff-81f2-2766d49cdedb",
        "manifest": {
            "container_parameters": {
                "command": [
                    "python",
                    "/orbital/base/algorithms/raw_foottraffic/src/py/raw_foottraffic/simple_foottraffic.py"
                ],
                "image": "orbitalinsight/raw_foottraffic:ff1cf7c9",
                "resource_request": {
                    "cpu_millicore": 200.0,
                    "gpu": 0.0,
                    "memory_gb": 5.0
                }
            },
            "inputs": [
                {
                    "data_type_name": "pings",
                    "max_count": 1.0,
                    "min_count": 1.0
                }
            ],
            "interface": {
                "interface_type": "FILESYSTEM_TASK_WORKER"
            },
            "manifest_version": "0.1.0",
            "metadata": {
                "description": "Determine the unique device count per observation grouping",
                "tags": [
                    "foot_traffic",
                    "unique_device_count"
                ],
                "version": "0.0.5"
            },
            "outputs": {
                "observation_value_columns": [
                    "unique_device_count"
                ],
                "output_data_types": [
                    "unique_device_count"
                ]
            },
            "parameters": [
                {
                    "default": 0.0,
                    "description": "Minimum dwell time in minutes required for a ping to be included in unique device count. Default is 0 (i.e. all pings are included).",
                    "min": 0.0,
                    "name": "min_dwell_time",
                    "type": "integer",
                    "units": "minutes"
                },
                {
                    "default": 1440.0,
                    "description": "Maximum dwell time in minutes required for a ping to be included in unique device count. Default is None (i.e. all pings are included).",
                    "min": 1.0,
                    "name": "max_dwell_time",
                    "type": "integer",
                    "units": "minutes"
                }
            ]
        },
        "version": "0.0.5"
    },
    "config": {
        "data_sources": [
            {
                "data_source_ids": [
                    "exact-earth_pings"
                ],
                "data_type_name": "pings"
            }
        ],
        "grouping": {
            "frequency": "DAILY",
            "value": 1.0
        },
        "parameters": {
            "max_dwell_time": 1440.0,
            "min_dwell_time": 0.0
        }
    },
    "createdOn": "2022-10-28T16:34:07.825915Z",
    "id": "c057404a-f290-4652-b552-0fe555f0310d",
    "name": "Traffic"
},
...
]