@sisense/sdk-ui 1.0.0 → 1.2.0

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

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

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

@@ -28,8 +28,8 @@ export declare const useChat: (id: string | undefined) => {
  * @internal
  */
 export interface UseGetQueryRecommendationsParams {
-    /** Data model or perspective ID */
-    contextId: string;
+    /** Data model title or perspective title */
+    contextTitle: string;
 }
 /**
  * Fetch recommended questions for a data model or perspective.

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

@@ -1,4 +1,5 @@
 import { MetadataItem } from '@sisense/sdk-query-client';
+import { ChartDataOptions } from '../../types';
 export interface ChatContext {
     id: string;
     name: string;
@@ -55,20 +56,13 @@ interface TextResponse {
     chatId: string;
     responseType: 'Text';
 }
-export interface AxesMapping {
-    category?: {
-        name: string;
-        type: string;
-    }[];
-    value?: {
-        name: string;
-        type: string;
-    }[];
-    breakBy?: {
-        name: string;
-        type: string;
-    }[];
-}
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+type AllPossibleChartOptionKeys = KeysOfUnion<ChartDataOptions>;
+type AxesMappingKey = Exclude<AllPossibleChartOptionKeys, 'seriesToColorMap'>;
+export type AxesMapping = Partial<Record<AxesMappingKey, Array<{
+    name: string;
+    type: string;
+}>>>;
 export interface ChartRecommendations {
     chartFamily: string;
     chartType: string;
@@ -93,16 +87,22 @@ export interface NlqResponse {
     responseType: 'nlq';
 }
 export type ChatResponse = NlqResponse | TextResponse;
-export interface QueryRecommendation {
-    query: string;
-    jaql: object;
+export interface QueryRecommendationConfig {
+    numOfRecommendations: number;
 }
-export interface QueryRecommendationResponse {
-    data: {
-        answer: QueryRecommendation[];
+export interface QueryRecommendation {
+    nlqPrompt: string;
+    chartRecommendations: ChartRecommendations;
+    jaql: {
+        datasource?: {
+            title: string;
+        };
+        metadata: MetadataItem[];
     };
-    responseType: 'Array';
+    queryTitle: string;
+    detailedDescription: string;
 }
+export type QueryRecommendationResponse = QueryRecommendation[];
 export interface DataModel {
     oid: string;
     title: string;

package/dist/ai/messages/get-widget-options.d.ts

@@ -1,13 +1,13 @@
 import { MetadataItem } from '@sisense/sdk-query-client';
-import { CartesianChartDataOptions, CategoricalChartDataOptions, ChartStyleOptions } from '../../types';
+import { ChartDataOptions, ChartStyleOptions } from '../../types';
 import { ChartRecommendations } from '../api/types';
 export declare const getTableOptions: (jaql: MetadataItem[]) => {
     dataOptions: {
         columns: import("./jaql-element").JaqlElement[];
     };
 };
-export declare const getChartOptions: (jaql: MetadataItem[], chartRecs: ChartRecommendations) => {
-    dataOptions: CartesianChartDataOptions | CategoricalChartDataOptions;
+export declare const getChartOptions: (jaql: MetadataItem[], chartRecommendations: ChartRecommendations) => {
+    dataOptions: ChartDataOptions;
     chartStyleOptions: ChartStyleOptions;
     expandedChartStyleOptions: ChartStyleOptions;
 };