@sisense/sdk-ui 1.3.0 → 1.4.0

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

@@ -0,0 +1,103 @@
+import type { GetNlgQueryResultRequest } from './api/types.js';
+/**
+ * Parameters for {@link useGetNlgQueryResult} hook.
+ *
+ */
+export interface UseGetNlgQueryResultParams extends GetNlgQueryResultRequest {
+    /**
+     * Boolean flag to enable/disable API call by default
+     *
+     * If not specified, the default value is `true`
+     */
+    enabled?: boolean;
+}
+export declare const useGetNlgQueryResultInternal: (params: UseGetNlgQueryResultParams) => {
+    data: string | undefined;
+    isError: boolean;
+    isLoading: boolean;
+    isSuccess: boolean;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    refetch: () => void;
+};
+/**
+ * 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.
+ *
+ * ::: warning Note
+ * This hook is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
+ * :::
+ *
+ * @example
+ * ```tsx
+ * import { SisenseContextProvider } from '@sisense/sdk-ui';
+ * import { AiContextProvider, useGetNlgQueryResult } from '@sisense/sdk-ui/ai';
+ *
+ * function Page() {
+ *   const { data } = useGetNlgQueryResult({
+ *     dataSource: 'Sample ECommerce',
+ *     metadata: [
+ *       {
+ *         jaql: {
+ *           column: 'Date',
+ *           datatype: 'datetime',
+ *           dim: '[Commerce.Date]',
+ *           firstday: 'mon',
+ *           level: 'years',
+ *           table: 'Commerce',
+ *           title: 'Date',
+ *         },
+ *         format: {
+ *           mask: {
+ *             days: 'shortDate',
+ *             isdefault: true,
+ *             minutes: 'HH:mm',
+ *             months: 'MM/yyyy',
+ *             quarters: 'yyyy Q',
+ *             weeks: 'ww yyyy',
+ *             years: 'yyyy',
+ *           },
+ *         },
+ *       },
+ *       {
+ *         jaql: {
+ *           agg: 'sum',
+ *           column: 'Revenue',
+ *           datatype: 'numeric',
+ *           dim: '[Commerce.Revenue]',
+ *           table: 'Commerce',
+ *           title: 'total of Revenue',
+ *         },
+ *       },
+ *     ],
+ *   });
+ *   return (
+ *     <>
+ *       <h1>Summary</h1>
+ *       <p>{data}</p>
+ *     </>
+ *   );
+ * }
+ *
+ * function App() {
+ *   return (
+ *     <SisenseContextProvider {...sisenseContextProps}>
+ *       <AiContextProvider>
+ *         <Page />
+ *       </AiContextProvider>
+ *     </SisenseContextProvider>
+ *   );
+ * }
+ * ```
+ * @param params - {@link UseGetNlgQueryResultParams}
+ * @returns Response object containing a text summary
+ * @beta
+ */
+export declare const useGetNlgQueryResult: (params: UseGetNlgQueryResultParams) => {
+    data: string | undefined;
+    isError: boolean;
+    isLoading: boolean;
+    isSuccess: boolean;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    refetch: () => void;
+};

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

@@ -0,0 +1,67 @@
+/**
+ * Parameters for {@link useGetQueryRecommendations} hook.
+ */
+export interface UseGetQueryRecommendationsParams {
+    /** Data model title or perspective title */
+    contextTitle: string;
+    /**
+     * Number of recommendations that should be returned
+     *
+     * If not specified, the default value is `4`
+     */
+    count?: number;
+}
+export declare const useGetQueryRecommendationsInternal: (params: UseGetQueryRecommendationsParams) => {
+    data: import(".").QueryRecommendationResponse;
+    isLoading: boolean;
+};
+/**
+ * React hook that fetches recommended questions for a data model or perspective.
+ *
+ * This hook includes the same code that fetches the initial suggested questions in the chatbot.
+ *
+ * ::: warning Note
+ * This hook is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
+ * :::
+ *
+ * @example
+ * ```tsx
+ * import { SisenseContextProvider } from '@sisense/sdk-ui';
+ * import { AiContextProvider, useGetQueryRecommendations } from '@sisense/sdk-ui/ai';
+ *
+ * function Page() {
+ *   const { data } = useGetQueryRecommendations({
+ *     contextTitle: 'Sample ECommerce',
+ *   });
+ *
+ *   if (!data) {
+ *     return <div>Loading recommendations</div>;
+ *   }
+ *
+ *   return (
+ *     <ul>
+ *       {data.map((item, index) => (
+ *         <li key={index}>{item.nlqPrompt}</li>
+ *       ))}
+ *     </ul>
+ *   );
+ * }
+ *
+ * function App() {
+ *   return (
+ *     <SisenseContextProvider {...sisenseContextProps}>
+ *       <AiContextProvider>
+ *         <Page />
+ *       </AiContextProvider>
+ *     </SisenseContextProvider>
+ *   );
+ * }
+ * ```
+ * @param params - {@link UseGetQueryRecommendationsParams}
+ * @returns An array of objects, each containing recommended question text and its corresponding JAQL
+ * @beta
+ */
+export declare const useGetQueryRecommendations: (params: UseGetQueryRecommendationsParams) => {
+    data: import(".").QueryRecommendationResponse;
+    isLoading: boolean;
+};