SmartInsights (PQL)

Returns all or part of the AI-driven automated metric analysis of a query. Has an optional culture parameter to determine the output language.

  • Returned Output: Text
  • Library: PQL \ Dynamic \ Smart
  • Version: 2020.13.000
  • Compatibility: Any content (regardless of data source) in the relevant parts of the application

Syntax

SmartInsights( <Boolean> , <Flag Integer> , OPTIONAL <Text> )

* Click on the function's arguments above for more details on the input values.

Comments
<Boolean>

Use the boolean to choose between the light analysis (false) or the advanced analysis (true). Light is the default.

<Flag Integer>

The Flag integer allows for the extraction of specific sections from the analysis. If no flag is set, "ALL" analyses will be returned by default. To bring back combinations, add the integers together.

  • 0=ALL
  • 1=BASIC STATS
  • 2=PARETO
  • 4=RELATIONSHIP
  • 8=TREND
  • 16=OUTLIER
  • 32=FORECAST
  • 64=IMPACT_ANALYSIS
<Text>

Use the optional text field to specify the language for your output insights by locale code; for example, you may specify es-ES to produce insights in Spanish (Spain). You can only use those languages supported by the Pyramid app. If you specify an unsupported language, insights are returned in the default language.

The application supports the following languages:

  • English (en-US)
  • Spanish (es-ES)
  • German (de-DE)
  • French (fr-FR)
  • Dutch (nl-NL)
  • Italian (it-IT)
  • Russian (ru-RU)
  • Portuguese (Brazil) (pt-BR)
  • Japanese (ja-JP)
  • Simplified Chinese (zh-CNS)
  • Turkish (tr-TR)
  • Hebrew (he-IL)
  • Arabic (ar-SA)

Smart Insights

The Smart Insights function performs AI-driven automated analysis on a given data set. This includes both metric and categorical analysis. The types of analysis, structure of the data set, the types of data, and the cardinality of results dictate the analyses returned.

If the data set is not appropriate, the functions may produce no output.

Examples

The following example returns the advanced Smart Insights for a specific query, returning only the basic statistics section, with the advanced details:

SmartInsights(true, 1)

The following example returns the light Smart Insights for a specific query, returning both Pareto (2) and Trends (8) data. In this case, the Flag integer is the sum of the Pareto and Trends integers (2+8=10):

SmartInsights(false, 10)

The following example returns the advanced Smart Insights for a specific query (true), returning all sections (0), in Spanish (es-ES):

SmartInsights(true, 0, "es-ES")