sdk.result.get()

elements.sdk.api.result

Get the Result(s) of an Algorithm Computation.

Retrieve the Result for the specified Algorithm Computations that match the specified filters.

Parameters

  • algorithm_computation_ids List[(str)] - Algorithm Computation IDs to get Result for
  • analysis_computation_ids List[(str)] - Analysis Computation IDs to get Result for - returns the Results for the Algorithm Computations of the Analysis
    • Either algorithm_computation_ids or analysis_computation_ids must be specified
  • [Optional] source_aoi_version (int) - AOI or source AOI Version to get Result for
  • [Optional] dest_aoi_version (int) - destination AOI Version to get Result for (only applicable for Cross-AOI)
  • [Optional] algo_config_class (str) - class of the Algorithm Config to query Result for (only applicable for multi-class algorithms)
  • [Optional] algo_config_subclass (str) - subclass of the Algorithm Config to query Result for (only applicable for multi-class algorithms with sub-class)
  • [Optional] created_on (TimeStamp) - filter for Result created on or after the timestamp
  • [Optional] observation_start_ts (Timestamp) - filter the Result for observations on or after the timestamp
  • [Optional] max_observation_start_ts (Timestamp) - filter the Result for observations before the timestamp
  • [Optional] result_status (ResultStatus) - filter Result for those of a certain status
  • [Optional] include_export_files (bool) - flag to include Result export files
  • [Optional] data_type (string) - data type to filter Result for

Returns

List[ResultGetResponse]

Example(s)

# Get a Result by Algorithm Computation ID
await sdk.result.get(
  algorithm_computation_ids=["1115760f-5b74-4b53-94aa-4e1b2df7a4ae"]
)

# Output List[ResultGetResponse]
[results {
  id: "3a7952b0-b1db-4524-b25a-6375f58f4e70"
  created_on {
    seconds: 1718869801
    nanos: 619672000
  }
  source_aoi_version: 36308173
  observations {
    id: "f59a801c-7bfc-44bc-807a-56750c2fe673"
    data_view_id: "b32d8a07-ada0-4b30-a6f3-f04e05883892"
    created_on {
      seconds: 1718869801
      nanos: 631352000
    }
    start_ts {
      seconds: 1667250000
    }
    value {
    }
    status: COMPLETE
    measurements {
      id: "a5490021-4c76-4dd6-995d-776b8661d2e5"
      dimensions {
        fields {
          key: "TIME_RANGE_GROUP"
          value {
            string_value: "2022-10-31T21:00:00"
          }
        }
        fields {
          key: "GEOHASH"
          value {
            list_value {
              values {
                string_value: "sw"
              }
            }
          }
        }
        fields {
          key: "AOI"
          value {
            list_value {
              values {
                string_value: "36308173"
              }
            }
          }
        }
      }
    }
    measurements {
      id: "57dbbb07-ea6c-4113-a0de-5a2ae521c6d5"
      dimensions {
        fields {
          key: "TIME_RANGE_GROUP"
          value {
            string_value: "2022-10-31T21:00:00"
          }
        }
        fields {
          key: "GEOHASH"
          value {
            list_value {
              values {
                string_value: "sx"
              }
            }
          }
        }
        fields {
          key: "AOI"
          value {
            list_value {
              values {
                string_value: "36308173"
              }
            }
          }
        }
      }
    }
    export_file {
    }
  }
  observations {
    id: "32b198cb-38cf-4a51-95e2-ebc5db46b872"
    data_view_id: "b32d8a07-ada0-4b30-a6f3-f04e05883892"
    created_on {
      seconds: 1718869801
      nanos: 640775000
    }
    start_ts {
      seconds: 1667336400
    }
    value {
    }
    status: COMPLETE
    measurements {
      id: "92a2eb15-3bd2-4633-91d4-2ff763a6dce5"
      dimensions {
        fields {
          key: "TIME_RANGE_GROUP"
          value {
            string_value: "2022-11-01T21:00:00"
          }
        }
        fields {
          key: "GEOHASH"
          value {
            list_value {
              values {
                string_value: "sx"
              }
            }
          }
        }
        fields {
          key: "AOI"
          value {
            list_value {
              values {
                string_value: "36308173"
              }
            }
          }
        }
      }
    }
    measurements {
      id: "2ea49ebf-5546-439d-b86a-ab8bc385f967"
      dimensions {
        fields {
          key: "TIME_RANGE_GROUP"
          value {
            string_value: "2022-11-01T21:00:00"
          }
        }
        fields {
          key: "GEOHASH"
          value {
            list_value {
              values {
                string_value: "sw"
              }
            }
          }
        }
        fields {
          key: "AOI"
          value {
            list_value {
              values {
                string_value: "36308173"
              }
            }
          }
        }
      }
    }
    export_file {
    }
  }
  data_type: "gnss_clusters"
  algorithm_computation_id: "1115760f-5b74-4b53-94aa-4e1b2df7a4ae"
}
export_credentials {
  credentials {
  }
}
]