@gooddata/sdk-model 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/dataFilter/index.d.ts +20 -0
- package/esm/dataFilter/index.d.ts.map +1 -1
- package/esm/genAI/chat.d.ts +195 -0
- package/esm/genAI/chat.d.ts.map +1 -0
- package/esm/genAI/{flexAI.js → chat.js} +1 -1
- package/esm/genAI/chat.js.map +1 -0
- package/esm/genAI/semanticSearch.d.ts +7 -7
- package/esm/genAI/semanticSearch.d.ts.map +1 -1
- package/esm/index.d.ts +4 -3
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js.map +1 -1
- package/esm/llmEndpoints/index.d.ts +45 -0
- package/esm/llmEndpoints/index.d.ts.map +1 -0
- package/esm/llmEndpoints/index.js +3 -0
- package/esm/llmEndpoints/index.js.map +1 -0
- package/esm/objRef/index.d.ts +1 -1
- package/esm/objRef/index.d.ts.map +1 -1
- package/esm/objRef/index.js.map +1 -1
- package/esm/sdk-model.d.ts +270 -135
- package/esm/settings/index.d.ts +38 -0
- package/esm/settings/index.d.ts.map +1 -1
- package/package.json +1 -1
- package/esm/genAI/flexAI.d.ts +0 -165
- package/esm/genAI/flexAI.d.ts.map +0 -1
- package/esm/genAI/flexAI.js.map +0 -1
package/esm/genAI/flexAI.d.ts
DELETED
@@ -1,165 +0,0 @@
|
|
1
|
-
import { GenAIObjectType } from "./common.js";
|
2
|
-
import { ISemanticSearchResultItem } from "./semanticSearch.js";
|
3
|
-
/**
|
4
|
-
* User context for GenAI.
|
5
|
-
* @alpha
|
6
|
-
*/
|
7
|
-
export interface IGenAIUserContext {
|
8
|
-
/**
|
9
|
-
* Active object the user is interacting with.
|
10
|
-
*/
|
11
|
-
activeObject: GenAIActiveObject;
|
12
|
-
}
|
13
|
-
/**
|
14
|
-
* A single chat history message.
|
15
|
-
* @alpha
|
16
|
-
*/
|
17
|
-
export interface IGenAIChatInteraction {
|
18
|
-
/**
|
19
|
-
* Role of the chat interaction.
|
20
|
-
*/
|
21
|
-
role: GenAIChatRole;
|
22
|
-
/**
|
23
|
-
* Content of the chat interaction.
|
24
|
-
*/
|
25
|
-
content: GenAIChatInteractionContent[];
|
26
|
-
}
|
27
|
-
/**
|
28
|
-
* Evaluation result of the chat, i.e. assistant's response.
|
29
|
-
* @alpha
|
30
|
-
*/
|
31
|
-
export interface IGenAIChatEvaluation {
|
32
|
-
/**
|
33
|
-
* Detected use cases for the chat evaluation.
|
34
|
-
*/
|
35
|
-
useCases?: GenAIChatUseCase[];
|
36
|
-
/**
|
37
|
-
* Invalid question flag.
|
38
|
-
*/
|
39
|
-
invalidQuestion: boolean;
|
40
|
-
/**
|
41
|
-
* Most relevant objects for the user question.
|
42
|
-
*/
|
43
|
-
foundObjects?: GenAIChatFoundObjects;
|
44
|
-
/**
|
45
|
-
* Visualizations created by the assistant.
|
46
|
-
*/
|
47
|
-
createdVisualizations?: GenAIChatCreatedVisualizations;
|
48
|
-
}
|
49
|
-
/**
|
50
|
-
* Active object the user is interacting with.
|
51
|
-
* @alpha
|
52
|
-
*/
|
53
|
-
export type GenAIActiveObject = {
|
54
|
-
id: string;
|
55
|
-
workspaceId: string;
|
56
|
-
type: GenAIObjectType;
|
57
|
-
};
|
58
|
-
/**
|
59
|
-
* Role of the chat interaction.
|
60
|
-
* @alpha
|
61
|
-
*/
|
62
|
-
export type GenAIChatRole = "USER" | "AI";
|
63
|
-
/**
|
64
|
-
* Content of the chat interaction.
|
65
|
-
* @alpha
|
66
|
-
*/
|
67
|
-
export type GenAIChatInteractionContent = GenAIChatTextInteractionContent | GenAIChatSearchInteractionContent | GenAIChatVisualizationInteractionContent;
|
68
|
-
/**
|
69
|
-
* Base content of the chat interaction.
|
70
|
-
* @alpha
|
71
|
-
*/
|
72
|
-
export type GenAIChatBaseInteractionContent = {
|
73
|
-
includeToChatContext: boolean;
|
74
|
-
userFeedback: "POSITIVE" | "NEGATIVE" | "NONE";
|
75
|
-
};
|
76
|
-
/**
|
77
|
-
* Textual answer from the assistant.
|
78
|
-
* @alpha
|
79
|
-
*/
|
80
|
-
export type GenAIChatTextInteractionContent = GenAIChatBaseInteractionContent & {
|
81
|
-
text: string;
|
82
|
-
};
|
83
|
-
/**
|
84
|
-
* Search result from the assistant.
|
85
|
-
* @alpha
|
86
|
-
*/
|
87
|
-
export type GenAIChatSearchInteractionContent = GenAIChatBaseInteractionContent & {
|
88
|
-
foundObject: ISemanticSearchResultItem;
|
89
|
-
};
|
90
|
-
/**
|
91
|
-
* Visualization created by the assistant.
|
92
|
-
* @alpha
|
93
|
-
*/
|
94
|
-
export type GenAIChatVisualizationInteractionContent = GenAIChatBaseInteractionContent & {
|
95
|
-
createdVisualization: GenAIChatCreatedVisualization;
|
96
|
-
};
|
97
|
-
/**
|
98
|
-
* Type of the visualization.
|
99
|
-
* @alpha
|
100
|
-
*/
|
101
|
-
export type GenAIChatVisualizationType = "TABLE" | "HEADLINE" | "BAR" | "LINE" | "PIE" | "COLUMN";
|
102
|
-
/**
|
103
|
-
* Type of the metric.
|
104
|
-
* @alpha
|
105
|
-
*/
|
106
|
-
export type GenAIChatMetricType = "metric" | "fact" | "attribute";
|
107
|
-
/**
|
108
|
-
* Aggregation function for the metric.
|
109
|
-
* @alpha
|
110
|
-
*/
|
111
|
-
export type GenAIChatMetricAggregation = "COUNT" | "SUM" | "MIN" | "MAX" | "AVG" | "MEDIAN";
|
112
|
-
/**
|
113
|
-
* Visualization definition created by the assistant.
|
114
|
-
* @alpha
|
115
|
-
*/
|
116
|
-
export type GenAIChatCreatedVisualization = {
|
117
|
-
id: string;
|
118
|
-
title: string;
|
119
|
-
visualizationType: GenAIChatVisualizationType;
|
120
|
-
metrics: GenAIChatCreatedVisualizationMetric[];
|
121
|
-
dimensionality: GenAIChatCreatedVisualizationDimension[];
|
122
|
-
};
|
123
|
-
/**
|
124
|
-
* Metric definition for the visualization.
|
125
|
-
* @alpha
|
126
|
-
*/
|
127
|
-
export type GenAIChatCreatedVisualizationMetric = {
|
128
|
-
id: string;
|
129
|
-
type: GenAIChatMetricType;
|
130
|
-
aggFunction: GenAIChatMetricAggregation;
|
131
|
-
};
|
132
|
-
/**
|
133
|
-
* Dimension definition for the visualization.
|
134
|
-
* @alpha
|
135
|
-
*/
|
136
|
-
export type GenAIChatCreatedVisualizationDimension = {
|
137
|
-
id: string;
|
138
|
-
type: "attribute";
|
139
|
-
};
|
140
|
-
/**
|
141
|
-
* Use case for the chat evaluation.
|
142
|
-
* @alpha
|
143
|
-
*/
|
144
|
-
export type GenAIChatUseCase = {
|
145
|
-
useCase: string;
|
146
|
-
exampleDescription?: string;
|
147
|
-
score: number;
|
148
|
-
};
|
149
|
-
/**
|
150
|
-
* Visualizations created by the assistant.
|
151
|
-
* @alpha
|
152
|
-
*/
|
153
|
-
export type GenAIChatCreatedVisualizations = {
|
154
|
-
objects?: GenAIChatCreatedVisualization[];
|
155
|
-
reasoning: string;
|
156
|
-
};
|
157
|
-
/**
|
158
|
-
* Found objects related to the user question.
|
159
|
-
* @alpha
|
160
|
-
*/
|
161
|
-
export type GenAIChatFoundObjects = {
|
162
|
-
objects?: ISemanticSearchResultItem[];
|
163
|
-
reasoning: string;
|
164
|
-
};
|
165
|
-
//# sourceMappingURL=flexAI.d.ts.map
|
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"flexAI.d.ts","sourceRoot":"","sources":["../../src/genAI/flexAI.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,YAAY,EAAE,iBAAiB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,2BAA2B,EAAE,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC9B;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACrC;;OAEG;IACH,qBAAqB,CAAC,EAAE,8BAA8B,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,eAAe,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,IAAI,CAAC;AAE1C;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GACjC,+BAA+B,GAC/B,iCAAiC,GACjC,wCAAwC,CAAC;AAE/C;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC1C,oBAAoB,EAAE,OAAO,CAAC;IAC9B,YAAY,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC;CAClD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,+BAA+B,GAAG;IAC5E,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,+BAA+B,GAAG;IAC9E,WAAW,EAAE,yBAAyB,CAAC;CAC1C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wCAAwC,GAAG,+BAA+B,GAAG;IACrF,oBAAoB,EAAE,6BAA6B,CAAC;CACvD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAElG;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;AAElE;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE5F;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,0BAA0B,CAAC;IAC9C,OAAO,EAAE,mCAAmC,EAAE,CAAC;IAC/C,cAAc,EAAE,sCAAsC,EAAE,CAAC;CAC5D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,WAAW,EAAE,0BAA0B,CAAC;CAC3C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACjD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IACzC,OAAO,CAAC,EAAE,6BAA6B,EAAE,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC,OAAO,CAAC,EAAE,yBAAyB,EAAE,CAAC;IACtC,SAAS,EAAE,MAAM,CAAC;CACrB,CAAC"}
|
package/esm/genAI/flexAI.js.map
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"flexAI.js","sourceRoot":"","sources":["../../src/genAI/flexAI.ts"],"names":[],"mappings":"AAAA,qCAAqC"}
|