Versions Compared

Key

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

...

Info

If you have trouble in configuring our AI Review Assistant, we are happy to help! 🎉

More on JSON Query Language (JQL)

AI Review Assistant uses a custom JSON Query Language (JQL) to extract text information from JSON formatted responses.

A JQL query is a text snippet, describing a path from the root of a JSON document to a single text field.

Format

A JQL query is made of selections joined with a period (.). For example a.b.c is a path made of three selections (a, b, and c). Selections are evaluated from left to right, and each describes how to extract a nested value from a JSON document. For a JQL query to be valid, the final selection must extract a String value.

Each selection can be one of two kinds, a field selection or an array selection.

Field Selection

A field selection extracts a field of a JSON object. For example message requires the current JSON object to have a field message (e.g. {"message":<value>}) and extracts the associated value.

Array Selection

An array selection combines field selection with indexing. For example content[0] requires the current JSON object to have a field content associated with an array, (e.g. {"content":[<values>...]} ) and tries to extract the element of the array at index 0.