Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: remove hard line breaks

...

The public API primarily exposes the 'fetch' API and 'evalMetrics' API of the full C3 AI Suite. Generally speaking,
for  for Types in the Datalake, the Public API allows you to 'fetch' instances of the exposed types. Some of these types
also 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 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 as part of the covid-19 Public datalake 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 that aren't explicitly mentioned in the covid-19 Public datalake documentation
      are 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 for a given type. This function cannot be called through the Public API.

...

  • Unavailable Properties
    • In some cases, Type properties are not available through the Public API. For example, when evaluating timeseries information, the
      the 'earliest' and 'latest' properties associated with that timeseries's header information is not accessible.