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

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 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 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 { IReferencesResult, IReferencesOption, IReferencesService, } from "./workspace/references/index.js";
 export type { IWorkspaceStylingService } from "./workspace/styling/index.js";

package/esm/index.js

@@ -11,6 +11,6 @@
  */
 export { prepareExecution, } from "./backend/index.js";
 export { isElementsQueryOptionsElementsByValue, isElementsQueryOptionsElementsByPrimaryDisplayFormValue, isValueBasedElementsQueryOptionsElements, } from "./workspace/attributes/elements/index.js";
-export { isChatConversationError, isChatConversationItem, isChatConversationTextContent, isChatConversationReasoningContent, isChatConversationMultipartContent, isChatConversationToolCallContent, isChatConversationToolResultContent, isChatConversationVisualisationContent, isChatConversationKeyDriverAnalysisContent, isChatConversationWhatIfContent, isChatConversationSearchContent, isChatSuggestionsItem, } from "./workspace/genAI/index.js";
+export { isChatConversationError, isChatConversationItem, isChatConversationTextContent, isChatConversationReasoningContent, isChatConversationMultipartContent, isChatConversationToolCallContent, isChatConversationToolResultContent, isChatConversationVisualisationContent, isChatConversationKeyDriverAnalysisContent, isChatConversationWhatIfContent, isChatConversationSearchContent, } from "./workspace/genAI/index.js";
 export { 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";
 export { isDashboardLayoutEmpty, layoutWidgets, layoutWidgetsWithPaths, walkLayout, } from "./workspace/dashboards/utils.js";

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

@@ -1,4 +1,4 @@
-import { type ILlmEndpointOpenAI, type LlmEndpointOpenAIPatch, type LlmEndpointTestResults } from "@gooddata/sdk-model";
+import { type ILlmEndpointOpenAI, type LlmEndpointOpenAIPatch } from "@gooddata/sdk-model";
 import { type IPagedResource } from "../../common/paging.js";
 /**
  * Service to query LLM endpoints.
@@ -105,12 +105,4 @@ export interface IOrganizationLlmEndpointsService {
      * @returns Promise resolved when the llm endpoint is patched.
      */
     patchLlmEndpoint(endpoint: LlmEndpointOpenAIPatch, token?: string): Promise<ILlmEndpointOpenAI>;
-    /**
-     * Test existing llm endpoint
-     *
-     * @param endpoint - definition of the llm endpoint
-     * @param token - token for the llm endpoint, if applicable
-     * @returns Promise resolved with test results.
-     */
-    testLlmEndpoint(endpoint: Partial<LlmEndpointOpenAIPatch>, token?: string): Promise<LlmEndpointTestResults>;
 }

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

@@ -69,6 +69,7 @@ import { IDataSourcePermissionAssignment } from '@gooddata/sdk-model';
 import type { IDateFilter } from '@gooddata/sdk-model';
 import { IDateFilterConfig } from '@gooddata/sdk-model';
 import { IDateHierarchyTemplate } from '@gooddata/sdk-model';
+import { IdentifierRef } from '@gooddata/sdk-model';
 import { IDimension } from '@gooddata/sdk-model';
 import { IDimensionDescriptor } from '@gooddata/sdk-model';
 import { IEntitlementDescriptor } from '@gooddata/sdk-model';
@@ -161,7 +162,6 @@ import { IWorkspaceSettings } from '@gooddata/sdk-model';
 import { IWorkspaceUser } from '@gooddata/sdk-model';
 import { IWorkspaceUserGroup } from '@gooddata/sdk-model';
 import { LlmEndpointOpenAIPatch } from '@gooddata/sdk-model';
-import { LlmEndpointTestResults } from '@gooddata/sdk-model';
 import { LlmProviderListModelsResults } from '@gooddata/sdk-model';
 import { LlmProviderPatch } from '@gooddata/sdk-model';
 import { LlmProviderTestResults } from '@gooddata/sdk-model';
@@ -1746,6 +1746,7 @@ export declare type IChatConversationKeyDriverAnalysisContent = {
 export declare type IChatConversationMultipartContent = {
     type: "multipart";
     parts: IChatConversationMultipartPart[];
+    suggestions?: IChatSuggestions;
 };
 
 /**
@@ -1882,7 +1883,7 @@ export declare interface IChatConversationThreadQuery {
     /**
      * Execute the chat thread and stream the results.
      */
-    stream(): ReadableStream<IChatConversationItem | IChatConversationError | IChatSuggestionsItem>;
+    stream(): ReadableStream<IChatConversationItem | IChatConversationError>;
 }
 
 /**
@@ -1948,23 +1949,14 @@ export declare type IChatSuggestion = {
 };
 
 /**
- * Represents an action for chat suggestions, typically used within a chat interface
- * or a search-based system to provide users with actionable suggestions.
- * @internal
- */
-export declare type IChatSuggestionsAction = {
-    label: string;
-    query: string;
-};
-
-/**
- * GenAI Chat Suggestion Item
+ * Represents AI-generated suggestions, which may include a follow-up question
+ * and a list of actions with associated labels and queries.
  * @internal
+ *
  */
-export declare type IChatSuggestionsItem = {
-    type: "suggestions";
-    followUp?: string;
-    actions?: IChatSuggestionsAction[];
+export declare type IChatSuggestions = {
+    followUpQuestion?: string;
+    actions?: IChatSuggestion[];
 };
 
 /**
@@ -5642,14 +5634,6 @@ export declare interface IOrganizationLlmEndpointsService {
      * @returns Promise resolved when the llm endpoint is patched.
      */
     patchLlmEndpoint(endpoint: LlmEndpointOpenAIPatch, token?: string): Promise<ILlmEndpointOpenAI>;
-    /**
-     * Test existing llm endpoint
-     *
-     * @param endpoint - definition of the llm endpoint
-     * @param token - token for the llm endpoint, if applicable
-     * @returns Promise resolved with test results.
-     */
-    testLlmEndpoint(endpoint: Partial<LlmEndpointOpenAIPatch>, token?: string): Promise<LlmEndpointTestResults>;
 }
 
 /**
@@ -6846,13 +6830,13 @@ export declare interface IReferencesOption {
  * @alpha
  */
 export declare interface IReferencesResult {
-    nodes: (ObjRef & {
+    nodes: (IdentifierRef & {
         title: string;
         isRoot?: boolean;
     })[];
     edges: {
-        from: ObjRef;
-        to: ObjRef;
+        from: IdentifierRef;
+        to: IdentifierRef;
     }[];
 }
 
@@ -6860,7 +6844,7 @@ export declare interface IReferencesResult {
  * @alpha
  */
 export declare interface IReferencesService {
-    getReferences(root: ObjRef, opts?: IReferencesOption): Promise<IReferencesResult>;
+    getReferences(root: IdentifierRef | IdentifierRef[], opts?: IReferencesOption): Promise<IReferencesResult>;
 }
 
 /**
@@ -6895,7 +6879,7 @@ export declare function isAnalyticalBackendError(obj: unknown): obj is Analytica
  * Is chat conversation error
  * @internal
  */
-export declare function isChatConversationError(item: Partial<IChatConversationItem | IChatConversationError | IChatSuggestionsItem>): item is IChatConversationError;
+export declare function isChatConversationError(item: Partial<IChatConversationItem | IChatConversationError>): item is IChatConversationError;
 
 /**
  * Is chat conversation item
@@ -6957,12 +6941,6 @@ export declare function isChatConversationVisualisationContent(content: IChatCon
  */
 export declare function isChatConversationWhatIfContent(content: IChatConversationMultipartPart): content is IChatConversationWhatIfContent;
 
-/**
- * Is chat conversation item
- * @internal
- */
-export declare function isChatSuggestionsItem(item: unknown): item is IChatSuggestionsItem;
-
 /**
  * Type guard checking whether input is an instance of {@link ContractExpired}
  *

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

@@ -752,7 +752,7 @@ export type IChatConversationError = {
  * Is chat conversation error
  * @internal
  */
-export declare function isChatConversationError(item: Partial<IChatConversationItem | IChatConversationError | IChatSuggestionsItem>): item is IChatConversationError;
+export declare function isChatConversationError(item: Partial<IChatConversationItem | IChatConversationError>): item is IChatConversationError;
 /**
  * GenAI Chat Conversation item
  * @internal
@@ -772,29 +772,6 @@ export type IChatConversationItem = {
  * @internal
  */
 export declare function isChatConversationItem(item: unknown): item is IChatConversationItem;
-/**
- * GenAI Chat Suggestion Item
- * @internal
- */
-export type IChatSuggestionsItem = {
-    type: "suggestions";
-    followUp?: string;
-    actions?: IChatSuggestionsAction[];
-};
-/**
- * Represents an action for chat suggestions, typically used within a chat interface
- * or a search-based system to provide users with actionable suggestions.
- * @internal
- */
-export type IChatSuggestionsAction = {
-    label: string;
-    query: string;
-};
-/**
- * Is chat conversation item
- * @internal
- */
-export declare function isChatSuggestionsItem(item: unknown): item is IChatSuggestionsItem;
 /**
  * GenAI Chat Conversation content
  * @internal
@@ -838,6 +815,7 @@ export declare function isChatConversationReasoningContent(content: IChatConvers
 export type IChatConversationMultipartContent = {
     type: "multipart";
     parts: IChatConversationMultipartPart[];
+    suggestions?: IChatSuggestions;
 };
 /**
  * Is chat conversation multipart content
@@ -1002,6 +980,16 @@ export type IChatSuggestion = {
     label: string;
     query: string;
 };
+/**
+ * Represents AI-generated suggestions, which may include a follow-up question
+ * and a list of actions with associated labels and queries.
+ * @internal
+ *
+ */
+export type IChatSuggestions = {
+    followUpQuestion?: string;
+    actions?: IChatSuggestion[];
+};
 /**
  * Chatbot conversations thread.
  * @internal
@@ -1065,5 +1053,5 @@ export interface IChatConversationThreadQuery {
     /**
      * Execute the chat thread and stream the results.
      */
-    stream(): ReadableStream<IChatConversationItem | IChatConversationError | IChatSuggestionsItem>;
+    stream(): ReadableStream<IChatConversationItem | IChatConversationError>;
 }

package/esm/workspace/genAI/index.js

@@ -13,13 +13,6 @@ export function isChatConversationError(item) {
 export function isChatConversationItem(item) {
     return typeof item === "object" && item !== null && "type" in item && item.type === "item";
 }
-/**
- * Is chat conversation item
- * @internal
- */
-export function isChatSuggestionsItem(item) {
-    return typeof item === "object" && item !== null && "type" in item && item.type === "suggestions";
-}
 /**
  * Is chat conversation text content
  * @internal

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

@@ -1,4 +1,4 @@
-import { type ObjRef } from "@gooddata/sdk-model";
+import { type IdentifierRef } from "@gooddata/sdk-model";
 /**
  * @alpha
  */
@@ -9,18 +9,18 @@ export interface IReferencesOption {
  * @alpha
  */
 export interface IReferencesResult {
-    nodes: (ObjRef & {
+    nodes: (IdentifierRef & {
         title: string;
         isRoot?: boolean;
     })[];
     edges: {
-        from: ObjRef;
-        to: ObjRef;
+        from: IdentifierRef;
+        to: IdentifierRef;
     }[];
 }
 /**
  * @alpha
  */
 export interface IReferencesService {
-    getReferences(root: ObjRef, opts?: IReferencesOption): Promise<IReferencesResult>;
+    getReferences(root: IdentifierRef | IdentifierRef[], opts?: IReferencesOption): Promise<IReferencesResult>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-backend-spi",
-  "version": "11.36.0-alpha.1",
+  "version": "11.36.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.36.0-alpha.1"
+    "@gooddata/sdk-model": "11.36.0-alpha.3"
   },
   "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.36.0-alpha.1",
-    "@gooddata/eslint-config": "11.36.0-alpha.1"
+    "@gooddata/eslint-config": "11.36.0-alpha.3",
+    "@gooddata/oxlint-config": "11.36.0-alpha.3"
   },
   "scripts": {
     "_phase:build": "npm run build",