@gooddata/sdk-backend-spi 11.41.0-alpha.0 → 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 +2 -1
- package/esm/organization/genAI/index.d.ts +48 -0
- package/esm/organization/index.d.ts +7 -0
- package/esm/organization/ipAllowlists/index.d.ts +34 -0
- package/esm/organization/ipAllowlists/index.js +2 -0
- package/esm/sdk-backend-spi.d.ts +95 -1
- package/esm/workspace/genAI/index.d.ts +1 -1
- package/package.json +4 -4
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";
|
|
@@ -56,6 +56,7 @@ export type { IOrganizationUserService, IOrganizationUsersQuery, IOrganizationUs
|
|
|
56
56
|
export type { IOrganizationPermissionService, IPermissionsAssignment, } from "./organization/permissions/index.js";
|
|
57
57
|
export type { IOrganizationNotificationChannelService } from "./organization/notificationChannels/index.js";
|
|
58
58
|
export type { IOrganizationGeoCollectionsService } from "./organization/geoCollections/index.js";
|
|
59
|
+
export type { IOrganizationIpAllowlistService } from "./organization/ipAllowlists/index.js";
|
|
59
60
|
export type { INotificationChannelsQuery, INotificationChannelsQueryResult, INotificationChannelIdentifiersQueryResult, } from "./organization/notificationChannels/query.js";
|
|
60
61
|
export type { IDataFiltersService } from "./workspace/dataFilter/index.js";
|
|
61
62
|
export type { IWorkspaceLogicalModelService, IDateDataset } from "./workspace/ldm/model.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
|
}
|
|
@@ -3,6 +3,7 @@ import { type IOrganizationAgentsService } from "./agents/index.js";
|
|
|
3
3
|
import { type IOrganizationAutomationService } from "./automations/index.js";
|
|
4
4
|
import { type IOrganizationExportTemplatesService } from "./exportTemplates/index.js";
|
|
5
5
|
import { type IOrganizationGenAIService } from "./genAI/index.js";
|
|
6
|
+
import { type IOrganizationIpAllowlistService } from "./ipAllowlists/index.js";
|
|
6
7
|
import { type IOrganizationLlmProvidersService } from "./llmProviders/index.js";
|
|
7
8
|
import { type IOrganizationNotificationChannelService } from "./notificationChannels/index.js";
|
|
8
9
|
import { type IOrganizationNotificationService } from "./notifications/index.js";
|
|
@@ -90,6 +91,12 @@ export interface IOrganization {
|
|
|
90
91
|
* @beta
|
|
91
92
|
*/
|
|
92
93
|
exportTemplates(): IOrganizationExportTemplatesService;
|
|
94
|
+
/**
|
|
95
|
+
* Returns service that can be used to manage organization-level IP allowlist policies.
|
|
96
|
+
*
|
|
97
|
+
* @alpha
|
|
98
|
+
*/
|
|
99
|
+
ipAllowlists(): IOrganizationIpAllowlistService;
|
|
93
100
|
}
|
|
94
101
|
/**
|
|
95
102
|
* Provides functions to obtain {@link IOrganization} instances
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { type IIpAllowlist, type IIpAllowlistDefinition } from "@gooddata/sdk-model";
|
|
2
|
+
/**
|
|
3
|
+
* Service for managing organization-level IP allowlist policies.
|
|
4
|
+
*
|
|
5
|
+
* @alpha
|
|
6
|
+
*/
|
|
7
|
+
export interface IOrganizationIpAllowlistService {
|
|
8
|
+
/**
|
|
9
|
+
* Get all IP allowlist policies defined for the organization.
|
|
10
|
+
*
|
|
11
|
+
* @returns Promise resolved with an array of policies (empty when none exist).
|
|
12
|
+
*/
|
|
13
|
+
getAll(): Promise<IIpAllowlist[]>;
|
|
14
|
+
/**
|
|
15
|
+
* Create a new IP allowlist policy.
|
|
16
|
+
*
|
|
17
|
+
* @param definition - definition of the policy to create
|
|
18
|
+
* @returns Promise resolved with the created policy.
|
|
19
|
+
*/
|
|
20
|
+
create(definition: IIpAllowlistDefinition): Promise<IIpAllowlist>;
|
|
21
|
+
/**
|
|
22
|
+
* Replace an existing IP allowlist policy (PUT semantics).
|
|
23
|
+
*
|
|
24
|
+
* @param definition - full definition of the policy; `id` identifies the target
|
|
25
|
+
* @returns Promise resolved with the updated policy.
|
|
26
|
+
*/
|
|
27
|
+
update(definition: IIpAllowlistDefinition): Promise<IIpAllowlist>;
|
|
28
|
+
/**
|
|
29
|
+
* Delete an IP allowlist policy by its identifier.
|
|
30
|
+
*
|
|
31
|
+
* @param id - identifier of the policy to delete
|
|
32
|
+
*/
|
|
33
|
+
delete(id: string): Promise<void>;
|
|
34
|
+
}
|
package/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -98,6 +98,8 @@ import { IGeoJsonFeature } from '@gooddata/sdk-model';
|
|
|
98
98
|
import { IGranularAccessGrantee } from '@gooddata/sdk-model';
|
|
99
99
|
import { IInsight } from '@gooddata/sdk-model';
|
|
100
100
|
import { IInsightDefinition } from '@gooddata/sdk-model';
|
|
101
|
+
import { IIpAllowlist } from '@gooddata/sdk-model';
|
|
102
|
+
import { IIpAllowlistDefinition } from '@gooddata/sdk-model';
|
|
101
103
|
import type { IListedDashboard } from '@gooddata/sdk-model';
|
|
102
104
|
import { ILlmProvider } from '@gooddata/sdk-model';
|
|
103
105
|
import { IMeasure } from '@gooddata/sdk-model';
|
|
@@ -1667,7 +1669,7 @@ export declare type IChatConversationError = {
|
|
|
1667
1669
|
code: number;
|
|
1668
1670
|
message: string;
|
|
1669
1671
|
traceId?: string;
|
|
1670
|
-
reason?: (string & {}) | "METADATA_SYNC_IN_PROGRESS" | "METADATA_SYNC_REQUEST_ERROR";
|
|
1672
|
+
reason?: (string & {}) | "METADATA_SYNC_IN_PROGRESS" | "METADATA_SYNC_REQUEST_ERROR" | "MODEL_NOT_COMPATIBLE";
|
|
1671
1673
|
};
|
|
1672
1674
|
|
|
1673
1675
|
/**
|
|
@@ -5199,6 +5201,12 @@ export declare interface IOrganization {
|
|
|
5199
5201
|
* @beta
|
|
5200
5202
|
*/
|
|
5201
5203
|
exportTemplates(): IOrganizationExportTemplatesService;
|
|
5204
|
+
/**
|
|
5205
|
+
* Returns service that can be used to manage organization-level IP allowlist policies.
|
|
5206
|
+
*
|
|
5207
|
+
* @alpha
|
|
5208
|
+
*/
|
|
5209
|
+
ipAllowlists(): IOrganizationIpAllowlistService;
|
|
5202
5210
|
}
|
|
5203
5211
|
|
|
5204
5212
|
/**
|
|
@@ -5256,6 +5264,54 @@ export declare interface IOrganizationAgentsService {
|
|
|
5256
5264
|
deleteAgent(ref: ObjRef): Promise<void>;
|
|
5257
5265
|
}
|
|
5258
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
|
+
|
|
5259
5315
|
/**
|
|
5260
5316
|
* This service provides access to organization-wide automations for centralized automation management.
|
|
5261
5317
|
* It allows managing automations across all workspaces within the organization.
|
|
@@ -5496,6 +5552,10 @@ export declare interface IOrganizationGenAIService {
|
|
|
5496
5552
|
* Returns a service for listing and managing organization-level knowledge documents.
|
|
5497
5553
|
*/
|
|
5498
5554
|
getKnowledgeDocuments(): IKnowledgeDocumentsService;
|
|
5555
|
+
/**
|
|
5556
|
+
* Returns a service for querying organization-level AI observability metrics.
|
|
5557
|
+
*/
|
|
5558
|
+
getObservability(): IOrganizationAIObservabilityService;
|
|
5499
5559
|
}
|
|
5500
5560
|
|
|
5501
5561
|
/**
|
|
@@ -5566,6 +5626,40 @@ export declare interface IOrganizationGeoCollectionsService {
|
|
|
5566
5626
|
importGeoCollectionFile(collectionId: string, location: string): Promise<void>;
|
|
5567
5627
|
}
|
|
5568
5628
|
|
|
5629
|
+
/**
|
|
5630
|
+
* Service for managing organization-level IP allowlist policies.
|
|
5631
|
+
*
|
|
5632
|
+
* @alpha
|
|
5633
|
+
*/
|
|
5634
|
+
export declare interface IOrganizationIpAllowlistService {
|
|
5635
|
+
/**
|
|
5636
|
+
* Get all IP allowlist policies defined for the organization.
|
|
5637
|
+
*
|
|
5638
|
+
* @returns Promise resolved with an array of policies (empty when none exist).
|
|
5639
|
+
*/
|
|
5640
|
+
getAll(): Promise<IIpAllowlist[]>;
|
|
5641
|
+
/**
|
|
5642
|
+
* Create a new IP allowlist policy.
|
|
5643
|
+
*
|
|
5644
|
+
* @param definition - definition of the policy to create
|
|
5645
|
+
* @returns Promise resolved with the created policy.
|
|
5646
|
+
*/
|
|
5647
|
+
create(definition: IIpAllowlistDefinition): Promise<IIpAllowlist>;
|
|
5648
|
+
/**
|
|
5649
|
+
* Replace an existing IP allowlist policy (PUT semantics).
|
|
5650
|
+
*
|
|
5651
|
+
* @param definition - full definition of the policy; `id` identifies the target
|
|
5652
|
+
* @returns Promise resolved with the updated policy.
|
|
5653
|
+
*/
|
|
5654
|
+
update(definition: IIpAllowlistDefinition): Promise<IIpAllowlist>;
|
|
5655
|
+
/**
|
|
5656
|
+
* Delete an IP allowlist policy by its identifier.
|
|
5657
|
+
*
|
|
5658
|
+
* @param id - identifier of the policy to delete
|
|
5659
|
+
*/
|
|
5660
|
+
delete(id: string): Promise<void>;
|
|
5661
|
+
}
|
|
5662
|
+
|
|
5569
5663
|
/**
|
|
5570
5664
|
* This service provides access to organization llm providers configuration.
|
|
5571
5665
|
*
|
|
@@ -746,7 +746,7 @@ export type IChatConversationError = {
|
|
|
746
746
|
code: number;
|
|
747
747
|
message: string;
|
|
748
748
|
traceId?: string;
|
|
749
|
-
reason?: (string & {}) | "METADATA_SYNC_IN_PROGRESS" | "METADATA_SYNC_REQUEST_ERROR";
|
|
749
|
+
reason?: (string & {}) | "METADATA_SYNC_IN_PROGRESS" | "METADATA_SYNC_REQUEST_ERROR" | "MODEL_NOT_COMPATIBLE";
|
|
750
750
|
};
|
|
751
751
|
/**
|
|
752
752
|
* Is chat conversation error
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-spi",
|
|
3
|
-
"version": "11.41.0-alpha.
|
|
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.
|
|
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/
|
|
52
|
-
"@gooddata/
|
|
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",
|