@gooddata/sdk-backend-spi 11.41.0-alpha.1 → 11.41.0-alpha.3

package/esm/index.d.ts

@@ -21,7 +21,7 @@ export type { ExportDefinitionOrdering, IExportDefinitionsQuery, IExportDefiniti
 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 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 IChatSuggestions, isChatConversationError, isChatConversationItem, isChatConversationTextContent, isChatConversationReasoningContent, isChatConversationMultipartContent, isChatConversationToolCallContent, isChatConversationToolResultContent, isChatConversationVisualisationContent, isChatConversationKeyDriverAnalysisContent, isChatConversationWhatIfContent, isChatConversationSearchContent, } from "./workspace/genAI/index.js";
-export type { IOrganizationGenAIService } from "./organization/genAI/index.js";
+export type { IOrganizationAIObservabilityMetric, IOrganizationAIObservabilityMetricType, IOrganizationAIObservabilityOverview, IOrganizationAIObservabilityService, IOrganizationGenAIService, } from "./organization/genAI/index.js";
 export type { IReferencesResult, IReferencesOption, IReferencesService, } from "./workspace/references/index.js";
 export type { IWorkspaceStylingService } from "./workspace/styling/index.js";
 export { type AuthenticationFlow, type IDataTooLargeResponseBody, type IDataTooLargeResponseBodyLimitBreak, type IDataTooLargeResponseBodyStructuredDetail, type ErrorConverter, type NotAuthenticatedReason, AnalyticalBackendError, NoDataError, DataTooLargeError, TimeoutError, ProtectedDataError, UnexpectedResponseError, UnexpectedError, NotSupported, NotImplemented, NotAuthenticated, LimitReached, ContractExpired, AbortError, isAnalyticalBackendError, isNoDataError, isDataTooLargeError, isProtectedDataError, isUnexpectedResponseError, isUnexpectedError, isNotSupported, isNotImplemented, isNotAuthenticated, isLimitReached, isContractExpired, AnalyticalBackendErrorTypes, isAbortError, } from "./errors/index.js";
@@ -34,7 +34,7 @@ export type { IWorkspacePermissionsService } from "./workspace/permissions/index
 export type { IWorkspaceAttributesService, IAttributeWithReferences, IAttributesQuery, IAttributesQueryFilterOptions, IAttributesQueryResult, } from "./workspace/attributes/index.js";
 export type { IWorkspaceMeasuresService, IGetMeasureOptions, IMeasureReferencing, IMeasureKeyDrivers, IMeasuresQueryResult, IMeasuresQuery, } from "./workspace/measures/index.js";
 export type { IWorkspaceFactsService, IFactsQuery, IFactsQueryResult } from "./workspace/facts/index.js";
-export type { IWorkspaceDashboardsService, IGetDashboardOptions, IGetDashboardPluginOptions, IGetScheduledMailOptions, IWidgetAlertCount, SupportedDashboardReferenceTypes, IWidgetReferences, SupportedWidgetReferenceTypes, IDashboardReferences, IDashboardWithReferences, IDashboardsQuery, IDashboardsQueryResult, IRawExportCustomOverride, IRawExportCustomOverrides, IDashboardExportPdfOptions, IDashboardExportRawOptions, IDashboardExportTabularOptions, IDashboardParameterValueOverride, IDashboardExportImageOptions, IDashboardExportPresentationOptions, FiltersByTab, DashboardSummaryWorkflowStatus, IDashboardSummaryWorkflowStartResult, IDashboardSummaryWorkflowStatusResult, } from "./workspace/dashboards/index.js";
+export type { IWorkspaceDashboardsService, IGetDashboardOptions, IGetDashboardPluginOptions, IGetScheduledMailOptions, IWidgetAlertCount, SupportedDashboardReferenceTypes, IWidgetReferences, SupportedWidgetReferenceTypes, IDashboardReferences, IDashboardWithReferences, IDashboardsQuery, IDashboardsQueryResult, IRawExportCustomOverride, IRawExportCustomOverrides, IDashboardExportPdfOptions, IDashboardExportRawOptions, IDashboardExportTabularOptions, IDashboardExportImageOptions, IDashboardExportPresentationOptions, FiltersByTab, DashboardSummaryWorkflowStatus, IDashboardSummaryWorkflowStartResult, IDashboardSummaryWorkflowStatusResult, } from "./workspace/dashboards/index.js";
 export { type IWidgetWithLayoutPath, type LayoutPath, isDashboardLayoutEmpty, layoutWidgets, layoutWidgetsWithPaths, walkLayout, } from "./workspace/dashboards/utils.js";
 export type { IWorkspaceUsersQuery, IWorkspaceUsersQueryOptions, IWorkspaceUsersQueryResult, } from "./workspace/users/index.js";
 export type { IDateFilterConfigsQuery, IDateFilterConfigsQueryResult, } from "./workspace/dateFilterConfigs/index.js";

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

@@ -1,4 +1,48 @@
 import { type IKnowledgeDocumentsService } from "../../workspace/genAI/index.js";
+/**
+ * AI observability metric type.
+ *
+ * @alpha
+ */
+export type IOrganizationAIObservabilityMetricType = "AI_WORKSPACES" | "AI_USERS" | "AI_QUERIES";
+/**
+ * AI observability metric for the caller's organization.
+ *
+ * @alpha
+ */
+export interface IOrganizationAIObservabilityMetric {
+    /**
+     * Metric type.
+     */
+    type: IOrganizationAIObservabilityMetricType;
+    /**
+     * Metric value for the current calendar month.
+     */
+    currentValue: number;
+    /**
+     * Metric value for the previous calendar month.
+     */
+    previousValue: number;
+}
+/**
+ * AI observability overview for the caller's organization.
+ *
+ * @alpha
+ */
+export interface IOrganizationAIObservabilityOverview {
+    metrics: IOrganizationAIObservabilityMetric[];
+}
+/**
+ * Service for querying AI observability metrics.
+ *
+ * @alpha
+ */
+export interface IOrganizationAIObservabilityService {
+    /**
+     * Returns AI observability overview for the caller's organization.
+     */
+    getOverview(): Promise<IOrganizationAIObservabilityOverview>;
+}
 /**
  * Service to query and manage organization-level generative-AI resources.
  *
@@ -9,4 +53,8 @@ export interface IOrganizationGenAIService {
      * Returns a service for listing and managing organization-level knowledge documents.
      */
     getKnowledgeDocuments(): IKnowledgeDocumentsService;
+    /**
+     * Returns a service for querying organization-level AI observability metrics.
+     */
+    getObservability(): IOrganizationAIObservabilityService;
 }

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

@@ -52,6 +52,7 @@ import type { IDashboard } from '@gooddata/sdk-model';
 import type { IDashboardAttributeFilterConfig } from '@gooddata/sdk-model';
 import type { IDashboardBase } from '@gooddata/sdk-model';
 import type { IDashboardDefinition } from '@gooddata/sdk-model';
+import type { IDashboardExportParameter } from '@gooddata/sdk-model';
 import type { IDashboardFilterView } from '@gooddata/sdk-model';
 import type { IDashboardFilterViewSaveRequest } from '@gooddata/sdk-model';
 import { IDashboardLayout } from '@gooddata/sdk-model';
@@ -75,6 +76,7 @@ import { IDimensionDescriptor } from '@gooddata/sdk-model';
 import { IEntitlementDescriptor } from '@gooddata/sdk-model';
 import { IExecutionConfig } from '@gooddata/sdk-model';
 import { IExecutionDefinition } from '@gooddata/sdk-model';
+import { IExecutionResultLimitBreak } from '@gooddata/sdk-model';
 import type { IExistingDashboard } from '@gooddata/sdk-model';
 import { IExportDefinitionMetadataObject } from '@gooddata/sdk-model';
 import { IExportDefinitionMetadataObjectDefinition } from '@gooddata/sdk-model';
@@ -1695,7 +1697,7 @@ export declare type IChatConversationItem = {
     responseId: string;
     replyTo?: string;
     createdAt: number;
-    role: "user" | "assistant" | "tool";
+    role: "user" | "assistant" | "tool" | "system";
     content: IChatConversationContent;
     feedback?: IChatConversationFeedback;
 };
@@ -2208,6 +2210,12 @@ export declare interface IDashboardExportImageOptions {
      * Filename for the export. If not provided, the dashboard title will be fetched.
      */
     filename?: string;
+    /**
+     * Per-tab parameter runtime-overrides applied when rendering the exported image.
+     * Keyed by tab `localIdentifier`; a widget-scoped export carries the single owning tab.
+     * Mirrors `dashboardTabsParametersOverrides` on the tabular options.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
     /**
      * Override the default export result polling timeout (in milliseconds).
      *
@@ -2233,6 +2241,11 @@ export declare interface IDashboardExportPdfOptions {
      * Custom export metadata forwarded through the export flow.
      */
     exportMetadata?: Record<string, string>;
+    /**
+     * Per-tab parameter runtime-overrides applied when rendering the exported file. Keyed by tab
+     * `localIdentifier`. Mirrors `dashboardTabsParametersOverrides` on the tabular options.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
     /**
      * Override the default export result polling timeout (in milliseconds).
      *
@@ -2257,6 +2270,12 @@ export declare interface IDashboardExportPresentationOptions {
     hideWidgetTitles?: boolean;
     filename?: string;
     exportMetadata?: Record<string, string>;
+    /**
+     * Per-tab parameter runtime-overrides applied when rendering the exported slides.
+     * Keyed by tab `localIdentifier`; a widget-scoped export carries the single owning tab.
+     * Mirrors `dashboardTabsParametersOverrides` on the tabular options.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
     /**
      * Override the default export result polling timeout (in milliseconds).
      *
@@ -2327,7 +2346,7 @@ export declare interface IDashboardExportTabularOptions {
      * Per-tab parameter overrides. Key is tabId; values drive AFM execution and info-sheet rendering
      * for that tab's sub-export. Mirrors `dashboardTabsFiltersOverrides`.
      */
-    dashboardTabsParametersOverrides?: Record<string, IDashboardParameterValueOverride[]>;
+    dashboardTabsParametersOverrides?: Record<string, IDashboardExportParameter[]>;
     /**
      * PDF-specific configuration options. Only applicable when format is "PDF".
      */
@@ -2347,28 +2366,6 @@ export declare interface IDashboardExportTabularOptions {
     timeout?: number;
 }
 
-/**
- * Backend-neutral parameter value override sent on dashboard tabular export.
- *
- * @alpha
- */
-export declare interface IDashboardParameterValueOverride {
-    /**
-     * Parameter identifier; drives AFM execution. Matches the workspace catalog parameter's id.
-     */
-    id: string;
-    /**
-     * Value to apply for the parameter, encoded as a string (numeric values are stringified).
-     * Drives AFM execution.
-     */
-    value: string;
-    /**
-     * Display title rendered into the export's info sheet. Presentation-only; not consumed by
-     * execution.
-     */
-    title: string;
-}
-
 /**
  * Dashboard referenced objects
  * @alpha
@@ -3543,6 +3540,10 @@ export declare interface IExecutionResultMetadata {
      * Additional information sent by the underlying data source.
      */
     readonly dataSourceMessages: ReadonlyArray<IExecutionResultDataSourceMessage>;
+    /**
+     * Limits broken during result computation, causing partial data to be returned.
+     */
+    readonly limitBreaks?: ReadonlyArray<IExecutionResultLimitBreak>;
 }
 
 /**
@@ -5264,6 +5265,54 @@ export declare interface IOrganizationAgentsService {
     deleteAgent(ref: ObjRef): Promise<void>;
 }
 
+/**
+ * AI observability metric for the caller's organization.
+ *
+ * @alpha
+ */
+export declare interface IOrganizationAIObservabilityMetric {
+    /**
+     * Metric type.
+     */
+    type: IOrganizationAIObservabilityMetricType;
+    /**
+     * Metric value for the current calendar month.
+     */
+    currentValue: number;
+    /**
+     * Metric value for the previous calendar month.
+     */
+    previousValue: number;
+}
+
+/**
+ * AI observability metric type.
+ *
+ * @alpha
+ */
+export declare type IOrganizationAIObservabilityMetricType = "AI_WORKSPACES" | "AI_USERS" | "AI_QUERIES";
+
+/**
+ * AI observability overview for the caller's organization.
+ *
+ * @alpha
+ */
+export declare interface IOrganizationAIObservabilityOverview {
+    metrics: IOrganizationAIObservabilityMetric[];
+}
+
+/**
+ * Service for querying AI observability metrics.
+ *
+ * @alpha
+ */
+export declare interface IOrganizationAIObservabilityService {
+    /**
+     * Returns AI observability overview for the caller's organization.
+     */
+    getOverview(): Promise<IOrganizationAIObservabilityOverview>;
+}
+
 /**
  * This service provides access to organization-wide automations for centralized automation management.
  * It allows managing automations across all workspaces within the organization.
@@ -5504,6 +5553,10 @@ export declare interface IOrganizationGenAIService {
      * Returns a service for listing and managing organization-level knowledge documents.
      */
     getKnowledgeDocuments(): IKnowledgeDocumentsService;
+    /**
+     * Returns a service for querying organization-level AI observability metrics.
+     */
+    getObservability(): IOrganizationAIObservabilityService;
 }
 
 /**

package/esm/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.55.2"
+      "packageVersion": "7.58.7"
     }
   ]
 }

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

@@ -1,4 +1,4 @@
-import type { CatalogItem, FilterContextItem, IDashboard, IDashboardAttributeFilterConfig, IDashboardBase, IDashboardDefinition, IDashboardFilterView, IDashboardFilterViewSaveRequest, IDashboardObjectIdentity, IDashboardPermissions, IDashboardPlugin, IDashboardPluginDefinition, IDataSetMetadataObject, IDateFilter, IExecutionDefinition, IExistingDashboard, IFilter, IFilterContext, IFilterContextDefinition, IInsight, IListedDashboard, IObjectCertificationWrite, IScheduledMail, IScheduledMailDefinition, IWidget, IWidgetAlert, IWidgetAlertDefinition, ObjRef, ObjectOrigin, ObjectType } from "@gooddata/sdk-model";
+import type { CatalogItem, FilterContextItem, IDashboard, IDashboardAttributeFilterConfig, IDashboardBase, IDashboardDefinition, IDashboardExportParameter, IDashboardFilterView, IDashboardFilterViewSaveRequest, IDashboardObjectIdentity, IDashboardPermissions, IDashboardPlugin, IDashboardPluginDefinition, IDataSetMetadataObject, IDateFilter, IExecutionDefinition, IExistingDashboard, IFilter, IFilterContext, IFilterContextDefinition, IInsight, IListedDashboard, IObjectCertificationWrite, IScheduledMail, IScheduledMailDefinition, IWidget, IWidgetAlert, IWidgetAlertDefinition, ObjRef, ObjectOrigin, ObjectType } from "@gooddata/sdk-model";
 import type { IFilterBaseOptions } from "../../common/filtering.js";
 import type { IPagedResource } from "../../common/paging.js";
 import type { QueryMethod } from "../../common/query.js";
@@ -165,27 +165,6 @@ export interface IRawExportCustomOverrides {
      */
     displayForms?: Record<string, IRawExportCustomOverride>;
 }
-/**
- * Backend-neutral parameter value override sent on dashboard tabular export.
- *
- * @alpha
- */
-export interface IDashboardParameterValueOverride {
-    /**
-     * Parameter identifier; drives AFM execution. Matches the workspace catalog parameter's id.
-     */
-    id: string;
-    /**
-     * Value to apply for the parameter, encoded as a string (numeric values are stringified).
-     * Drives AFM execution.
-     */
-    value: string;
-    /**
-     * Display title rendered into the export's info sheet. Presentation-only; not consumed by
-     * execution.
-     */
-    title: string;
-}
 /**
  * Options for exporting dashboard to tabular format.
  *
@@ -224,7 +203,7 @@ export interface IDashboardExportTabularOptions {
      * Per-tab parameter overrides. Key is tabId; values drive AFM execution and info-sheet rendering
      * for that tab's sub-export. Mirrors `dashboardTabsFiltersOverrides`.
      */
-    dashboardTabsParametersOverrides?: Record<string, IDashboardParameterValueOverride[]>;
+    dashboardTabsParametersOverrides?: Record<string, IDashboardExportParameter[]>;
     /**
      * PDF-specific configuration options. Only applicable when format is "PDF".
      */
@@ -257,6 +236,11 @@ export interface IDashboardExportPdfOptions {
      * Custom export metadata forwarded through the export flow.
      */
     exportMetadata?: Record<string, string>;
+    /**
+     * Per-tab parameter runtime-overrides applied when rendering the exported file. Keyed by tab
+     * `localIdentifier`. Mirrors `dashboardTabsParametersOverrides` on the tabular options.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
     /**
      * Override the default export result polling timeout (in milliseconds).
      *
@@ -301,6 +285,12 @@ export interface IDashboardExportImageOptions {
      * Filename for the export. If not provided, the dashboard title will be fetched.
      */
     filename?: string;
+    /**
+     * Per-tab parameter runtime-overrides applied when rendering the exported image.
+     * Keyed by tab `localIdentifier`; a widget-scoped export carries the single owning tab.
+     * Mirrors `dashboardTabsParametersOverrides` on the tabular options.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
     /**
      * Override the default export result polling timeout (in milliseconds).
      *
@@ -324,6 +314,12 @@ export interface IDashboardExportPresentationOptions {
     hideWidgetTitles?: boolean;
     filename?: string;
     exportMetadata?: Record<string, string>;
+    /**
+     * Per-tab parameter runtime-overrides applied when rendering the exported slides.
+     * Keyed by tab `localIdentifier`; a widget-scoped export carries the single owning tab.
+     * Mirrors `dashboardTabsParametersOverrides` on the tabular options.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
     /**
      * Override the default export result polling timeout (in milliseconds).
      *

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

@@ -1,4 +1,4 @@
-import { type DataValue, type DimensionGenerator, type GeoCollectionKind, type IAttributeOrMeasure, type IBucket, type IDimension, type IDimensionDescriptor, type IExecutionConfig, type IExecutionDefinition, type IGeoJsonFeature, type IInsight, type IInsightDefinition, type IMeasureDescriptor, type INullableFilter, type IResultHeader, type IResultWarning, type ISortItem } from "@gooddata/sdk-model";
+import { type DataValue, type DimensionGenerator, type GeoCollectionKind, type IAttributeOrMeasure, type IBucket, type IDimension, type IDimensionDescriptor, type IExecutionConfig, type IExecutionDefinition, type IExecutionResultLimitBreak, type IGeoJsonFeature, type IInsight, type IInsightDefinition, type IMeasureDescriptor, type INullableFilter, type IResultHeader, type IResultWarning, type ISortItem } from "@gooddata/sdk-model";
 import { type ICancelable } from "../../cancelation/index.js";
 import { type IExportConfig, type IExportResult } from "./export.js";
 /**
@@ -170,6 +170,10 @@ export interface IExecutionResultMetadata {
      * Additional information sent by the underlying data source.
      */
     readonly dataSourceMessages: ReadonlyArray<IExecutionResultDataSourceMessage>;
+    /**
+     * Limits broken during result computation, causing partial data to be returned.
+     */
+    readonly limitBreaks?: ReadonlyArray<IExecutionResultLimitBreak>;
 }
 /**
  * Format in which the result data are streamed.

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

@@ -763,7 +763,7 @@ export type IChatConversationItem = {
     responseId: string;
     replyTo?: string;
     createdAt: number;
-    role: "user" | "assistant" | "tool";
+    role: "user" | "assistant" | "tool" | "system";
     content: IChatConversationContent;
     feedback?: IChatConversationFeedback;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-backend-spi",
-  "version": "11.41.0-alpha.1",
+  "version": "11.41.0-alpha.3",
   "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.41.0-alpha.1"
+    "@gooddata/sdk-model": "11.41.0-alpha.3"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.17.0",
@@ -48,8 +48,8 @@
     "oxlint-tsgolint": "0.15.0",
     "typescript": "5.9.3",
     "vitest": "4.1.8",
-    "@gooddata/eslint-config": "11.41.0-alpha.1",
-    "@gooddata/oxlint-config": "11.41.0-alpha.1"
+    "@gooddata/eslint-config": "11.41.0-alpha.3",
+    "@gooddata/oxlint-config": "11.41.0-alpha.3"
   },
   "scripts": {
     "_phase:build": "npm run build",