Function GetNlgInsights Beta

GetNlgInsights(props): ReactElement< any, any > | null

React component that fetches and displays a collapsible analysis of the provided query using natural language generation (NLG). Specifying a query is similar to providing parameters to a useExecuteQuery hook, using dimensions, measures, and filters.

Note

This component is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.

Parameters

Parameter	Type	Description
props	GetNlgInsightsProps	GetNlgInsightsProps

Returns

ReactElement< any, any > | null

Collapsible container wrapping a text summary

Example

<GetNlgInsights
  dataSource="Sample ECommerce"
  dimensions={[DM.Commerce.Date.Years]}
  measures={[measureFactory.sum(DM.Commerce.Revenue)]}
/>