# Function useGetNlgQueryResult Beta
useGetNlgQueryResult(...
args
):UseGetNlgQueryResultState
React hook that fetches an 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 hook is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
# Parameters
Parameter | Type |
---|---|
...args | [UseGetNlgQueryResultParams ] |
# Returns
Response object containing a text summary
# Example
const { data, isLoading } = useGetNlgQueryResult({
dataSource: 'Sample ECommerce',
dimensions: [DM.Commerce.Date.Years],
measures: [measureFactory.sum(DM.Commerce.Revenue)],
});
if (isLoading) {
return <div>Loading...</div>;
}
return <p>{data}</p>;