sdk.algorithm_version.list()

Retrieve a list of Algorithm Versions.

List all the Algorithm Versions that the user has access to, subject to optional filters.

Parameters

[Optional] algorithm_id (str) - Algorithm ID for which to get versions for
[Optional] search_text (str) - applied to the entire manifest returning all Algorithm Versions whose manifest contains the search text
[Optional] tag (List[str]) - queried exactly for the tags on the manifest
[Optional] min_created_on (datetime) - for Algorithm Versions created only after a certain time
[Optional] max_created_on (datetime) - filter for Algorithm Versions created only before a certain time
[Optional] include_all_versions (bool) - flag to include all prior versions of an Algorithm including deprecated algorithm versions will be returned
[Optional] pagination (Pagination) - Pagination object only with page size field set

*By default, this method only returns the semantically latest version of each Algorithm that has not been deprecated, It does not include manifests in the response.

Returns

List[AlgorithmVersion]

Example(s)

# Get the latest version of a Algorithm
await sdk.algorithm_version.list(algorithm_id="6a9c41bc-0daf-44b9-8ba6-0d5701c72721")

# Get all versions of an Algorithm
await sdk.algorithm_version.list(algorithm_id="6a9c41bc-0daf-44b9-8ba6-0d5701c72721", include_all_versions=True)

# Paginated return - sets number of objects per page
await sdk.algorithm_version.list(pagination=Pagination(page_size=10))

# Output (List[AlgorithmVersion])
[
  {
    "algorithm": {
        "author": "[email protected]",
        "displayName": "Device Visits",
        "id": "7691e490-5fb2-4e8d-9859-2006c6dd1b14",
        "name": "device_visits-368af4d3"
    },
    "createdOn": "2022-10-11T00:39:53.154144Z",
    "id": "300fe5bd-3218-49dc-8544-357e68109fc1",
    "manifest": {
        "container_parameters": {
            "command": [
                "python",
                "/orbital/base/algorithms/device_visits/src/py/device_visits/device_visits.py"
            ],
            "image": "orbitalinsight/device_visits:13131a4e",
            "resource_request": {
                "gpu": 200.0
            }
        },
        "grouping": {
            "frequency": "DAILY",
            "value": 1.0
        },
        "inputs": [
            {
                "data_type_name": "pings"
            }
        ],
        "interface": {
            "interface_type": "FILESYSTEM_TASK_WORKER"
        },
        "metadata": {
            "description": "Produce a list of AOI visits per device based on geolocation device pings",
            "manifest_version": "0.1.0",
            "tags": [
                "device_visits",
                "geolocation"
            ],
            "version": "0.0.1"
        },
        "outputs": {
            "observation_value_columns": [
                "device_visits"
            ],
            "output_data_types": [
                "device_visits"
            ]
        },
        "parameters": [
            {
                "default": 3600.0,
                "description": "Number of seconds to look back before the first recorded ping for each device, to analyze device movements.",
                "max": 2592000.0,
                "min": 0.0,
                "name": "look_back_time",
                "type": "integer"
            },
            {
                "default": 3600.0,
                "description": "Number of seconds to look forward after the last recorded ping for each device, to analyze device movements.",
                "max": 2592000.0,
                "min": 0.0,
                "name": "look_forward_time",
                "type": "integer"
            }
        ],
        "performance_metrics": {},
        "restrictions": {}
    },
    "version": "0.0.1"
  }
]