@memberjunction/skip-types 0.9.4 → 0.9.5
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/dist/types.d.ts +18 -2
- package/dist/types.js +7 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -11,14 +11,29 @@ export declare class SubProcessResponse {
|
|
|
11
11
|
analysis: string | null;
|
|
12
12
|
errorMessage: string | null;
|
|
13
13
|
}
|
|
14
|
+
/**
|
|
15
|
+
* Defines the shape of the individual message that makes up the messages array that is passed back and forth with the Skip API Server
|
|
16
|
+
*/
|
|
17
|
+
export declare class SkipMessage {
|
|
18
|
+
/**
|
|
19
|
+
* The role of the message, either "user" or "system"
|
|
20
|
+
*/
|
|
21
|
+
role: "user" | "system";
|
|
22
|
+
/**
|
|
23
|
+
* The content of the message, either the user's input or the system's response
|
|
24
|
+
*/
|
|
25
|
+
content: string;
|
|
26
|
+
}
|
|
14
27
|
/**
|
|
15
28
|
* Defines the shape of the data that is expected by the Skip API Server when making a request
|
|
16
29
|
*/
|
|
17
30
|
export declare class SkipAPIRequest {
|
|
18
31
|
/**
|
|
19
|
-
* The
|
|
32
|
+
* An array of 1 or more messages that are part of the conversation. The Skip API server will use these messages to understand the context of the conversation.
|
|
33
|
+
* When Skip responds to a request, he provides a messages array as well that will include the input messages as well as additional messages that he has generated as part of the conversation.
|
|
34
|
+
* In future requests for the same conversation it is important to include ALL of the messages that have been part of the conversation so far, so that Skip can understand the full context of the conversation.
|
|
20
35
|
*/
|
|
21
|
-
|
|
36
|
+
messages: SkipMessage[];
|
|
22
37
|
/**
|
|
23
38
|
* The data context, use this to provide all of the data you have in a data context to Skip. You should provide this from cache or refreshed based on the parameters provided by the user.
|
|
24
39
|
*/
|
|
@@ -44,6 +59,7 @@ export declare class SkipAPIRequest {
|
|
|
44
59
|
*/
|
|
45
60
|
export declare class SkipAPIResponse {
|
|
46
61
|
success: boolean;
|
|
62
|
+
messages: SkipMessage[];
|
|
47
63
|
executionResults: SubProcessResponse | null;
|
|
48
64
|
userExplanation: string;
|
|
49
65
|
techExplanation: string;
|
package/dist/types.js
CHANGED
|
@@ -1,9 +1,15 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SkipDataContext = exports.SkipDataContextItem = exports.SkipDataContextFieldInfo = exports.SkipAPIResponse = exports.SkipAPIRequest = exports.SubProcessResponse = void 0;
|
|
3
|
+
exports.SkipDataContext = exports.SkipDataContextItem = exports.SkipDataContextFieldInfo = exports.SkipAPIResponse = exports.SkipAPIRequest = exports.SkipMessage = exports.SubProcessResponse = void 0;
|
|
4
4
|
class SubProcessResponse {
|
|
5
5
|
}
|
|
6
6
|
exports.SubProcessResponse = SubProcessResponse;
|
|
7
|
+
/**
|
|
8
|
+
* Defines the shape of the individual message that makes up the messages array that is passed back and forth with the Skip API Server
|
|
9
|
+
*/
|
|
10
|
+
class SkipMessage {
|
|
11
|
+
}
|
|
12
|
+
exports.SkipMessage = SkipMessage;
|
|
7
13
|
/**
|
|
8
14
|
* Defines the shape of the data that is expected by the Skip API Server when making a request
|
|
9
15
|
*/
|
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA,MAAa,kBAAkB;CAQ9B;AARD,gDAQC;AAED;;GAEG;AACH,MAAa,cAAc;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA,MAAa,kBAAkB;CAQ9B;AARD,gDAQC;AAGD;;GAEG;AACH,MAAa,WAAW;CASvB;AATD,kCASC;AAED;;GAEG;AACH,MAAa,cAAc;CA2B1B;AA3BD,wCA2BC;AAED;;GAEG;AACH,MAAa,eAAe;CAW3B;AAXD,0CAWC;AAGD,MAAa,wBAAwB;CAIpC;AAJD,4DAIC;AAED,MAAa,mBAAmB;IAAhC;QAeI;;UAEE;QACF,WAAM,GAA+B,EAAE,CAAC;IA4C5C,CAAC;IA1CG;;OAEG;IACH,IAAI,WAAW;QACX,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,MAAM;gBACP,OAAO,SAAS,IAAI,CAAC,UAAU,kBAAkB,IAAI,CAAC,UAAU,EAAE,CAAC;YACvE,KAAK,OAAO;gBACR,OAAO,UAAU,IAAI,CAAC,UAAU,EAAE,CAAC;YACvC,KAAK,aAAa;gBACd,OAAO,8BAA8B,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3D;gBACI,OAAO,iBAAiB,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5C,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,UAAkC;QAC3D,MAAM,QAAQ,GAAG,IAAI,mBAAmB,EAAE,CAAC;QAC3C,iDAAiD;QACjD,QAAQ,CAAC,IAAI,GAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC;QACrD,QAAQ,CAAC,QAAQ,GAAG,UAAU,CAAC,EAAE,CAAC;QAClC,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC;QACtC,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACvD,OAAO;gBACH,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,WAAW,EAAE,CAAC,CAAC,WAAW;aAC7B,CAAA;QACL,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACpB,CAAC;IAIM,kBAAkB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACpD,CAAC;CACJ;AA9DD,kDA8DC;AAED,MAAa,eAAe;IAA5B;QACI,UAAK,GAA0B,EAAE,CAAC;IAyBtC,CAAC;IAvBU,kBAAkB;QACrB,IAAI,IAAI,CAAC,KAAK;YACV,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,4CAA4C;;YAEnG,OAAO,KAAK,CAAC;IACrB,CAAC;IAEM,qBAAqB;QACxB,2JAA2J;QAC3J,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/C,CAAC;QACD,OAAO,GAAG,CAAC;IACf,CAAC;IAEM,gCAAgC;QACnC,IAAI,OAAO,GAAW,EAAE,CAAC;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,OAAO,IAAI,aAAa,CAAC,gCAAgC,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,OAAO,GAAG,CAAC;IAC1B,CAAC;CACJ;AA1BD,0CA0BC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memberjunction/skip-types",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.5",
|
|
4
4
|
"description": "MemberJunction: Skip AI Assistant - Types that are used between the MJAPI and the Skip API as well as the UI within MemberJunction Explorer",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|