sdk.analysis_version.get()
elements.sdk.api.analysis_version
Get Analysis Versions.
Get the details for a specific Analysis Version. By default it does not include the Analysis Manifest. Setting include_manifest to true, will also include the manifest in the response for each requested Analysis Version.
Parameters
- ids (List[str]) - list of Analysis Versions to get
- [Optional] include_manifest (bool) - flag to include Analysis Manifest, defaults to False
- [Optional] include_algorithm_details (bool) - flag to include Analysis Version details including metadata and manifest, defaults to False
- [Optional] pagination (Pagination) - Pagination object only with page size field set
Returns
List[AnalysisVersion]
Example(s)
Return analysis versions with no extra details:
# Get Analysis Versions
await sdk.analysis_version.get(ids=["f8aa14a2-35e7-484a-9804-1d05c23642d4"])
# Ouptut (List[AnalysisVersion])
[id: "f8aa14a2-35e7-484a-9804-1d05c23642d4"
analysis {
id: "40078e32-27ee-438e-87bf-87063482c7b4"
created_on {
}
}
created_on {
seconds: 1667405770
nanos: 738066000
}
]Return analysis versions with analysis manifests:
# Get Analysis Versions
await sdk.analysis_version.get(ids=["f8aa14a2-35e7-484a-9804-1d05c23642d4"],
include_manifest=True)
# Ouptut (List[AnalysisVersion])
[id: "f8aa14a2-35e7-484a-9804-1d05c23642d4"
analysis {
id: "40078e32-27ee-438e-87bf-87063482c7b4"
created_on {
}
}
analysis_manifest {
manifest_version: "0.1.0"
metadata {
description: "Test description for the greatest manifest in the world."
version: "0.0.1"
tags: "device-visits"
tags: "result-test"
}
algorithm_nodes {
name: "device-visits"
algorithm_version_id: "5ee03b8e-ab45-4553-b5f4-a5029254a9de"
children: "device-tracks"
}
algorithm_nodes {
name: "device-tracks"
algorithm_version_id: "6f7cff18-c2a2-4246-b0d4-21be09673a6b"
}
}
created_on {
seconds: 1667405770
nanos: 738066000
}
]Return analysis versions with analysis manifests and algorithm details:
# Get Analysis Versions
await sdk.analysis_version.get(ids=["f8aa14a2-35e7-484a-9804-1d05c23642d4"],
include_manifest=True, include_algorithm_details=True)
# Ouptut (List[AnalysisVersion])
[
{
"algorithmVersions": [
{
"algorithm": {
"author": "[email protected]",
"displayName": "Device Visits",
"id": "7691e490-5fb2-4e8d-9859-2006c6dd1b14",
"name": "device_visits-368af4d3"
},
"createdOn": "2022-10-26T19:14:03.884602Z",
"id": "5ee03b8e-ab45-4553-b5f4-a5029254a9de",
"manifest": {
"container_parameters": {
"command": [
"python",
"/orbital/base/algorithms/device_visits/src/py/device_visits/device_visits.py"
],
"image": "orbitalinsight/device_visits:ff1cf7c9",
"resource_request": {
"cpu_millicore": 200.0,
"gpu": 0.0,
"memory_gb": 10.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": "Produce a list of AOI visits per device, based on geolocation device pings.",
"tags": [
"device_visits"
],
"version": "0.0.5"
},
"outputs": {
"observation_value_columns": [
"device_visits"
],
"output_data_types": [
"device_visits"
]
},
"parameters": [
{
"default": 24.0,
"description": "Number of hours to look back before the first recorded ping for each device, to analyze device movements.",
"max": 720.0,
"min": 0.0,
"name": "look_back_time",
"type": "integer",
"units": "hours"
},
{
"default": 24.0,
"description": "Number of hours to look forward after the last recorded ping for each device, to analyze device movements.",
"max": 720.0,
"min": 0.0,
"name": "look_forward_time",
"type": "integer",
"units": "hours"
},
{
"default": false,
"description": "If enabled, set the look back and look forward timestamp to be equal to the start and end of the given observation for all devices.",
"name": "override_visit_time",
"type": "boolean"
}
]
},
"version": "0.0.5"
},
{
"algorithm": {
"author": "[email protected]",
"displayName": "Device Tracks",
"id": "902fbf64-da9d-4c3f-ab6b-b76035b4b35c",
"name": "device_tracks-3c0d44a5"
},
"createdOn": "2022-10-26T19:14:05.627593Z",
"id": "6f7cff18-c2a2-4246-b0d4-21be09673a6b",
"manifest": {
"container_parameters": {
"command": [],
"image": ""
},
"inputs": [
{
"data_type_name": "track_pings",
"max_count": 1.0,
"min_count": 1.0
}
],
"interface": {
"interface_type": "NO_OP_WORKER"
},
"manifest_version": "0.1.0",
"metadata": {
"description": "\n Transforms device visits into device tracks, which queries for all ping occurrences of the specified\n devices in a given time range. Includes a few properties of each ping, such as the distance travelled and\n whether the ping is inside the AOI.",
"tags": [
"device_tracks",
"track_pings"
],
"version": "1.0.4"
},
"outputs": {
"output_data_types": [
"device_tracks"
]
},
"parameters": [
{
"default": 0.0,
"description": "Pings with a reported positional uncertainty greater than this value will be filtered out of the track. If 0, then there is no filtering.",
"min": 0.0,
"name": "max_horizontal_uncertainty",
"type": "integer",
"units": "meters"
},
{
"default": null,
"description": "Velocity values are only computed if the time-interval between consecutive pings is less than this value. Default is None.",
"min": 0.0,
"name": "max_velocity_window",
"type": "integer",
"units": "seconds"
}
]
},
"version": "1.0.4"
}
],
"analysis": {
"createdOn": "1970-01-01T00:00:00Z",
"id": "40078e32-27ee-438e-87bf-87063482c7b4"
},
"analysisManifest": {
"algorithmNodes": [
{
"algorithmVersionId": "5ee03b8e-ab45-4553-b5f4-a5029254a9de",
"children": [
"device-tracks"
],
"name": "device-visits"
},
{
"algorithmVersionId": "6f7cff18-c2a2-4246-b0d4-21be09673a6b",
"name": "device-tracks"
}
],
"manifestVersion": "0.1.0",
"metadata": {
"description": "Test description for the greatest manifest in the world.",
"tags": [
"device-visits",
"result-test"
],
"version": "0.0.1"
}
},
"createdOn": "2022-11-02T16:16:10.738066Z",
"id": "f8aa14a2-35e7-484a-9804-1d05c23642d4"
}
]Updated 6 months ago