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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/esm/index.d.ts CHANGED
@@ -21,7 +21,7 @@ export type { ExportDefinitionOrdering, IExportDefinitionsQuery, IExportDefiniti
21
21
  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";
22
22
  export type { IExportConfig, IExportResult, IExportPdfConfig } from "./workspace/execution/export.js";
23
23
  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";
24
- export type { IOrganizationGenAIService } from "./organization/genAI/index.js";
24
+ export type { IOrganizationAIObservabilityMetric, IOrganizationAIObservabilityMetricType, IOrganizationAIObservabilityOverview, IOrganizationAIObservabilityService, IOrganizationGenAIService, } from "./organization/genAI/index.js";
25
25
  export type { IReferencesResult, IReferencesOption, IReferencesService, } from "./workspace/references/index.js";
26
26
  export type { IWorkspaceStylingService } from "./workspace/styling/index.js";
27
27
  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";
@@ -1,4 +1,48 @@
1
1
  import { type IKnowledgeDocumentsService } from "../../workspace/genAI/index.js";
2
+ /**
3
+ * AI observability metric type.
4
+ *
5
+ * @alpha
6
+ */
7
+ export type IOrganizationAIObservabilityMetricType = "AI_WORKSPACES" | "AI_USERS" | "AI_QUERIES";
8
+ /**
9
+ * AI observability metric for the caller's organization.
10
+ *
11
+ * @alpha
12
+ */
13
+ export interface IOrganizationAIObservabilityMetric {
14
+ /**
15
+ * Metric type.
16
+ */
17
+ type: IOrganizationAIObservabilityMetricType;
18
+ /**
19
+ * Metric value for the current calendar month.
20
+ */
21
+ currentValue: number;
22
+ /**
23
+ * Metric value for the previous calendar month.
24
+ */
25
+ previousValue: number;
26
+ }
27
+ /**
28
+ * AI observability overview for the caller's organization.
29
+ *
30
+ * @alpha
31
+ */
32
+ export interface IOrganizationAIObservabilityOverview {
33
+ metrics: IOrganizationAIObservabilityMetric[];
34
+ }
35
+ /**
36
+ * Service for querying AI observability metrics.
37
+ *
38
+ * @alpha
39
+ */
40
+ export interface IOrganizationAIObservabilityService {
41
+ /**
42
+ * Returns AI observability overview for the caller's organization.
43
+ */
44
+ getOverview(): Promise<IOrganizationAIObservabilityOverview>;
45
+ }
2
46
  /**
3
47
  * Service to query and manage organization-level generative-AI resources.
4
48
  *
@@ -9,4 +53,8 @@ export interface IOrganizationGenAIService {
9
53
  * Returns a service for listing and managing organization-level knowledge documents.
10
54
  */
11
55
  getKnowledgeDocuments(): IKnowledgeDocumentsService;
56
+ /**
57
+ * Returns a service for querying organization-level AI observability metrics.
58
+ */
59
+ getObservability(): IOrganizationAIObservabilityService;
12
60
  }
@@ -5264,6 +5264,54 @@ export declare interface IOrganizationAgentsService {
5264
5264
  deleteAgent(ref: ObjRef): Promise<void>;
5265
5265
  }
5266
5266
 
5267
+ /**
5268
+ * AI observability metric for the caller's organization.
5269
+ *
5270
+ * @alpha
5271
+ */
5272
+ export declare interface IOrganizationAIObservabilityMetric {
5273
+ /**
5274
+ * Metric type.
5275
+ */
5276
+ type: IOrganizationAIObservabilityMetricType;
5277
+ /**
5278
+ * Metric value for the current calendar month.
5279
+ */
5280
+ currentValue: number;
5281
+ /**
5282
+ * Metric value for the previous calendar month.
5283
+ */
5284
+ previousValue: number;
5285
+ }
5286
+
5287
+ /**
5288
+ * AI observability metric type.
5289
+ *
5290
+ * @alpha
5291
+ */
5292
+ export declare type IOrganizationAIObservabilityMetricType = "AI_WORKSPACES" | "AI_USERS" | "AI_QUERIES";
5293
+
5294
+ /**
5295
+ * AI observability overview for the caller's organization.
5296
+ *
5297
+ * @alpha
5298
+ */
5299
+ export declare interface IOrganizationAIObservabilityOverview {
5300
+ metrics: IOrganizationAIObservabilityMetric[];
5301
+ }
5302
+
5303
+ /**
5304
+ * Service for querying AI observability metrics.
5305
+ *
5306
+ * @alpha
5307
+ */
5308
+ export declare interface IOrganizationAIObservabilityService {
5309
+ /**
5310
+ * Returns AI observability overview for the caller's organization.
5311
+ */
5312
+ getOverview(): Promise<IOrganizationAIObservabilityOverview>;
5313
+ }
5314
+
5267
5315
  /**
5268
5316
  * This service provides access to organization-wide automations for centralized automation management.
5269
5317
  * It allows managing automations across all workspaces within the organization.
@@ -5504,6 +5552,10 @@ export declare interface IOrganizationGenAIService {
5504
5552
  * Returns a service for listing and managing organization-level knowledge documents.
5505
5553
  */
5506
5554
  getKnowledgeDocuments(): IKnowledgeDocumentsService;
5555
+ /**
5556
+ * Returns a service for querying organization-level AI observability metrics.
5557
+ */
5558
+ getObservability(): IOrganizationAIObservabilityService;
5507
5559
  }
5508
5560
 
5509
5561
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooddata/sdk-backend-spi",
3
- "version": "11.41.0-alpha.1",
3
+ "version": "11.41.0-alpha.2",
4
4
  "description": "GoodData Backend SPI abstraction interfaces",
5
5
  "license": "MIT",
6
6
  "author": "GoodData",
@@ -24,7 +24,7 @@
24
24
  "lodash-es": "^4.17.23",
25
25
  "ts-invariant": "0.10.3",
26
26
  "tslib": "2.8.1",
27
- "@gooddata/sdk-model": "11.41.0-alpha.1"
27
+ "@gooddata/sdk-model": "11.41.0-alpha.2"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@microsoft/api-documenter": "^7.17.0",
@@ -48,8 +48,8 @@
48
48
  "oxlint-tsgolint": "0.15.0",
49
49
  "typescript": "5.9.3",
50
50
  "vitest": "4.1.8",
51
- "@gooddata/eslint-config": "11.41.0-alpha.1",
52
- "@gooddata/oxlint-config": "11.41.0-alpha.1"
51
+ "@gooddata/oxlint-config": "11.41.0-alpha.2",
52
+ "@gooddata/eslint-config": "11.41.0-alpha.2"
53
53
  },
54
54
  "scripts": {
55
55
  "_phase:build": "npm run build",