@gooddata/sdk-backend-spi 11.35.0-alpha.6 → 11.35.0-alpha.7

package/esm/index.d.ts

@@ -20,7 +20,7 @@ export type { IGetInsightOptions, IGetVisualizationClassesOptions, IWorkspaceIns
 export type { ExportDefinitionOrdering, IExportDefinitionsQuery, IExportDefinitionsQueryOptions, IExportDefinitionsQueryResult, IGetExportDefinitionOptions, IWorkspaceExportDefinitionsService, ExportDefinitionQuerySortDirection, ExportDefinitionQuerySortProperty, ExportDefinitionQuerySort, } from "./workspace/exportDefinitions/index.js";
 export { type IElementsQueryFactory, type IElementsQueryResult, type IElementsQuery, type IElementsQueryOptions, type IElementsQueryAttributeFilter, type IElementsQueryOptionsElementsByUri, type IElementsQueryOptionsElementsByValue, type IElementsQueryOptionsElementsByPrimaryDisplayFormValue, type ElementsQueryOptionsElementsSpecification, type IFilterElementsQuery, type FilterWithResolvableElements, isElementsQueryOptionsElementsByValue, isElementsQueryOptionsElementsByPrimaryDisplayFormValue, isValueBasedElementsQueryOptionsElements, } from "./workspace/attributes/elements/index.js";
 export type { IExportConfig, IExportResult, IExportPdfConfig } from "./workspace/execution/export.js";
-export { type AnalyticsCatalogGenerateTitleObjectType, type IAnalyticsCatalogGenerateTitleRequest, type IAnalyticsCatalogGenerateTitleResponse, type IAnalyticsCatalogTrendingObject, type IAnalyticsCatalogTrendingObjects, type IKnowledgeDocumentsService, type IKnowledgeDocumentMetadata, type ICreateKnowledgeDocumentRequest, type IUpsertKnowledgeDocumentRequest, type IDeleteKnowledgeDocumentResponse, type IPatchKnowledgeDocumentRequest, type IKnowledgeSearchResult, type IKnowledgeSearchStatistics, type ISearchKnowledgeResponse, type ISearchKnowledgeOptions, type IListKnowledgeDocumentsOptions, type IKnowledgeDocumentsPage, type AnalyticsCatalogGenerateDescriptionObjectType, type IAnalyticsCatalogGenerateDescriptionRequest, type IAnalyticsCatalogGenerateDescriptionResponse, type IGenAIService, type IAnalyticsCatalogService, type IAnalyticsCatalogTags, type IAnalyticsCatalogCreatedBy, type ISemanticSearchQuery, type ISemanticSearchResult, type IChatThread, type IChatThreadHistory, type IChatThreadQuery, type IGenAIChatEvaluation, type ISemanticQualityService, type IMemoryItemsService, type IMemoryCreatedByUsers, type IMemoryItemsQuery, type IMemoryItemsFilterOptions, type IMemoryItemsQueryResult, type IChatConversationError, type IChatConversationThread, type IChatConversationThreadQuery, type IChatConversation, type IChatConversationItem, type IChatConversationItemsQuery, type IChatConversationItemsQueryResult, type IChatConversationFeedback, type IChatConversations, type IChatConversationContent, type IChatConversationMultipartContent, type IChatConversationKeyDriverAnalysisContent, type IChatConversationWhatIfContent, type IChatConversationReasoningContent, type IChatConversationMultipartPart, type IChatConversationToolCallContent, type IChatConversationTextContent, type IChatConversationToolResultContent, type IChatConversationVisualisationContent, type IChatConversationSearchContent, type IChatKdaDefinition, type IChatWhatIfDefinition, type IChatWhatIfAdjustment, type IChatWhatIfScenario, type IChatSuggestion, type IChatSuggestionsItem, type IChatSuggestionsAction, isChatConversationError, isChatConversationItem, isChatConversationTextContent, isChatConversationReasoningContent, isChatConversationMultipartContent, isChatConversationToolCallContent, isChatConversationToolResultContent, isChatConversationVisualisationContent, isChatConversationKeyDriverAnalysisContent, isChatConversationWhatIfContent, isChatConversationSearchContent, isChatSuggestionsItem, } from "./workspace/genAI/index.js";
+export { type AnalyticsCatalogGenerateTitleObjectType, type IAnalyticsCatalogGenerateTitleRequest, type IAnalyticsCatalogGenerateTitleResponse, type IAnalyticsCatalogTrendingObject, type IAnalyticsCatalogTrendingObjects, type IKnowledgeDocumentsService, type IKnowledgeDocumentMetadata, type ICreateKnowledgeDocumentRequest, type IUpsertKnowledgeDocumentRequest, type IDeleteKnowledgeDocumentResponse, type IPatchKnowledgeDocumentRequest, type IKnowledgeSearchResult, type IKnowledgeSearchStatistics, type ISearchKnowledgeResponse, type ISearchKnowledgeOptions, type IListKnowledgeDocumentsOptions, type IKnowledgeDocumentsPage, type AnalyticsCatalogGenerateDescriptionObjectType, type IAnalyticsCatalogGenerateDescriptionRequest, type IAnalyticsCatalogGenerateDescriptionResponse, type IGenAIService, type IDashboardSummaryRequest, type IDashboardSummary, type IDashboardSummaryIncludedVisualization, type IDashboardSummaryExcludedVisualization, type IAnalyticsCatalogService, type IAnalyticsCatalogTags, type IAnalyticsCatalogCreatedBy, type ISemanticSearchQuery, type ISemanticSearchResult, type IChatThread, type IChatThreadHistory, type IChatThreadQuery, type IGenAIChatEvaluation, type ISemanticQualityService, type IMemoryItemsService, type IMemoryCreatedByUsers, type IMemoryItemsQuery, type IMemoryItemsFilterOptions, type IMemoryItemsQueryResult, type IChatConversationError, type IChatConversationThread, type IChatConversationThreadQuery, type IChatConversation, type IChatConversationItem, type IChatConversationItemsQuery, type IChatConversationItemsQueryResult, type IChatConversationFeedback, type IChatConversations, type IChatConversationContent, type IChatConversationMultipartContent, type IChatConversationKeyDriverAnalysisContent, type IChatConversationWhatIfContent, type IChatConversationReasoningContent, type IChatConversationMultipartPart, type IChatConversationToolCallContent, type IChatConversationTextContent, type IChatConversationToolResultContent, type IChatConversationVisualisationContent, type IChatConversationSearchContent, type IChatKdaDefinition, type IChatWhatIfDefinition, type IChatWhatIfAdjustment, type IChatWhatIfScenario, type IChatSuggestion, type IChatSuggestionsItem, type IChatSuggestionsAction, isChatConversationError, isChatConversationItem, isChatConversationTextContent, isChatConversationReasoningContent, isChatConversationMultipartContent, isChatConversationToolCallContent, isChatConversationToolResultContent, isChatConversationVisualisationContent, isChatConversationKeyDriverAnalysisContent, isChatConversationWhatIfContent, isChatConversationSearchContent, isChatSuggestionsItem, } from "./workspace/genAI/index.js";
 export type { IOrganizationGenAIService } from "./organization/genAI/index.js";
 export type { IReferencesResult, IReferencesOption, IReferencesService, } from "./workspace/references/index.js";
 export type { IWorkspaceStylingService } from "./workspace/styling/index.js";

package/esm/sdk-backend-spi.d.ts

@@ -2444,6 +2444,53 @@ export declare interface IDashboardsQuery {
  */
 export declare type IDashboardsQueryResult = IPagedResource<IListedDashboard>;
 
+/**
+ * Response payload for AI dashboard summarization.
+ * @beta
+ */
+export declare interface IDashboardSummary {
+    summary: string;
+    filterContext: FilterContextItem[];
+    visualizationsIncluded: IDashboardSummaryIncludedVisualization[];
+    visualizationsExcluded: IDashboardSummaryExcludedVisualization[];
+    generatedAt: string;
+}
+
+/**
+ * A visualization excluded from the AI dashboard summary, along with the reason.
+ * @beta
+ */
+export declare interface IDashboardSummaryExcludedVisualization {
+    visualizationId: string;
+    reason: string;
+    title?: string | null;
+}
+
+/**
+ * A visualization included in the AI dashboard summary.
+ * @beta
+ */
+export declare interface IDashboardSummaryIncludedVisualization {
+    visualizationId: string;
+    title?: string | null;
+}
+
+/**
+ * Request payload for AI dashboard summarization.
+ * @beta
+ */
+export declare interface IDashboardSummaryRequest {
+    dashboardId: string;
+    /**
+     * Visualizations to include in the summary. `null` means include all visualizations on the dashboard.
+     */
+    visualizations: string[] | null;
+    /**
+     * Filter context to apply when generating the summary. `null` means use all dashboard filters.
+     */
+    filterContext: FilterContextItem[] | null;
+}
+
 /**
  * Result returned when the dashboard summary workflow is started.
  *
@@ -3969,6 +4016,13 @@ export declare interface IGenAIService {
      * Get check if LLM is configured.
      */
     getLlmConfigured(): Promise<boolean>;
+    /**
+     * Generate an AI summary of a dashboard for the given visualizations and filter context.
+     * @beta
+     */
+    summarizeDashboard(request: IDashboardSummaryRequest, options?: {
+        signal?: AbortSignal;
+    }): Promise<IDashboardSummary>;
 }
 
 /**

package/esm/workspace/genAI/index.d.ts

@@ -1,4 +1,4 @@
-import type { DateAttributeGranularity, GenAIChatInteractionUserFeedback, GenAIChatInteractionUserVisualisation, GenAIObjectType, IAllowedRelationshipType, IAttribute, IFilter, IGenAIChangeAnalysisParams, IGenAIChatInteraction, IGenAIChatReasoning, IGenAIChatRouting, IGenAICreatedVisualizations, IGenAIFoundObjects, IGenAIUserContext, IInsight, IMeasure, IMemoryItemDefinition, IMemoryItemMetadataObject, ISemanticQualityIssuesCalculation, ISemanticQualityReport, ISemanticSearchRelationship, ISemanticSearchResult, ISemanticSearchResultItem, IUser, MemoryItemStrategy, ObjRef, ObjectOrigin, ObjectType } from "@gooddata/sdk-model";
+import type { DateAttributeGranularity, FilterContextItem, GenAIChatInteractionUserFeedback, GenAIChatInteractionUserVisualisation, GenAIObjectType, IAllowedRelationshipType, IAttribute, IFilter, IGenAIChangeAnalysisParams, IGenAIChatInteraction, IGenAIChatReasoning, IGenAIChatRouting, IGenAICreatedVisualizations, IGenAIFoundObjects, IGenAIUserContext, IInsight, IMeasure, IMemoryItemDefinition, IMemoryItemMetadataObject, ISemanticQualityIssuesCalculation, ISemanticQualityReport, ISemanticSearchRelationship, ISemanticSearchResult, ISemanticSearchResultItem, IUser, MemoryItemStrategy, ObjRef, ObjectOrigin, ObjectType } from "@gooddata/sdk-model";
 import type { IFilterBaseOptions } from "../../common/filtering.js";
 import type { IPagedResource } from "../../common/paging.js";
 /**
@@ -55,6 +55,56 @@ export interface IGenAIService {
      * Get check if LLM is configured.
      */
     getLlmConfigured(): Promise<boolean>;
+    /**
+     * Generate an AI summary of a dashboard for the given visualizations and filter context.
+     * @beta
+     */
+    summarizeDashboard(request: IDashboardSummaryRequest, options?: {
+        signal?: AbortSignal;
+    }): Promise<IDashboardSummary>;
+}
+/**
+ * Request payload for AI dashboard summarization.
+ * @beta
+ */
+export interface IDashboardSummaryRequest {
+    dashboardId: string;
+    /**
+     * Visualizations to include in the summary. `null` means include all visualizations on the dashboard.
+     */
+    visualizations: string[] | null;
+    /**
+     * Filter context to apply when generating the summary. `null` means use all dashboard filters.
+     */
+    filterContext: FilterContextItem[] | null;
+}
+/**
+ * A visualization included in the AI dashboard summary.
+ * @beta
+ */
+export interface IDashboardSummaryIncludedVisualization {
+    visualizationId: string;
+    title?: string | null;
+}
+/**
+ * A visualization excluded from the AI dashboard summary, along with the reason.
+ * @beta
+ */
+export interface IDashboardSummaryExcludedVisualization {
+    visualizationId: string;
+    reason: string;
+    title?: string | null;
+}
+/**
+ * Response payload for AI dashboard summarization.
+ * @beta
+ */
+export interface IDashboardSummary {
+    summary: string;
+    filterContext: FilterContextItem[];
+    visualizationsIncluded: IDashboardSummaryIncludedVisualization[];
+    visualizationsExcluded: IDashboardSummaryExcludedVisualization[];
+    generatedAt: string;
 }
 /**
  * Semantic search query.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-backend-spi",
-  "version": "11.35.0-alpha.6",
+  "version": "11.35.0-alpha.7",
   "description": "GoodData Backend SPI abstraction interfaces",
   "license": "MIT",
   "author": "GoodData",
@@ -24,7 +24,7 @@
     "lodash-es": "^4.17.23",
     "ts-invariant": "0.10.3",
     "tslib": "2.8.1",
-    "@gooddata/sdk-model": "11.35.0-alpha.6"
+    "@gooddata/sdk-model": "11.35.0-alpha.7"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.17.0",
@@ -48,8 +48,8 @@
     "oxlint-tsgolint": "0.11.4",
     "typescript": "5.9.3",
     "vitest": "4.1.0",
-    "@gooddata/oxlint-config": "11.35.0-alpha.6",
-    "@gooddata/eslint-config": "11.35.0-alpha.6"
+    "@gooddata/eslint-config": "11.35.0-alpha.7",
+    "@gooddata/oxlint-config": "11.35.0-alpha.7"
   },
   "scripts": {
     "_phase:build": "npm run build",