@sisense/sdk-ui 1.5.0 → 1.6.0

package/dist/ai/ai-context-provider.d.ts

@@ -27,6 +27,7 @@ export type AiContextProviderProps = {
  *   );
  * }
  * ```
+ * @group Generative AI
  * @beta
  */
 export default function AiContextProvider({ children, config }: AiContextProviderProps): JSX.Element;

package/dist/ai/api/chat-rest-api.d.ts

@@ -1,5 +1,6 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import type { Chat, ChatRequest, ChatResponse, ChatWithoutHistory, DataModel, GetNlgQueryResultRequest, GetNlgQueryResultResponse, LlmConfig, Perspective, QueryRecommendationConfig, QueryRecommendationResponse, SendFeedbackRequest } from './types';
+import { DataSourceField } from '@sisense/sdk-query-client';
 export declare class ChatRestApi {
     private httpClient;
     constructor(httpClient: HttpClient);
@@ -14,11 +15,13 @@ export declare class ChatRestApi {
     private postChat;
     private deleteChatHistory;
     private sendFeedback;
+    private getDataSourceFields;
     ai: {
         getNlgQueryResult: (request: GetNlgQueryResultRequest) => Promise<GetNlgQueryResultResponse>;
         getQueryRecommendations: (contextTitle: string, config: QueryRecommendationConfig) => Promise<QueryRecommendationResponse>;
         setLlmConfig: (config: LlmConfig) => Promise<unknown>;
         sendFeedback: (request: SendFeedbackRequest) => Promise<unknown>;
+        getDataSourceFields: (dataSource: string) => Promise<DataSourceField[]>;
         chat: {
             getAll: () => Promise<ChatWithoutHistory[]>;
             getById: (chatId: string) => Promise<Chat>;

package/dist/ai/api/errors.d.ts

@@ -1 +1,2 @@
-export declare const UNKNOWN_ERROR = "Oh snap, something went wrong. Please try again later or try asking a different question.";
+export declare const UNEXPECTED_ERROR = "Oh snap, something went wrong. Please try again later.";
+export declare const UNEXPECTED_CHAT_RESPONSE_ERROR = "Oh snap, something went wrong. Please try again later or try asking a different question.";

package/dist/ai/api/types.d.ts

@@ -1,4 +1,4 @@
-import { MetadataItem } from '@sisense/sdk-query-client';
+import { JaqlQueryPayload, MetadataItem } from '@sisense/sdk-query-client';
 import { ChartDataOptions } from '../../types';
 export interface ChatContext {
     id: string;
@@ -61,7 +61,7 @@ export type AllPossibleChartOptionKeys = KeysOfUnion<ChartDataOptions>;
 export type AxesMappingKey = Exclude<AllPossibleChartOptionKeys, 'seriesToColorMap'>;
 export type AxesMapping = Partial<Record<AxesMappingKey, Array<{
     name: string;
-    type: string;
+    type?: string;
 }>>>;
 export interface ChartRecommendations {
     chartFamily: string;
@@ -103,14 +103,7 @@ export interface Perspective {
     isDefault: boolean;
 }
 export interface GetNlgQueryResultRequest {
-    jaql: {
-        /** The data source that the JAQL metadata targets - e.g. `Sample ECommerce` */
-        datasource: {
-            title: string;
-        };
-        /** The metadata that composes the JAQL to be analyzed */
-        metadata: object[];
-    };
+    jaql: Pick<JaqlQueryPayload, 'datasource' | 'metadata' | 'filterRelations'>;
 }
 export interface GetNlgQueryResultResponse {
     data?: {
@@ -124,4 +117,11 @@ export interface SendFeedbackRequest {
     sourceId: string;
     rating: -1 | 1;
 }
+/**
+ * The chat mode to use for a chat session
+ *
+ * analyze: Enable business users to uncover data insights
+ * develop: Enable developers to build queries and charts for embedded analytics
+ */
+export type ChatMode = 'analyze' | 'develop';
 export {};

package/dist/ai/chat-config.d.ts

@@ -1,9 +1,10 @@
 import { ReactNode } from 'react';
+import { ChatMode } from '../ai/api/types';
 export interface ChatConfig {
     /**
-     * Boolean flag to show or hide suggested questions following a chat response
-     *
-     * If not specified, the default value is `false`
+     * Boolean flag to show or hide suggested questions following a chat response. Currently
+     * follow-up questions are still under development and are not validated. Therefore, follow-up
+     * questions are disabled by default.
      */
     enableFollowupQuestions: boolean;
     /**
@@ -18,6 +19,12 @@ export interface ChatConfig {
      * If specified, the data topic selector screen will not be shown.
      */
     defaultContextTitle?: string;
+    /**
+     * The chat mode to use for a chat session.
+     *
+     * @internal
+     */
+    chatMode?: ChatMode;
 }
 export declare const DEFAULTS: Readonly<ChatConfig>;
 export type ChatConfigProviderProps = {

package/dist/ai/chat-intro-blurb.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+export default function ChatIntroBlurb(props: {
+    title: string;
+}): JSX.Element;

package/dist/ai/chatbot.d.ts

@@ -44,6 +44,7 @@ export type ChatbotProps = {
  * }
  * ```
  * @param props - {@link ChatbotProps}
+ * @group Generative AI
  * @beta
  */
 export declare const Chatbot: import("react").FunctionComponent<ChatbotProps>;

package/dist/ai/get-nlg-query-result.d.ts

@@ -6,9 +6,8 @@ import { UseGetNlgQueryResultParams } from './use-get-nlg-query-result';
 export interface GetNlgQueryResultProps extends Omit<UseGetNlgQueryResultParams, 'enabled'> {
 }
 /**
- * React component that fetches and displays a collapsible analysis of the provided JAQL using natural language generation (NLG).
- *
- * This takes the same props as {@link useGetNlgQueryResult} and makes the same API call but presents the result in a collapsible container.
+ * 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 {@link useExecuteQuery} hook, using dimensions, measures, and filters.
  *
  * ::: warning Note
  * This component is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
@@ -24,6 +23,7 @@ export interface GetNlgQueryResultProps extends Omit<UseGetNlgQueryResultParams,
  * ```
  * @param props - {@link GetNlgQueryResultProps}
  * @returns Collapsible container wrapping a text summary
+ * @group Generative AI
  * @beta
  */
 declare const _default: import("react").FunctionComponent<GetNlgQueryResultProps>;

package/dist/ai/index.d.ts

@@ -2,6 +2,8 @@ export { default as AiContextProvider, type AiContextProviderProps } from './ai-
 export { type ChatConfig } from './chat-config';
 export { useGetNlgQueryResult, type UseGetNlgQueryResultParams, type UseGetNlgQueryResultState, } from './use-get-nlg-query-result';
 export { useGetQueryRecommendations, type UseGetQueryRecommendationsParams, type UseGetQueryRecommendationsState, } from './use-get-query-recommendations';
+export { useChatSession, type UseChatSessionResult } from './use-chat-session';
 export type { GetNlgQueryResultRequest, QueryRecommendationResponse, QueryRecommendation, NlqResponseData, ChartRecommendations, AxesMapping, AxesMappingKey, AllPossibleChartOptionKeys, KeysOfUnion, } from './api/types';
 export { Chatbot, type ChatbotProps } from './chatbot';
 export { default as GetNlgQueryResult, type GetNlgQueryResultProps } from './get-nlg-query-result';
+export * from './translators';

package/dist/ai/messages/feedback-wrapper.d.ts

@@ -3,7 +3,8 @@ type FeedbackWrapperProps = {
     sourceId: string;
     data: object;
     type: string;
+    rightFooter?: ReactNode;
     children: ReactNode;
 };
-export default function FeedbackWrapper({ sourceId, data, type, children }: FeedbackWrapperProps): JSX.Element;
+export default function FeedbackWrapper({ sourceId, data, type, rightFooter, children, }: FeedbackWrapperProps): JSX.Element;
 export {};

package/dist/ai/messages/insights-message.d.ts

@@ -1,7 +1,12 @@
 /// <reference types="react" />
+export declare function InsightsButton({ onClick, disabled, }: {
+    onClick?: () => void;
+    disabled?: boolean;
+}): JSX.Element;
 type InsightsMessageProps = {
     dataSource: string;
     metadata: object[];
+    visible?: boolean;
 };
-export default function InsightsMessage({ dataSource, metadata }: InsightsMessageProps): JSX.Element;
+export default function InsightsMessage({ dataSource, metadata, visible, }: InsightsMessageProps): JSX.Element | null;
 export {};

package/dist/ai/messages/message-list-resolver.d.ts

@@ -2,6 +2,5 @@
 import { ChatMessage } from '../api/types';
 export type MessageListResolverProps = {
     messages: ChatMessage[];
-    sendMessage?: (message: string) => void;
 };
-export default function MessageListResolver({ messages, sendMessage, }: MessageListResolverProps): JSX.Element;
+export default function MessageListResolver({ messages }: MessageListResolverProps): JSX.Element;

package/dist/ai/messages/message-resolver.d.ts

@@ -2,9 +2,7 @@
 import { ChatMessage } from '../api/types';
 type MessageResolverProps = {
     message: ChatMessage;
-    sendMessage?: (message: string) => void;
-    allowFollowupQuestions?: boolean;
 };
-declare function MessageResolver({ message, allowFollowupQuestions, sendMessage, }: MessageResolverProps): JSX.Element;
+declare function MessageResolver({ message }: MessageResolverProps): JSX.Element;
 declare const _default: import("react").MemoExoticComponent<typeof MessageResolver>;
 export default _default;

package/dist/ai/messages/nlq-message-group.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { NlqResponseData } from '../api/types';
+/**
+ * Renders a NLQ response as a series of chat messages/buttons.
+ *
+ * @internal
+ */
+export default function NlqMessageGroup({ data }: {
+    data: NlqResponseData;
+}): JSX.Element;

package/dist/ai/suggestions/index.d.ts

@@ -1,4 +1,4 @@
 export { default as SuggestionItem } from './suggestion-item';
 export { default as SuggestionList } from './suggestion-list';
-export { default as SuggestionListWithIntro } from './suggestions-with-intro';
 export { default as SuggestionListSkeleton } from './suggestion-list-skeleton';
+export { default as SuggestionsWithIntro } from './suggestions-with-intro';

package/dist/ai/suggestions/suggestion-list.d.ts

@@ -3,5 +3,5 @@ type Props = {
     questions: string[];
     onSelection: (question: string) => void;
 };
-export default function SuggestionList(props: Props): JSX.Element;
+export default function SuggestionList({ questions, onSelection }: Props): JSX.Element;
 export {};

package/dist/ai/suggestions/suggestions-with-intro.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 type Props = {
     questions: string[];
-    title: string;
+    isLoading: boolean;
     onSelection: (question: string) => void;
 };
-export default function SuggestionsWithIntro(props: Props): JSX.Element;
+export default function SuggestionsWithIntro({ questions, isLoading, onSelection }: Props): JSX.Element | null;
 export {};

package/dist/ai/translators/code-templates.d.ts

@@ -0,0 +1,11 @@
+import { CodeTemplates } from '../../ai/translators/types';
+/**
+ * Code templates for different UI frameworks.
+ *
+ * A code template is made up of other code templates and placeholders.
+ * This allows a code template to be reused in other code templates.
+ * For example, a chart widget template can be reused in a dashboard template.
+ *
+ * @internal
+ */
+export declare const CODE_TEMPLATES: CodeTemplates;

package/dist/ai/translators/generate-code.d.ts

@@ -0,0 +1,9 @@
+import { CodeTemplateKey, UiFramework } from '../../ai/translators/types';
+/**
+ * Generates code from a template with the given data and UI framework.
+ *
+ * @param templateKey - the key of the template to use
+ * @param data - the data to populate the template with
+ * @param uiFramework - the UI framework for the generated code
+ */
+export declare const generateCode: (templateKey: CodeTemplateKey, data: Record<string, string>, uiFramework?: UiFramework) => string;

package/dist/ai/translators/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types';
+export { useGetDataSource } from './use-get-data-source';
+export { ModelTranslator } from './model-translator';
+export { QueryTranslator } from './query-translator';

package/dist/ai/translators/model-translator.d.ts

@@ -0,0 +1,50 @@
+import { ExpandedQueryModel, ChartWidgetModel, UiFramework } from '../../ai/translators/types';
+/**
+ * A class that translates expanded query model to CSDK chart model and code.
+ *
+ * @internal
+ */
+export declare class ModelTranslator {
+    queryModel: ExpandedQueryModel;
+    constructor(queryModel: ExpandedQueryModel);
+    /**
+     * Gets chart recommendations or default to table.
+     *
+     * @param chart - chart recommendations
+     * @returns chart recommendations or default to table
+     */
+    private getChartRecommendationsOrDefault;
+    /**
+     * Gets filters from metadata.
+     *
+     * @param metadata - metadata items
+     */
+    private getFilters;
+    /**
+     * Splits metadata into columns and filters.
+     *
+     * @param metadata - metadata items
+     */
+    private splitMetadata;
+    /**
+     * Converts query model to chart.
+     *
+     * TODO Refactor Chatbot to use this method to render the chart
+     */
+    toChart(): ChartWidgetModel | undefined;
+    private stringifyDataSource;
+    private stringifyChartType;
+    private stringifyFilters;
+    private stringifyDataOptions;
+    private stringifyExtraImports;
+    private getChartWidgetCode;
+    private getTableWidgetCode;
+    /**
+     * Converts chart widget model to CSDK code.
+     *
+     * @param chartWidgetModel - chart widget model
+     * @param uiFramework - UI framework
+     * @returns CSDK code string of the UI framework
+     */
+    toCode(chartWidgetModel: ChartWidgetModel, uiFramework?: UiFramework): string;
+}

package/dist/ai/translators/query-translator.d.ts

@@ -0,0 +1,122 @@
+import { ExpandedQueryModel, SimpleQueryModel, SimpleChartRecommendations } from '../../ai/translators/types';
+import { DataSourceField, MetadataItem, MetadataItemJaql } from '@sisense/sdk-query-client';
+import { ChartRecommendations } from '../../ai';
+/**
+ * A class that translates ExpandedQueryModel (Raw JAQL+Chart Recommendations)
+ * to SimpleQueryModel (Simple JAQL+Simple Chart Options) and vice versa.
+ *
+ * It also provides methods to stringify query models to YAML strings
+ * and parse YAML strings to query models.
+ *
+ * @internal
+ */
+export declare class QueryTranslator {
+    private readonly contextTitle;
+    private indexedFields;
+    /**
+     * Constructor for QueryTranslator.
+     *
+     * @param contextTitle - The context title
+     * @param fields - The data source fields
+     */
+    constructor(contextTitle: string, fields: DataSourceField[]);
+    /**
+     * Concatenates Aggregation Types.
+     */
+    private concatAggTypes;
+    /**
+     * Simplifies Aggregation Formula defined in MetadataItemJaql returned from chat response.
+     *
+     * @param aggFormula - The Aggregation Formula to simplify
+     * @returns The equivalent measure
+     * @privateRemarks
+     * See unit tests for examples of aggregation formulas and their equivalent measures.
+     */
+    simplifyAggFormula(aggFormula: MetadataItemJaql): MetadataItemJaql;
+    /**
+     * Simplifies MetadataItemJaql.
+     *
+     * @param item - The MetadataItemJaql to simplify
+     * @returns The simplified MetadataItemJaql
+     */
+    simplifyMetadataItemJaql(item: MetadataItemJaql): MetadataItemJaql;
+    /**
+     * Simplifies MetadataItem.
+     *
+     * @param item - The MetadataItem to simplify
+     * @returns The simplified MetadataItem
+     */
+    simplifyMetadataItem(item: MetadataItem): MetadataItem;
+    /**
+     * Simplifies Chart Recommendations.
+     *
+     * @param chartRecommendations - The Chart Recommendations to simplify
+     * @returns The simplified chart data options
+     */
+    simplifyChartRecommendations(chartRecommendations: ChartRecommendations | {}): SimpleChartRecommendations | {};
+    /**
+     * Returns the query title with the chart type.
+     *
+     * @param queryTitle - The query title
+     * @param chartRecommendations - The chart recommendations
+     * @returns The query title with the chart type
+     */
+    getQueryTitleWithChartType(queryTitle: string, chartRecommendations: {} | ChartRecommendations): string;
+    /**
+     * Takes a ExpandedQueryModel (e.g., from chat response) and translates it to SimpleQueryModel.
+     *
+     * @param expandedQueryModel - The Expanded Query model to simplify
+     * @returns The simplified query model
+     */
+    translateToSimple(expandedQueryModel: ExpandedQueryModel): SimpleQueryModel;
+    /**
+     * Stringifies a simple query model to YAML string.
+     *
+     * @param simpleQueryModel - The Simple Query model to convert
+     * @returns The YAML string representing the simple query model
+     */
+    stringifySimple(simpleQueryModel: SimpleQueryModel): string;
+    /**
+     * Parses a YAML string to Simple Query Model.
+     *
+     * @param simpleQueryYaml - The YAML string to parse
+     * @returns The Simple Query Model
+     */
+    parseSimple(simpleQueryYaml: string): SimpleQueryModel;
+    /**
+     * Derives chart family from chart type.
+     *
+     * @param chartType - chart type
+     * @returns chart family
+     */
+    private deriveChartFamily;
+    /**
+     * Expands Chart Recommendations.
+     *
+     * @param chartRecommendations - The Chart Recommendations to expand
+     * @returns The expanded chart recommendations
+     */
+    expandChartRecommendations(chartRecommendations: SimpleChartRecommendations | {}): ChartRecommendations | {};
+    /**
+     * Expands MetadataItemJaql by adding table, column, datatype, and title
+     * if they are missing from the item.
+     *
+     * @param item - The MetadataItemJaql to expand
+     * @returns The expanded MetadataItemJaql
+     */
+    expandMetadataItemJaql(item: MetadataItemJaql): MetadataItemJaql;
+    /**
+     * Expands MetadataItem
+     *
+     * @param item - The MetadataItem to expand
+     * @returns The expanded MetadataItem
+     */
+    expandMetadataItem(item: MetadataItem): MetadataItem;
+    /**
+     * Translates a Simple Query Model to Expanded Query Model.
+     *
+     * @param simpleQueryModel - The Simple Query model to convert
+     * @returns The Expanded Query Model
+     */
+    translateToExpanded(simpleQueryModel: SimpleQueryModel): ExpandedQueryModel;
+}

package/dist/ai/translators/translate-props-to-code.d.ts

@@ -0,0 +1,8 @@
+export type MembersFilterJaql = {
+    members: string[];
+};
+export type FromNotEqualFilterJaql = {
+    fromNotEqual: number;
+};
+export type FilterJaql = MembersFilterJaql | FromNotEqualFilterJaql;
+export declare const stringifyProps: (props: object, indent?: number, wrapInQuotes?: boolean) => string;

package/dist/ai/translators/types.d.ts

@@ -0,0 +1,105 @@
+import { MetadataItem } from '@sisense/sdk-query-client';
+import { AxesMapping, NlqResponseData } from '../../ai';
+import { ChartType, TableType } from '../../types';
+import { WidgetModel } from '../../models';
+/**
+ * Expanded Query Model that is based on NlqResponseData.
+ * It contains expanded JAQL and chart recommendations returned from the chat response.
+ *
+ * @internal
+ */
+export type ExpandedQueryModel = Pick<NlqResponseData, 'jaql' | 'chartRecommendations' | 'queryTitle'>;
+/**
+ * Expanded Query Model
+ *
+ * Used as a default value for ExpandedQueryModel
+ *
+ * @internal
+ */
+export declare const EMPTY_EXPANDED_QUERY_MODEL: ExpandedQueryModel;
+/**
+ * Simple Chart Recommendations
+ *
+ * @internal
+ */
+export interface SimpleChartRecommendations {
+    chartType: string;
+    dataOptions: AxesMapping;
+}
+/**
+ * Simple Query Model that is a simplified version of ExpandedQueryModel.
+ *
+ * It removes any JAQL syntax or information that already exists in the schema.
+ * Also, any parameters that have a default do not need to be specified.
+ *
+ * Users manipulates this model via the query in YAML format.
+ *
+ * ModelTranslator is responsible for translating this query model to SimpleWidgetModel.
+ *
+ * @internal
+ */
+export interface SimpleQueryModel {
+    /**
+     * The data model or perspective title.
+     */
+    model: string;
+    metadata: MetadataItem[];
+    chart: SimpleChartRecommendations | {};
+    /**
+     * Title of the query
+     */
+    queryTitle: string;
+}
+/**
+ * Empty Simple Query Model
+ *
+ * Used as a default value for SimpleQueryModel
+ *
+ * @internal
+ */
+export declare const EMPTY_SIMPLE_QUERY_MODEL: SimpleQueryModel;
+/**
+ * All Chart Types including Table
+ * Note: Table will be re-united with ChartType in a future MR
+ *
+ * @internal
+ */
+export type AllChartType = ChartType | TableType;
+/**
+ * Chart Widget Model
+ *
+ * This model serves two purposes:
+ *
+ * (1) For rendering a chart or table widget in the Query Composer.
+ * (2) For reverse engineered (translated) to CSDK code
+ *
+ * Naming TBD
+ *
+ * @internal
+ */
+export type ChartWidgetModel = Pick<WidgetModel, 'getChartWidgetProps' | 'getTableWidgetProps'> & {
+    chartType: AllChartType;
+    queryTitle: string;
+};
+/**
+ * UI Framework
+ *
+ * @internal
+ */
+export type UiFramework = 'react' | 'vue' | 'angular';
+/**
+ * Code Template Key
+ *
+ * @internal
+ */
+export type CodeTemplateKey = 'baseChartTmpl' | 'chartTmpl' | 'chartWidgetTmpl' | 'tableWidgetTmpl';
+/**
+ * Code Templates
+ *
+ * @internal
+ */
+export type CodeTemplates = {
+    [key in UiFramework]: {
+        [key in CodeTemplateKey]: string;
+    };
+};

package/dist/ai/translators/use-get-data-source.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Gets the fields of a data source.
+ *
+ * Alternative hook implementation of QueryApiDispatcher.getDataSourceFields
+ *
+ * @param dataSource - The data source to get the fields for
+ * @internal
+ */
+export declare const useGetDataSource: (dataSource: string | undefined) => {
+    data: import("@sisense/sdk-query-client").DataSourceField[] | undefined;
+    isLoading: boolean;
+};

package/dist/ai/translators/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function toKebabCase(str: string): string;
+export declare function capitalizeFirstLetter(str: string): string;

package/dist/ai/use-chat-session.d.ts

@@ -1,11 +1,18 @@
-import type { ChatMessage } from './api/types';
-interface UseChatSessionResult {
+import type { ChatMessage, NlqMessage, NlqResponseData } from './api/types';
+/**
+ * Result of the useChatSession hook.
+ *
+ * @internal
+ */
+export interface UseChatSessionResult {
     chatId: string | undefined;
     history: ChatMessage[];
+    lastNlqResponse: NlqResponseData | null;
     sendMessage: (message: string) => void;
     isAwaitingResponse: boolean;
     isLoading: boolean;
 }
+export declare const isNlqMessage: (message: ChatMessage | null | undefined) => message is NlqMessage;
 /**
  * React hook that returns a chat session object for the given data model or
  * perspective.
@@ -19,4 +26,3 @@ interface UseChatSessionResult {
  * @internal
  */
 export declare const useChatSession: (contextTitle: string) => UseChatSessionResult;
-export {};

package/dist/ai/use-get-nlg-query-result.d.ts

@@ -1,4 +1,4 @@
-import { Attribute, Filter, Measure } from '@sisense/sdk-data';
+import { Attribute, DataSource, Filter, FilterRelations, Measure } from '@sisense/sdk-data';
 import { GetNlgQueryResultRequest } from './api/types';
 import { GetNlgQueryResultProps } from './get-nlg-query-result';
 /**
@@ -6,13 +6,13 @@ import { GetNlgQueryResultProps } from './get-nlg-query-result';
  */
 export interface UseGetNlgQueryResultParams {
     /** The data source that the query targets - e.g. `Sample ECommerce` */
-    dataSource: string;
+    dataSource: DataSource;
     /** Dimensions of the query */
     dimensions?: Attribute[];
     /** Measures of the query */
     measures?: Measure[];
     /** Filters of the query */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelations;
     /**
      * Boolean flag to enable/disable API call by default
      *
@@ -42,9 +42,8 @@ export interface UseGetNlgQueryResultState {
  */
 export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultProps | GetNlgQueryResultRequest, enabled?: boolean) => UseGetNlgQueryResultState;
 /**
- * React hook that fetches an analysis of the provided JAQL using natural language generation (NLG).
- *
- * Note that in the example below, this hook expects `metadata` to be in standard JAQL syntax.
+ * 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 {@link useExecuteQuery} hook, using dimensions, measures, and filters.
  *
  * ::: warning Note
  * This hook is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
@@ -66,6 +65,7 @@ export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultPro
  * ```
  * @param params - {@link UseGetNlgQueryResultParams}
  * @returns Response object containing a text summary
+ * @group Generative AI
  * @beta
  */
 export declare const useGetNlgQueryResult: (params: UseGetNlgQueryResultParams) => UseGetNlgQueryResultState;

package/dist/ai/use-get-query-recommendations.d.ts

@@ -59,6 +59,7 @@ export declare const useGetQueryRecommendationsInternal: (params: UseGetQueryRec
  * ```
  * @param params - {@link UseGetQueryRecommendationsParams}
  * @returns An array of objects, each containing recommended question text and its corresponding JAQL
+ * @group Generative AI
  * @beta
  */
 export declare const useGetQueryRecommendations: (params: UseGetQueryRecommendationsParams) => UseGetQueryRecommendationsState;