sdk.algorithm.list()

Query a list of Algorithms.

Retrieve the metadata for all Algorithms that this user has access to and that match the provided search filters, if any.

Parameters

[Optional] search_text (str) - keywords to search for in the Algorithm name, display name, or author
[Optional] min_created_on (datetime) - filter for Algorithms created only after a certain time
[Optional] max_created_on (datetime) - filter for Algorithms created only before a certain time
[Optional] pagination (Pagination) - Pagination object only with page size field set

Returns

List[Algorithm]

Example(s)

# Returns algorithms with metadata that contain the search_text "traffic"
await sdk.algorithm.list(search_text="traffic")

# Output (List[Algorithm])
[id: "f9227741-6a67-4d33-80cc-dbfd036887f6"
name: "foottraffic-heatmap"
display_name: "Raw Foot Traffic Heatmap"
author: "Orbital Insight"
, id: "622eae55-f8f9-43bd-b9a7-19c5ee9b1c5d"
name: "foottraffic"
display_name: "Raw Foot Traffic"
author: "Orbital Insight"
]

# Returns algorithms created after 2022-01-01
await sdk.algorithm.list(min_created_on=datetime.datetime(2022, 1, 1))

# Output
[id: "711dd3c5-bfb1-49d4-a345-c5cdfb52789b"
name: "traffic-heatmap"
display_name: "Traffic Heatmap"
author: "author-vulcan-oi"
, id: "6a9c41bc-0daf-44b9-8ba6-0d5701c72721"
name: "awesome-algo"
display_name: "Awesome Algo"
author: "[email protected]"
]