Key Phrase Support in Interactive Reports

A Key Phrase is a supported natural language command that performs an action on an interactive report without needing to invoke AI processing. You can enter requests into an interactive report by using a number of supported Key Phrase patterns:

• filter column by value
• search column for value
• sort by column direction
• show column
• hide column
• pivot column by column
• break on column
• reset

Where:

• column is the name of an interactive report column available for display in the report
• value is a word or words to search for. If you are searching for more than one word, the phrase must be enclosed in double quotes e.g. “John Smith”
• direction is the sort direction:
  • ascending (or asc)
  • descending (or desc)

Key Phrases are not case-sensitive except for the value, which is generally case-sensitive in filter commands.

APEX supports some alternative key phrases:

• sort by alternatives:
  • sort
  • order by
  • order
• show alternative:
  • show column
• hide alternative:
  • hide column
• break on alternative:
  • break by
• reset alternatives:
  • reset report
  • clear
  • clear report

Examples of Key Phrase Use

These examples use an Interactive Report with available columns that include Status, Customer Name, Sale Date, Description, and Category Name.

Valid key phrases include:

• filter status by Completed
• filter status by “In Progress”
• search customer name for smith
• sort by sale date descending
• show description
• hide sale date
• pivot category name by status
• break on category name

You can enter key phrases in the search bar’s “Search or ask a question” field in any Interactive Report, even if Natural Language is not enabled. If the Interactive Report does have Natural Language enabled, then you can also enter key phrases in the Assistant panel.

If your input matches a Key Phrase and any columns you reference exist, then the action is performed locally by APEX without invoking an AI service. Otherwise, default processing continues, and APEX processes your input through row text search or with Natural Language.