Versions Compared

Key

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

Overview

The query API call returns a complex JSON object:

...

The key objects in the JSON are documents, and its sub-objects entities, associations (relationships between entities, or between an entity and free text), and source-specific metadata.

In addition to the query API call, these can also be accessed in other ways, eg via the knowledge/document/get API call, or via the Widget API.

The entities and associations are both sub-objects of the document object, but also "aggregation" objects in their own right. The differences are described here.

Info

Note that when the community GUI is used to save the results of a query, the saved JSON format is identical to the above, except with "documents" instead of "data".