@gooddata/sdk-backend-spi 10.13.0-alpha.3 → 10.13.0-alpha.31
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/index.d.ts.map +1 -1
- package/esm/index.js.map +1 -1
- package/esm/organization/index.d.ts +6 -1
- package/esm/organization/index.d.ts.map +1 -1
- package/esm/organization/llmEndpoints/index.d.ts +59 -0
- package/esm/organization/llmEndpoints/index.d.ts.map +1 -0
- package/esm/organization/llmEndpoints/index.js +3 -0
- package/esm/organization/llmEndpoints/index.js.map +1 -0
- package/esm/sdk-backend-spi.d.ts +142 -15
- package/esm/workspace/dataFilter/index.d.ts +28 -1
- package/esm/workspace/dataFilter/index.d.ts.map +1 -1
- package/esm/workspace/genAI/index.d.ts +43 -13
- package/esm/workspace/genAI/index.d.ts.map +1 -1
- package/esm/workspace/index.d.ts +1 -1
- package/esm/workspace/index.d.ts.map +1 -1
- package/package.json +2 -2
package/esm/index.d.ts
CHANGED
|
@@ -21,7 +21,7 @@ export type { ExportDefinitionOrdering, IExportDefinitionsQuery, IExportDefiniti
|
|
|
21
21
|
export type { IElementsQueryFactory, IElementsQueryResult, IElementsQuery, IElementsQueryOptions, IElementsQueryAttributeFilter, IElementsQueryOptionsElementsByUri, IElementsQueryOptionsElementsByValue, IElementsQueryOptionsElementsByPrimaryDisplayFormValue, ElementsQueryOptionsElementsSpecification, IFilterElementsQuery, FilterWithResolvableElements, } from "./workspace/attributes/elements/index.js";
|
|
22
22
|
export { isElementsQueryOptionsElementsByValue, isElementsQueryOptionsElementsByPrimaryDisplayFormValue, isValueBasedElementsQueryOptionsElements, } from "./workspace/attributes/elements/index.js";
|
|
23
23
|
export type { IExportConfig, IExportResult, IExportPdfConfig } from "./workspace/execution/export.js";
|
|
24
|
-
export type { IGenAIService, ISemanticSearchQuery, ISemanticSearchResult, IChatThread, } from "./workspace/genAI/index.js";
|
|
24
|
+
export type { IGenAIService, ISemanticSearchQuery, ISemanticSearchResult, IChatThread, IChatThreadHistory, IChatThreadQuery, IGenAIChatEvaluation, } from "./workspace/genAI/index.js";
|
|
25
25
|
export type { IWorkspaceStylingService } from "./workspace/styling/index.js";
|
|
26
26
|
export type { NotAuthenticatedReason, ErrorConverter, AuthenticationFlow } from "./errors/index.js";
|
|
27
27
|
export { AnalyticalBackendError, NoDataError, DataTooLargeError, TimeoutError, ProtectedDataError, UnexpectedResponseError, UnexpectedError, NotSupported, NotImplemented, NotAuthenticated, LimitReached, ContractExpired, isAnalyticalBackendError, isNoDataError, isDataTooLargeError, isProtectedDataError, isUnexpectedResponseError, isUnexpectedError, isNotSupported, isNotImplemented, isNotAuthenticated, isLimitReached, isContractExpired, AnalyticalBackendErrorTypes, } from "./errors/index.js";
|
|
@@ -54,4 +54,5 @@ export type { IOrganizationNotificationChannelService } from "./organization/not
|
|
|
54
54
|
export type { IDataFiltersService } from "./workspace/dataFilter/index.js";
|
|
55
55
|
export type { IWorkspaceLogicalModelService, IDateDataset } from "./workspace/ldm/model.js";
|
|
56
56
|
export type { IWorkspaceAutomationService, IGetAutomationOptions, IGetAutomationsOptions, AutomationType, IAutomationsQuery, IAutomationsQueryResult, } from "./workspace/automations/index.js";
|
|
57
|
+
export type { IOrganizationLlmEndpointsService } from "./organization/llmEndpoints/index.js";
|
|
57
58
|
//# sourceMappingURL=index.d.ts.map
|
package/esm/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,YAAY,EACR,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEtG,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,YAAY,EACR,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,gCAAgC,CAAC;AAExC,YAAY,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE/E,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE7E,YAAY,EACR,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAC3C,MAAM,0CAA0C,CAAC;AAElD,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEtG,YAAY,EACR,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,YAAY,EACR,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEtG,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,YAAY,EACR,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,gCAAgC,CAAC;AAExC,YAAY,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE/E,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE7E,YAAY,EACR,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAC3C,MAAM,0CAA0C,CAAC;AAElD,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEtG,YAAY,EACR,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,GACvB,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAC7E,YAAY,EAAE,sBAAsB,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACpG,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,YAAY,EACR,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAE9F,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,YAAY,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAEnF,YAAY,EACR,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,+BAA+B,CAAC;AAEvC,YAAY,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEzE,YAAY,EACR,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AACzC,YAAY,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AACzF,OAAO,EACH,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACR,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACR,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,YAAY,EACR,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,YAAY,EACR,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC7E,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAClE,YAAY,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC5G,YAAY,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AACnF,YAAY,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,YAAY,EACR,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEzF,YAAY,EACR,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACR,8BAA8B,EAC9B,sBAAsB,GACzB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AAC5G,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,YAAY,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE5F,YAAY,EACR,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,iBAAiB,EACjB,uBAAuB,GAC1B,MAAM,kCAAkC,CAAC;AAE1C,YAAY,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC"}
|
package/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAsEtD,OAAO,EACH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAC3C,MAAM,0CAA0C,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAsEtD,OAAO,EACH,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,GAC3C,MAAM,0CAA0C,CAAC;AAgBlD,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AA4C3B,OAAO,EACH,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC"}
|
|
@@ -5,6 +5,7 @@ import { IOrganizationStylingService } from "./styling/index.js";
|
|
|
5
5
|
import { IOrganizationUserService } from "./users/index.js";
|
|
6
6
|
import { IOrganizationPermissionService } from "./permissions/index.js";
|
|
7
7
|
import { IOrganizationNotificationChannelService } from "./notificationChannels/index.js";
|
|
8
|
+
import { IOrganizationLlmEndpointsService } from "./llmEndpoints/index.js";
|
|
8
9
|
/**
|
|
9
10
|
* Represents an organization that services analytical workspaces.
|
|
10
11
|
*
|
|
@@ -26,7 +27,7 @@ export interface IOrganization {
|
|
|
26
27
|
*
|
|
27
28
|
* @param descriptor - properties to update
|
|
28
29
|
*/
|
|
29
|
-
updateDescriptor(descriptor: IOrganizationDescriptorUpdate): Promise<
|
|
30
|
+
updateDescriptor(descriptor: IOrganizationDescriptorUpdate): Promise<IOrganizationDescriptor>;
|
|
30
31
|
/**
|
|
31
32
|
* Returns service that can be used to query and update organization security settings.
|
|
32
33
|
*/
|
|
@@ -51,6 +52,10 @@ export interface IOrganization {
|
|
|
51
52
|
* Returns service that can be used to query and manage organization notification channels.
|
|
52
53
|
*/
|
|
53
54
|
notificationChannels(): IOrganizationNotificationChannelService;
|
|
55
|
+
/**
|
|
56
|
+
* Returns service that can be used to query and manage organization LLM endpoints.
|
|
57
|
+
*/
|
|
58
|
+
llmEndpoints(): IOrganizationLlmEndpointsService;
|
|
54
59
|
}
|
|
55
60
|
/**
|
|
56
61
|
* Provides functions to obtain {@link IOrganization} instances
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/organization/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,uCAAuC,EAAE,MAAM,iCAAiC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/organization/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,uCAAuC,EAAE,MAAM,iCAAiC,CAAC;AAC1F,OAAO,EAAE,gCAAgC,EAAE,MAAM,yBAAyB,CAAC;AAE3E;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC;;;;OAIG;IACH,aAAa,CAAC,wBAAwB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEpF;;;;OAIG;IACH,gBAAgB,CAAC,UAAU,EAAE,6BAA6B,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE9F;;OAEG;IACH,gBAAgB,IAAI,wBAAwB,CAAC;IAE7C;;OAEG;IACH,OAAO,IAAI,2BAA2B,CAAC;IAEvC;;OAEG;IACH,QAAQ,IAAI,4BAA4B,CAAC;IAEzC;;OAEG;IACH,KAAK,IAAI,wBAAwB,CAAC;IAElC;;OAEG;IACH,WAAW,IAAI,8BAA8B,CAAC;IAE9C;;OAEG;IACH,oBAAoB,IAAI,uCAAuC,CAAC;IAEhE;;OAEG;IACH,YAAY,IAAI,gCAAgC,CAAC;CACpD;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,sBAAsB,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;CACpD"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { ILlmEndpointOpenAI, LlmEndpointOpenAIPatch } from "@gooddata/sdk-model";
|
|
2
|
+
/**
|
|
3
|
+
* This service provides access to organization llm endpoints configuration.
|
|
4
|
+
*
|
|
5
|
+
* @alpha
|
|
6
|
+
*/
|
|
7
|
+
export interface IOrganizationLlmEndpointsService {
|
|
8
|
+
/**
|
|
9
|
+
* Get count of all llm endpoints
|
|
10
|
+
*
|
|
11
|
+
* @returns Promise resolved with number of llm endpoints.
|
|
12
|
+
*/
|
|
13
|
+
getCount(): Promise<number>;
|
|
14
|
+
/**
|
|
15
|
+
* Get all llm endpoints
|
|
16
|
+
*
|
|
17
|
+
* @returns Promise resolved with array of llm endpoints.
|
|
18
|
+
*/
|
|
19
|
+
getAll(): Promise<ILlmEndpointOpenAI[]>;
|
|
20
|
+
/**
|
|
21
|
+
* Delete an endpoint
|
|
22
|
+
*
|
|
23
|
+
* @param id - id of the endpoint
|
|
24
|
+
* @returns Promise resolved when the endpoint is deleted.
|
|
25
|
+
*/
|
|
26
|
+
deleteLlmEndpoint(id: string): Promise<void>;
|
|
27
|
+
/**
|
|
28
|
+
* Get llm endpoint by id
|
|
29
|
+
*
|
|
30
|
+
* @param id - id of the endpoint
|
|
31
|
+
* @returns Promise resolved with endpoint.
|
|
32
|
+
*/
|
|
33
|
+
getLlmEndpoint(id: string): Promise<ILlmEndpointOpenAI | undefined>;
|
|
34
|
+
/**
|
|
35
|
+
* Create a new llm endpoint
|
|
36
|
+
*
|
|
37
|
+
* @param endpoint - definition of the llm endpoint
|
|
38
|
+
* @param token - token for the llm endpoint, if applicable
|
|
39
|
+
* @returns Promise resolved with created llm endpoint.
|
|
40
|
+
*/
|
|
41
|
+
createLlmEndpoint(endpoint: ILlmEndpointOpenAI, token?: string): Promise<ILlmEndpointOpenAI>;
|
|
42
|
+
/**
|
|
43
|
+
* Update existing llm endpoint
|
|
44
|
+
*
|
|
45
|
+
* @param endpoint - definition of the llm endpoint
|
|
46
|
+
* @param token - token for the llm endpoint, if applicable
|
|
47
|
+
* @returns Promise resolved when the llm endpoint is updated.
|
|
48
|
+
*/
|
|
49
|
+
updateLlmEndpoint(endpoint: ILlmEndpointOpenAI, token?: string): Promise<ILlmEndpointOpenAI>;
|
|
50
|
+
/**
|
|
51
|
+
* Patch existing llm endpoint
|
|
52
|
+
*
|
|
53
|
+
* @param endpoint - definition of the llm endpoint
|
|
54
|
+
* @param token - token for the llm endpoint, if applicable
|
|
55
|
+
* @returns Promise resolved when the llm endpoint is patched.
|
|
56
|
+
*/
|
|
57
|
+
patchLlmEndpoint(endpoint: LlmEndpointOpenAIPatch, token?: string): Promise<ILlmEndpointOpenAI>;
|
|
58
|
+
}
|
|
59
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/organization/llmEndpoints/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC7C;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5B;;;;OAIG;IACH,MAAM,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAExC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;OAKG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAEpE;;;;;;OAMG;IACH,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE7F;;;;;;OAMG;IACH,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE7F;;;;;;OAMG;IACH,gBAAgB,CAAC,QAAQ,EAAE,sBAAsB,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACnG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/organization/llmEndpoints/index.ts"],"names":[],"mappings":"AAAA,qCAAqC"}
|
package/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -64,13 +64,16 @@ import { IExportDefinitionMetadataObject } from '@gooddata/sdk-model';
|
|
|
64
64
|
import { IExportDefinitionMetadataObjectDefinition } from '@gooddata/sdk-model';
|
|
65
65
|
import { IFilter } from '@gooddata/sdk-model';
|
|
66
66
|
import { IFilterContextDefinition } from '@gooddata/sdk-model';
|
|
67
|
-
import { IGenAIChatEvaluation } from '@gooddata/sdk-model';
|
|
68
67
|
import { IGenAIChatInteraction } from '@gooddata/sdk-model';
|
|
68
|
+
import { IGenAIChatRouting } from '@gooddata/sdk-model';
|
|
69
|
+
import { IGenAICreatedVisualizations } from '@gooddata/sdk-model';
|
|
70
|
+
import { IGenAIFoundObjects } from '@gooddata/sdk-model';
|
|
69
71
|
import { IGenAIUserContext } from '@gooddata/sdk-model';
|
|
70
72
|
import { IGranularAccessGrantee } from '@gooddata/sdk-model';
|
|
71
73
|
import { IInsight } from '@gooddata/sdk-model';
|
|
72
74
|
import { IInsightDefinition } from '@gooddata/sdk-model';
|
|
73
75
|
import { IListedDashboard } from '@gooddata/sdk-model';
|
|
76
|
+
import { ILlmEndpointOpenAI } from '@gooddata/sdk-model';
|
|
74
77
|
import { IMeasure } from '@gooddata/sdk-model';
|
|
75
78
|
import { IMeasureMetadataObject } from '@gooddata/sdk-model';
|
|
76
79
|
import { IMeasureMetadataObjectDefinition } from '@gooddata/sdk-model';
|
|
@@ -110,10 +113,12 @@ import { IWidgetAlert } from '@gooddata/sdk-model';
|
|
|
110
113
|
import { IWidgetAlertDefinition } from '@gooddata/sdk-model';
|
|
111
114
|
import { IWidgetDefinition } from '@gooddata/sdk-model';
|
|
112
115
|
import { IWorkspaceDataFilter } from '@gooddata/sdk-model';
|
|
116
|
+
import { IWorkspaceDataFilterDefinition } from '@gooddata/sdk-model';
|
|
113
117
|
import { IWorkspacePermissionAssignment } from '@gooddata/sdk-model';
|
|
114
118
|
import { IWorkspacePermissions } from '@gooddata/sdk-model';
|
|
115
119
|
import { IWorkspaceUser } from '@gooddata/sdk-model';
|
|
116
120
|
import { IWorkspaceUserGroup } from '@gooddata/sdk-model';
|
|
121
|
+
import { LlmEndpointOpenAIPatch } from '@gooddata/sdk-model';
|
|
117
122
|
import { ObjectType } from '@gooddata/sdk-model';
|
|
118
123
|
import { ObjRef } from '@gooddata/sdk-model';
|
|
119
124
|
import { OrganizationPermissionAssignment } from '@gooddata/sdk-model';
|
|
@@ -436,7 +441,7 @@ export declare interface IAnalyticalWorkspace {
|
|
|
436
441
|
*
|
|
437
442
|
* @param descriptor - properties to update
|
|
438
443
|
*/
|
|
439
|
-
updateDescriptor(descriptor: IWorkspaceDescriptorUpdate): Promise<
|
|
444
|
+
updateDescriptor(descriptor: IWorkspaceDescriptorUpdate): Promise<IWorkspaceDescriptor>;
|
|
440
445
|
/**
|
|
441
446
|
* Returns parent analytical workspace when this workspace has a parent, undefined otherwise.
|
|
442
447
|
*/
|
|
@@ -1077,31 +1082,52 @@ export declare interface ICancelable<T> {
|
|
|
1077
1082
|
}
|
|
1078
1083
|
|
|
1079
1084
|
/**
|
|
1080
|
-
* Chatbot thread
|
|
1081
|
-
* @
|
|
1085
|
+
* Chatbot thread.
|
|
1086
|
+
* @beta
|
|
1082
1087
|
*/
|
|
1083
1088
|
export declare interface IChatThread {
|
|
1084
1089
|
/**
|
|
1085
|
-
*
|
|
1090
|
+
* Load chat history for the chat thread.
|
|
1091
|
+
*/
|
|
1092
|
+
loadHistory(fromInteractionId?: number, options?: {
|
|
1093
|
+
signal?: AbortSignal;
|
|
1094
|
+
}): Promise<IChatThreadHistory>;
|
|
1095
|
+
/**
|
|
1096
|
+
* Reset the chat thread history.
|
|
1086
1097
|
*/
|
|
1087
|
-
|
|
1098
|
+
reset(): Promise<void>;
|
|
1099
|
+
/**
|
|
1100
|
+
* Add a user message to the chat thread.
|
|
1101
|
+
*/
|
|
1102
|
+
query(userMessage: string): IChatThreadQuery;
|
|
1103
|
+
}
|
|
1104
|
+
|
|
1105
|
+
/**
|
|
1106
|
+
* Chatbot thread history.
|
|
1107
|
+
* @beta
|
|
1108
|
+
*/
|
|
1109
|
+
export declare interface IChatThreadHistory {
|
|
1110
|
+
interactions: IGenAIChatInteraction[];
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
/**
|
|
1114
|
+
* Chatbot thread query builder.
|
|
1115
|
+
* @beta
|
|
1116
|
+
*/
|
|
1117
|
+
export declare interface IChatThreadQuery {
|
|
1088
1118
|
/**
|
|
1089
1119
|
* Define the limit for the number of search results returned by the chat thread.
|
|
1090
1120
|
*/
|
|
1091
|
-
withSearchLimit(searchLimit: number):
|
|
1121
|
+
withSearchLimit(searchLimit: number): IChatThreadQuery;
|
|
1092
1122
|
/**
|
|
1093
1123
|
* Define the limit for the number of created visualization returned by the chat thread.
|
|
1094
1124
|
*/
|
|
1095
|
-
withCreateLimit(createLimit: number):
|
|
1125
|
+
withCreateLimit(createLimit: number): IChatThreadQuery;
|
|
1096
1126
|
/**
|
|
1097
1127
|
* Define the user context for the chat thread.
|
|
1098
1128
|
* For example, what dashboard the user is currently looking at.
|
|
1099
1129
|
*/
|
|
1100
|
-
withUserContext(userContext: IGenAIUserContext):
|
|
1101
|
-
/**
|
|
1102
|
-
* Define the chat history for the chat thread.
|
|
1103
|
-
*/
|
|
1104
|
-
withChatHistory(chatHistory: IGenAIChatInteraction[]): IChatThread;
|
|
1130
|
+
withUserContext(userContext: IGenAIUserContext): IChatThreadQuery;
|
|
1105
1131
|
/**
|
|
1106
1132
|
* Execute the chat thread.
|
|
1107
1133
|
*/
|
|
@@ -1240,7 +1266,34 @@ export declare interface IDashboardWithReferences {
|
|
|
1240
1266
|
* @alpha
|
|
1241
1267
|
*/
|
|
1242
1268
|
export declare interface IDataFiltersService {
|
|
1269
|
+
/**
|
|
1270
|
+
* Get data filters for the current workspace with their settings.
|
|
1271
|
+
*
|
|
1272
|
+
* @deprecated - the function has been renamed, use {@link IDataFiltersService#getDataFilters} instead
|
|
1273
|
+
* @alpha
|
|
1274
|
+
*/
|
|
1243
1275
|
getWorkspaceDataFilters(): Promise<IWorkspaceDataFilter[]>;
|
|
1276
|
+
/**
|
|
1277
|
+
* Get data filters for the current workspace with their settings.
|
|
1278
|
+
*/
|
|
1279
|
+
getDataFilters(): Promise<IWorkspaceDataFilter[]>;
|
|
1280
|
+
/**
|
|
1281
|
+
* Create a new data filter (without setting).
|
|
1282
|
+
*/
|
|
1283
|
+
createDataFilter(newDataFilter: IWorkspaceDataFilterDefinition): Promise<IWorkspaceDataFilter>;
|
|
1284
|
+
/**
|
|
1285
|
+
* Update an existing data filter.
|
|
1286
|
+
* The setting is not updated, only the data filter.
|
|
1287
|
+
*/
|
|
1288
|
+
updateDataFilter(updatedDataFilter: IWorkspaceDataFilter): Promise<IWorkspaceDataFilter>;
|
|
1289
|
+
/**
|
|
1290
|
+
* Update value of existing data filter.
|
|
1291
|
+
*/
|
|
1292
|
+
updateDataFilterValue(dataFilter: ObjRef, values: string[]): Promise<void>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Delete an existing data filter.
|
|
1295
|
+
*/
|
|
1296
|
+
deleteDataFilter(ref: ObjRef): Promise<void>;
|
|
1244
1297
|
}
|
|
1245
1298
|
|
|
1246
1299
|
/**
|
|
@@ -2161,7 +2214,19 @@ export declare interface IForecastView {
|
|
|
2161
2214
|
}
|
|
2162
2215
|
|
|
2163
2216
|
/**
|
|
2164
|
-
* GenAI
|
|
2217
|
+
* GenAI chat evaluation result.
|
|
2218
|
+
* @beta
|
|
2219
|
+
*/
|
|
2220
|
+
export declare interface IGenAIChatEvaluation {
|
|
2221
|
+
routing: IGenAIChatRouting;
|
|
2222
|
+
textResponse?: string;
|
|
2223
|
+
foundObjects?: IGenAIFoundObjects;
|
|
2224
|
+
createdVisualizations?: IGenAICreatedVisualizations;
|
|
2225
|
+
chatHistoryThreadId?: string;
|
|
2226
|
+
}
|
|
2227
|
+
|
|
2228
|
+
/**
|
|
2229
|
+
* GenAI-powered features.
|
|
2165
2230
|
* @beta
|
|
2166
2231
|
*/
|
|
2167
2232
|
export declare interface IGenAIService {
|
|
@@ -2589,7 +2654,7 @@ export declare interface IOrganization {
|
|
|
2589
2654
|
*
|
|
2590
2655
|
* @param descriptor - properties to update
|
|
2591
2656
|
*/
|
|
2592
|
-
updateDescriptor(descriptor: IOrganizationDescriptorUpdate): Promise<
|
|
2657
|
+
updateDescriptor(descriptor: IOrganizationDescriptorUpdate): Promise<IOrganizationDescriptor>;
|
|
2593
2658
|
/**
|
|
2594
2659
|
* Returns service that can be used to query and update organization security settings.
|
|
2595
2660
|
*/
|
|
@@ -2614,6 +2679,68 @@ export declare interface IOrganization {
|
|
|
2614
2679
|
* Returns service that can be used to query and manage organization notification channels.
|
|
2615
2680
|
*/
|
|
2616
2681
|
notificationChannels(): IOrganizationNotificationChannelService;
|
|
2682
|
+
/**
|
|
2683
|
+
* Returns service that can be used to query and manage organization LLM endpoints.
|
|
2684
|
+
*/
|
|
2685
|
+
llmEndpoints(): IOrganizationLlmEndpointsService;
|
|
2686
|
+
}
|
|
2687
|
+
|
|
2688
|
+
/**
|
|
2689
|
+
* This service provides access to organization llm endpoints configuration.
|
|
2690
|
+
*
|
|
2691
|
+
* @alpha
|
|
2692
|
+
*/
|
|
2693
|
+
export declare interface IOrganizationLlmEndpointsService {
|
|
2694
|
+
/**
|
|
2695
|
+
* Get count of all llm endpoints
|
|
2696
|
+
*
|
|
2697
|
+
* @returns Promise resolved with number of llm endpoints.
|
|
2698
|
+
*/
|
|
2699
|
+
getCount(): Promise<number>;
|
|
2700
|
+
/**
|
|
2701
|
+
* Get all llm endpoints
|
|
2702
|
+
*
|
|
2703
|
+
* @returns Promise resolved with array of llm endpoints.
|
|
2704
|
+
*/
|
|
2705
|
+
getAll(): Promise<ILlmEndpointOpenAI[]>;
|
|
2706
|
+
/**
|
|
2707
|
+
* Delete an endpoint
|
|
2708
|
+
*
|
|
2709
|
+
* @param id - id of the endpoint
|
|
2710
|
+
* @returns Promise resolved when the endpoint is deleted.
|
|
2711
|
+
*/
|
|
2712
|
+
deleteLlmEndpoint(id: string): Promise<void>;
|
|
2713
|
+
/**
|
|
2714
|
+
* Get llm endpoint by id
|
|
2715
|
+
*
|
|
2716
|
+
* @param id - id of the endpoint
|
|
2717
|
+
* @returns Promise resolved with endpoint.
|
|
2718
|
+
*/
|
|
2719
|
+
getLlmEndpoint(id: string): Promise<ILlmEndpointOpenAI | undefined>;
|
|
2720
|
+
/**
|
|
2721
|
+
* Create a new llm endpoint
|
|
2722
|
+
*
|
|
2723
|
+
* @param endpoint - definition of the llm endpoint
|
|
2724
|
+
* @param token - token for the llm endpoint, if applicable
|
|
2725
|
+
* @returns Promise resolved with created llm endpoint.
|
|
2726
|
+
*/
|
|
2727
|
+
createLlmEndpoint(endpoint: ILlmEndpointOpenAI, token?: string): Promise<ILlmEndpointOpenAI>;
|
|
2728
|
+
/**
|
|
2729
|
+
* Update existing llm endpoint
|
|
2730
|
+
*
|
|
2731
|
+
* @param endpoint - definition of the llm endpoint
|
|
2732
|
+
* @param token - token for the llm endpoint, if applicable
|
|
2733
|
+
* @returns Promise resolved when the llm endpoint is updated.
|
|
2734
|
+
*/
|
|
2735
|
+
updateLlmEndpoint(endpoint: ILlmEndpointOpenAI, token?: string): Promise<ILlmEndpointOpenAI>;
|
|
2736
|
+
/**
|
|
2737
|
+
* Patch existing llm endpoint
|
|
2738
|
+
*
|
|
2739
|
+
* @param endpoint - definition of the llm endpoint
|
|
2740
|
+
* @param token - token for the llm endpoint, if applicable
|
|
2741
|
+
* @returns Promise resolved when the llm endpoint is patched.
|
|
2742
|
+
*/
|
|
2743
|
+
patchLlmEndpoint(endpoint: LlmEndpointOpenAIPatch, token?: string): Promise<ILlmEndpointOpenAI>;
|
|
2617
2744
|
}
|
|
2618
2745
|
|
|
2619
2746
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IWorkspaceDataFilter } from "@gooddata/sdk-model";
|
|
1
|
+
import { IWorkspaceDataFilter, ObjRef, IWorkspaceDataFilterDefinition } from "@gooddata/sdk-model";
|
|
2
2
|
/**
|
|
3
3
|
* The service that returns information about data filters.
|
|
4
4
|
*
|
|
@@ -8,6 +8,33 @@ import { IWorkspaceDataFilter } from "@gooddata/sdk-model";
|
|
|
8
8
|
* @alpha
|
|
9
9
|
*/
|
|
10
10
|
export interface IDataFiltersService {
|
|
11
|
+
/**
|
|
12
|
+
* Get data filters for the current workspace with their settings.
|
|
13
|
+
*
|
|
14
|
+
* @deprecated - the function has been renamed, use {@link IDataFiltersService#getDataFilters} instead
|
|
15
|
+
* @alpha
|
|
16
|
+
*/
|
|
11
17
|
getWorkspaceDataFilters(): Promise<IWorkspaceDataFilter[]>;
|
|
18
|
+
/**
|
|
19
|
+
* Get data filters for the current workspace with their settings.
|
|
20
|
+
*/
|
|
21
|
+
getDataFilters(): Promise<IWorkspaceDataFilter[]>;
|
|
22
|
+
/**
|
|
23
|
+
* Create a new data filter (without setting).
|
|
24
|
+
*/
|
|
25
|
+
createDataFilter(newDataFilter: IWorkspaceDataFilterDefinition): Promise<IWorkspaceDataFilter>;
|
|
26
|
+
/**
|
|
27
|
+
* Update an existing data filter.
|
|
28
|
+
* The setting is not updated, only the data filter.
|
|
29
|
+
*/
|
|
30
|
+
updateDataFilter(updatedDataFilter: IWorkspaceDataFilter): Promise<IWorkspaceDataFilter>;
|
|
31
|
+
/**
|
|
32
|
+
* Update value of existing data filter.
|
|
33
|
+
*/
|
|
34
|
+
updateDataFilterValue(dataFilter: ObjRef, values: string[]): Promise<void>;
|
|
35
|
+
/**
|
|
36
|
+
* Delete an existing data filter.
|
|
37
|
+
*/
|
|
38
|
+
deleteDataFilter(ref: ObjRef): Promise<void>;
|
|
12
39
|
}
|
|
13
40
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/dataFilter/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/dataFilter/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAC;AAEnG;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;;OAKG;IACH,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAE3D;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAElD;;OAEG;IACH,gBAAgB,CAAC,aAAa,EAAE,8BAA8B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE/F;;;OAGG;IACH,gBAAgB,CAAC,iBAAiB,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEzF;;OAEG;IACH,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;OAEG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChD"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { GenAIObjectType,
|
|
1
|
+
import { GenAIObjectType, IGenAIUserContext, ISemanticSearchRelationship, ISemanticSearchResultItem, IGenAIChatInteraction, IGenAIChatRouting, IGenAIFoundObjects, IGenAICreatedVisualizations } from "@gooddata/sdk-model";
|
|
2
2
|
/**
|
|
3
|
-
* GenAI-powered
|
|
3
|
+
* GenAI-powered features.
|
|
4
4
|
* @beta
|
|
5
5
|
*/
|
|
6
6
|
export interface IGenAIService {
|
|
@@ -54,31 +54,50 @@ export interface ISemanticSearchResult {
|
|
|
54
54
|
relationships: ISemanticSearchRelationship[];
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* Chatbot thread
|
|
58
|
-
* @
|
|
57
|
+
* Chatbot thread.
|
|
58
|
+
* @beta
|
|
59
59
|
*/
|
|
60
60
|
export interface IChatThread {
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* Load chat history for the chat thread.
|
|
63
|
+
*/
|
|
64
|
+
loadHistory(fromInteractionId?: number, options?: {
|
|
65
|
+
signal?: AbortSignal;
|
|
66
|
+
}): Promise<IChatThreadHistory>;
|
|
67
|
+
/**
|
|
68
|
+
* Reset the chat thread history.
|
|
69
|
+
*/
|
|
70
|
+
reset(): Promise<void>;
|
|
71
|
+
/**
|
|
72
|
+
* Add a user message to the chat thread.
|
|
63
73
|
*/
|
|
64
|
-
|
|
74
|
+
query(userMessage: string): IChatThreadQuery;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Chatbot thread history.
|
|
78
|
+
* @beta
|
|
79
|
+
*/
|
|
80
|
+
export interface IChatThreadHistory {
|
|
81
|
+
interactions: IGenAIChatInteraction[];
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Chatbot thread query builder.
|
|
85
|
+
* @beta
|
|
86
|
+
*/
|
|
87
|
+
export interface IChatThreadQuery {
|
|
65
88
|
/**
|
|
66
89
|
* Define the limit for the number of search results returned by the chat thread.
|
|
67
90
|
*/
|
|
68
|
-
withSearchLimit(searchLimit: number):
|
|
91
|
+
withSearchLimit(searchLimit: number): IChatThreadQuery;
|
|
69
92
|
/**
|
|
70
93
|
* Define the limit for the number of created visualization returned by the chat thread.
|
|
71
94
|
*/
|
|
72
|
-
withCreateLimit(createLimit: number):
|
|
95
|
+
withCreateLimit(createLimit: number): IChatThreadQuery;
|
|
73
96
|
/**
|
|
74
97
|
* Define the user context for the chat thread.
|
|
75
98
|
* For example, what dashboard the user is currently looking at.
|
|
76
99
|
*/
|
|
77
|
-
withUserContext(userContext: IGenAIUserContext):
|
|
78
|
-
/**
|
|
79
|
-
* Define the chat history for the chat thread.
|
|
80
|
-
*/
|
|
81
|
-
withChatHistory(chatHistory: IGenAIChatInteraction[]): IChatThread;
|
|
100
|
+
withUserContext(userContext: IGenAIUserContext): IChatThreadQuery;
|
|
82
101
|
/**
|
|
83
102
|
* Execute the chat thread.
|
|
84
103
|
*/
|
|
@@ -86,4 +105,15 @@ export interface IChatThread {
|
|
|
86
105
|
signal?: AbortSignal;
|
|
87
106
|
}): Promise<IGenAIChatEvaluation>;
|
|
88
107
|
}
|
|
108
|
+
/**
|
|
109
|
+
* GenAI chat evaluation result.
|
|
110
|
+
* @beta
|
|
111
|
+
*/
|
|
112
|
+
export interface IGenAIChatEvaluation {
|
|
113
|
+
routing: IGenAIChatRouting;
|
|
114
|
+
textResponse?: string;
|
|
115
|
+
foundObjects?: IGenAIFoundObjects;
|
|
116
|
+
createdVisualizations?: IGenAICreatedVisualizations;
|
|
117
|
+
chatHistoryThreadId?: string;
|
|
118
|
+
}
|
|
89
119
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/genAI/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,eAAe,EACf,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/genAI/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,eAAe,EACf,iBAAiB,EACjB,2BAA2B,EAC3B,yBAAyB,EACzB,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,EAC9B,MAAM,qBAAqB,CAAC;AAE7B;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,sBAAsB,IAAI,oBAAoB,CAAC;IAE/C;;OAEG;IACH,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;OAEG;IACH,aAAa,IAAI,WAAW,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,oBAAoB,CAAC;IAE/C;;OAEG;IACH,eAAe,CAAC,KAAK,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;IAEhE;;OAEG;IACH,cAAc,CAAC,UAAU,EAAE,OAAO,GAAG,oBAAoB,CAAC;IAE1D;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAC7E;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,aAAa,EAAE,2BAA2B,EAAE,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,WAAW,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACzG;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,gBAAgB,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,YAAY,EAAE,qBAAqB,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,gBAAgB,CAAC;IACvD;;OAEG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,gBAAgB,CAAC;IACvD;;;OAGG;IACH,eAAe,CAAC,WAAW,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;IAClE;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC5E;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,OAAO,EAAE,iBAAiB,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,qBAAqB,CAAC,EAAE,2BAA2B,CAAC;IACpD,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC"}
|
package/esm/workspace/index.d.ts
CHANGED
|
@@ -44,7 +44,7 @@ export interface IAnalyticalWorkspace {
|
|
|
44
44
|
*
|
|
45
45
|
* @param descriptor - properties to update
|
|
46
46
|
*/
|
|
47
|
-
updateDescriptor(descriptor: IWorkspaceDescriptorUpdate): Promise<
|
|
47
|
+
updateDescriptor(descriptor: IWorkspaceDescriptorUpdate): Promise<IWorkspaceDescriptor>;
|
|
48
48
|
/**
|
|
49
49
|
* Returns parent analytical workspace when this workspace has a parent, undefined otherwise.
|
|
50
50
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workspace/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,0BAA0B,GAAG,OAAO,CAAC,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workspace/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,0BAA0B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAExF;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;OAIG;IACH,WAAW,IAAI,2BAA2B,CAAC;IAE3C;;OAEG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,iBAAiB,IAAI,uBAAuB,CAAC;IAE7C;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,KAAK,IAAI,sBAAsB,CAAC;IAEhC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,SAAS,IAAI,iBAAiB,CAAC;IAE/B;;OAEG;IACH,KAAK,IAAI,oBAAoB,CAAC;IAE9B;;OAEG;IACH,UAAU,IAAI,yBAAyB,CAAC;IAExC;;OAEG;IACH,WAAW,IAAI,4BAA4B,CAAC;IAE5C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,aAAa,IAAI,8BAA8B,CAAC;IAEhD;;;OAGG;IACH,oBAAoB,IAAI,4BAA4B,CAAC;IAErD;;;OAGG;IACH,iBAAiB,IAAI,kCAAkC,CAAC;IAExD;;;OAGG;IACH,WAAW,IAAI,mBAAmB,CAAC;IAEnC;;;OAGG;IACH,YAAY,IAAI,6BAA6B,CAAC;IAE9C;;;OAGG;IACH,KAAK,IAAI,aAAa,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE1C;;;;OAIG;IACH,cAAc,IAAI,gBAAgB,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,gBAAgB,CAAC;IAE9D;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,sBAAsB,GAAG,gBAAgB,CAAC;IAE7D;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,uBAAuB,GAAG,gBAAgB,CAAC;IAEhE;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,oBAAoB,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-backend-spi",
|
|
3
|
-
"version": "10.13.0-alpha.
|
|
3
|
+
"version": "10.13.0-alpha.31",
|
|
4
4
|
"author": "GoodData",
|
|
5
5
|
"description": "GoodData Backend SPI abstraction interfaces",
|
|
6
6
|
"repository": {
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"lodash": "^4.17.21",
|
|
25
25
|
"ts-invariant": "^0.7.5",
|
|
26
26
|
"tslib": "^2.5.0",
|
|
27
|
-
"@gooddata/sdk-model": "10.13.0-alpha.
|
|
27
|
+
"@gooddata/sdk-model": "10.13.0-alpha.31"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@gooddata/eslint-config": "^4.1.0",
|