@gooddata/sdk-backend-spi 10.13.0-alpha.14 → 10.13.0-alpha.16
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 +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js.map +1 -1
- package/esm/sdk-backend-spi.d.ts +48 -13
- package/esm/workspace/genAI/index.d.ts +43 -13
- package/esm/workspace/genAI/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";
|
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"}
|
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"}
|
package/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -64,8 +64,10 @@ 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';
|
|
@@ -1078,31 +1080,52 @@ export declare interface ICancelable<T> {
|
|
|
1078
1080
|
}
|
|
1079
1081
|
|
|
1080
1082
|
/**
|
|
1081
|
-
* Chatbot thread
|
|
1082
|
-
* @
|
|
1083
|
+
* Chatbot thread.
|
|
1084
|
+
* @beta
|
|
1083
1085
|
*/
|
|
1084
1086
|
export declare interface IChatThread {
|
|
1085
1087
|
/**
|
|
1086
|
-
*
|
|
1088
|
+
* Load chat history for the chat thread.
|
|
1089
|
+
*/
|
|
1090
|
+
loadHistory(fromInteractionId?: number, options?: {
|
|
1091
|
+
signal?: AbortSignal;
|
|
1092
|
+
}): Promise<IChatThreadHistory>;
|
|
1093
|
+
/**
|
|
1094
|
+
* Reset the chat thread history.
|
|
1095
|
+
*/
|
|
1096
|
+
reset(): Promise<void>;
|
|
1097
|
+
/**
|
|
1098
|
+
* Add a user message to the chat thread.
|
|
1087
1099
|
*/
|
|
1088
|
-
|
|
1100
|
+
query(userMessage: string): IChatThreadQuery;
|
|
1101
|
+
}
|
|
1102
|
+
|
|
1103
|
+
/**
|
|
1104
|
+
* Chatbot thread history.
|
|
1105
|
+
* @beta
|
|
1106
|
+
*/
|
|
1107
|
+
export declare interface IChatThreadHistory {
|
|
1108
|
+
interactions: IGenAIChatInteraction[];
|
|
1109
|
+
}
|
|
1110
|
+
|
|
1111
|
+
/**
|
|
1112
|
+
* Chatbot thread query builder.
|
|
1113
|
+
* @beta
|
|
1114
|
+
*/
|
|
1115
|
+
export declare interface IChatThreadQuery {
|
|
1089
1116
|
/**
|
|
1090
1117
|
* Define the limit for the number of search results returned by the chat thread.
|
|
1091
1118
|
*/
|
|
1092
|
-
withSearchLimit(searchLimit: number):
|
|
1119
|
+
withSearchLimit(searchLimit: number): IChatThreadQuery;
|
|
1093
1120
|
/**
|
|
1094
1121
|
* Define the limit for the number of created visualization returned by the chat thread.
|
|
1095
1122
|
*/
|
|
1096
|
-
withCreateLimit(createLimit: number):
|
|
1123
|
+
withCreateLimit(createLimit: number): IChatThreadQuery;
|
|
1097
1124
|
/**
|
|
1098
1125
|
* Define the user context for the chat thread.
|
|
1099
1126
|
* For example, what dashboard the user is currently looking at.
|
|
1100
1127
|
*/
|
|
1101
|
-
withUserContext(userContext: IGenAIUserContext):
|
|
1102
|
-
/**
|
|
1103
|
-
* Define the chat history for the chat thread.
|
|
1104
|
-
*/
|
|
1105
|
-
withChatHistory(chatHistory: IGenAIChatInteraction[]): IChatThread;
|
|
1128
|
+
withUserContext(userContext: IGenAIUserContext): IChatThreadQuery;
|
|
1106
1129
|
/**
|
|
1107
1130
|
* Execute the chat thread.
|
|
1108
1131
|
*/
|
|
@@ -2190,7 +2213,19 @@ export declare interface IForecastView {
|
|
|
2190
2213
|
}
|
|
2191
2214
|
|
|
2192
2215
|
/**
|
|
2193
|
-
* GenAI
|
|
2216
|
+
* GenAI chat evaluation result.
|
|
2217
|
+
* @beta
|
|
2218
|
+
*/
|
|
2219
|
+
export declare interface IGenAIChatEvaluation {
|
|
2220
|
+
routing: IGenAIChatRouting;
|
|
2221
|
+
textResponse?: string;
|
|
2222
|
+
foundObjects?: IGenAIFoundObjects;
|
|
2223
|
+
createdVisualizations?: IGenAICreatedVisualizations;
|
|
2224
|
+
chatHistoryThreadId?: string;
|
|
2225
|
+
}
|
|
2226
|
+
|
|
2227
|
+
/**
|
|
2228
|
+
* GenAI-powered features.
|
|
2194
2229
|
* @beta
|
|
2195
2230
|
*/
|
|
2196
2231
|
export declare interface IGenAIService {
|
|
@@ -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/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.16",
|
|
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.16"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@gooddata/eslint-config": "^4.1.0",
|