import { Attribute, DataSource, Filter, FilterRelations, Measure } from '@sisense/sdk-data'; import type { NarrativeRequest } from '../../../infra/api/narrative/narrative-api-types.js'; /** * Parameters for {@link useGetNlgInsights} hook. */ export interface UseGetNlgInsightsParams { /** The data source that the query targets - e.g. `Sample ECommerce` */ dataSource: DataSource; /** Dimensions of the query */ dimensions?: Attribute[]; /** Measures of the query */ measures?: Measure[]; /** Filters of the query */ filters?: Filter[] | FilterRelations; /** * Boolean flag to enable/disable API call by default * * If not specified, the default value is `true` */ enabled?: boolean; /** The verbosity of the NLG summarization */ verbosity?: 'Low' | 'High'; /** * Free-text guidance for the narrative summary — context the model can't infer from the data * alone, e.g. `"amounts are in USD"` or `"ignore the March spike, known data issue"`. Forwarded * to the narrative endpoint. */ aiContext?: string; } /** * Parameters for building a narrative request (before JAQL payload expansion). * * @sisenseInternal */ export interface NarrativeQueryParams extends UseGetNlgInsightsParams { } /** @internal */ export declare function prepareNarrativeRequest(params: NarrativeQueryParams | NarrativeRequest): NarrativeRequest; /** * @deprecated Use {@link prepareNarrativeRequest}. Same function; kept for legacy `modules/ai` and framework wrappers. */ export declare const prepareGetNlgInsightsPayload: typeof prepareNarrativeRequest;