Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The public API primarily exposes the 'fetch' API and 'evalMetrics' API of the full C3 AI Suite. Generally speaking, for Types in the DatalakeC3 AI COVID-19 Data Lake, the Public API allows you to 'fetch' instances of the exposed types. Some of these types also have a few supported Metrics. For those types, you can also call the 'evalmetrics' API.

...

  • Exposed APIs
    • fetch - The fetch API can be called on Types in the Datalake Data Lake to return instances of these types (Available for all exposed C3 Types)
    • evalMetrics - The evalmetrics API can be called on some expressions which are defined on some outbreakLocations. These are detailed as part of the covidCOVID-19 Public datalake Data Lake documentation. (Available only for outbreakLocation)
    • Other available APIs (Please see the official C3 Public API documentation for more information about these)
      • getprojectionhistory
      • getarticlemetadata
      • getimageurls
      • allversionsforpolicy
  • Unavailable APIs
    • Any methods defined on the available types in the Datalake Data Lake that aren't explicitly mentioned in the covidCOVID-19 Public datalake Data Lake documentation are not available through the public API.
    • Example: the listMetrics() function is defined on Types inheriting MetricEvaluatable. This gives a list of available Metrics you can use for a given type. This function cannot be called through the Public API.

...