@memberjunction/skip-types 2.15.2 → 2.16.1
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 +136 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +26 -1
- package/dist/types.js.map +1 -1
- package/package.json +3 -3
package/dist/types.d.ts
CHANGED
|
@@ -61,6 +61,35 @@ export declare class SkipSubProcessResponse {
|
|
|
61
61
|
htmlReport: string | null;
|
|
62
62
|
errorMessage: string | null;
|
|
63
63
|
}
|
|
64
|
+
/**
|
|
65
|
+
* Defines the shape of the conversations that can be passed back and forth with the Skip API Server - primarily used for the learning cycle process
|
|
66
|
+
*/
|
|
67
|
+
export declare class SkipConversation {
|
|
68
|
+
/**
|
|
69
|
+
* The unique identifier for the conversation
|
|
70
|
+
*/
|
|
71
|
+
id: string;
|
|
72
|
+
/**
|
|
73
|
+
* The user-friendly name for the conversation
|
|
74
|
+
*/
|
|
75
|
+
name: string;
|
|
76
|
+
/**
|
|
77
|
+
* Optional, more detailed description of the conversation
|
|
78
|
+
*/
|
|
79
|
+
description?: string;
|
|
80
|
+
/**
|
|
81
|
+
* Array of messages that make up the conversation in chronological order, showing the earliest messages first and the more recents messages last
|
|
82
|
+
*/
|
|
83
|
+
messages: SkipMessage[];
|
|
84
|
+
/**
|
|
85
|
+
* When the conversation was created
|
|
86
|
+
*/
|
|
87
|
+
createdAt: Date;
|
|
88
|
+
/**
|
|
89
|
+
* The date the conversation header record was last updated - this is NOT the same as the most recent conversation detail, for that interrogate the conversation details
|
|
90
|
+
*/
|
|
91
|
+
updatedAt: Date;
|
|
92
|
+
}
|
|
64
93
|
/**
|
|
65
94
|
* Defines the shape of the individual message that makes up the messages array that is passed back and
|
|
66
95
|
* forth with the Skip API Server
|
|
@@ -78,6 +107,41 @@ export declare class SkipMessage {
|
|
|
78
107
|
* The conversation detail ID for the message, used to track the message
|
|
79
108
|
*/
|
|
80
109
|
conversationDetailID: string;
|
|
110
|
+
/**
|
|
111
|
+
* If the message reflects an error message the information is provided here
|
|
112
|
+
*/
|
|
113
|
+
error?: string;
|
|
114
|
+
/**
|
|
115
|
+
* hiddenToUser - this is true if a message is only for internal system puprose and not shown to a user
|
|
116
|
+
*/
|
|
117
|
+
hiddenToUser?: boolean;
|
|
118
|
+
/**
|
|
119
|
+
* Rating scale between 1 and 10, 1 reflecting the lowest rating and 10 reflecting the highest rating from the user in terms of their satisfaction with the response
|
|
120
|
+
*/
|
|
121
|
+
userRating?: number;
|
|
122
|
+
/**
|
|
123
|
+
* Optional, text feedback from the user reflecting their satisfaction with the response. Of course the subsequent messages can contain this, but this is an element that the UI will
|
|
124
|
+
* surface that allows a user to specifically provide feedback on each message.
|
|
125
|
+
*/
|
|
126
|
+
userFeedback?: string;
|
|
127
|
+
/**
|
|
128
|
+
* Optional, this text is from Skip during the generation of a particular response and represents the step-wise reasoning Skip went through to get to a particular response. This information along with the preceding messages, User Rating and User Feedback can
|
|
129
|
+
* be very helpful during a learning cycle to build notes and other artifacts that can train Skip to learn more about the user/organization's preferences and the context of the conversation.
|
|
130
|
+
*/
|
|
131
|
+
reflectionInsights?: string;
|
|
132
|
+
/**
|
|
133
|
+
* Optional, this text contains an AI generated summary of the prior messages in the conversation going back in time through the last such summary. This allows "compression" of a longer conversation to preserve space in a context window, improve performance and simplify
|
|
134
|
+
* inference.
|
|
135
|
+
*/
|
|
136
|
+
summaryOfEarlierConveration?: string;
|
|
137
|
+
/**
|
|
138
|
+
* The date and time the message was created
|
|
139
|
+
*/
|
|
140
|
+
createdAt?: Date;
|
|
141
|
+
/**
|
|
142
|
+
* The date and time the message was last updated
|
|
143
|
+
*/
|
|
144
|
+
updatedAt?: Date;
|
|
81
145
|
}
|
|
82
146
|
/**
|
|
83
147
|
* For each Skip API Analysis result, it is possible for Skip to provide a set of tableDataColumns that describe the data that is being returned in this shape.
|
|
@@ -257,6 +321,39 @@ export declare class SkipAPIRequest {
|
|
|
257
321
|
* NOTE: This is not where you put in the bearer token for the Skip API server itself, that goes in the header of the request
|
|
258
322
|
*/
|
|
259
323
|
apiKeys: SkipAPIRequestAPIKey[];
|
|
324
|
+
/**
|
|
325
|
+
* Optional notes that can be passed to Skip for additional context
|
|
326
|
+
*/
|
|
327
|
+
notes?: SkipAPIAgentNote[];
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* Defines the shape of an individual Agent note that is stored in MJ that can be passed to Skip for additional context.
|
|
331
|
+
*/
|
|
332
|
+
export declare class SkipAPIAgentNote {
|
|
333
|
+
/**
|
|
334
|
+
* Unique identifier for the note
|
|
335
|
+
*/
|
|
336
|
+
id: string;
|
|
337
|
+
/**
|
|
338
|
+
* Unique type id (UUID) for the note type
|
|
339
|
+
*/
|
|
340
|
+
typeId: string;
|
|
341
|
+
/**
|
|
342
|
+
* Text name for the note type
|
|
343
|
+
*/
|
|
344
|
+
type: string;
|
|
345
|
+
/**
|
|
346
|
+
* Date/Time the note was initially created
|
|
347
|
+
*/
|
|
348
|
+
createdAt: Date;
|
|
349
|
+
/**
|
|
350
|
+
* Date/Time the note was last updated
|
|
351
|
+
*/
|
|
352
|
+
updatedAt: Date;
|
|
353
|
+
/**
|
|
354
|
+
* The text of the note
|
|
355
|
+
*/
|
|
356
|
+
note: string;
|
|
260
357
|
}
|
|
261
358
|
export declare class SkipAPIRunScriptRequest extends SkipAPIRequest {
|
|
262
359
|
/**
|
|
@@ -421,4 +518,43 @@ export declare class SkipDataRequest {
|
|
|
421
518
|
*/
|
|
422
519
|
description?: string;
|
|
423
520
|
}
|
|
521
|
+
/**
|
|
522
|
+
* API Request shape to ask the /learn end point to learn from conversation history and pass back "notes" that can be stored in the database for future requests
|
|
523
|
+
*/
|
|
524
|
+
export declare class SkipAPILearningCycleRequest {
|
|
525
|
+
/**
|
|
526
|
+
* An array of conversations that have taken place since the last learning cycle
|
|
527
|
+
*/
|
|
528
|
+
newConversations: SkipConversation[];
|
|
529
|
+
/**
|
|
530
|
+
* An array of notes that have been generated by the Skip API server during the learning cycle process in the past
|
|
531
|
+
*/
|
|
532
|
+
notes: SkipAPIAgentNote[];
|
|
533
|
+
/**
|
|
534
|
+
* Optional, the date/time of the last learning cycle performed on this dataset
|
|
535
|
+
*/
|
|
536
|
+
lastLearningCycleDate: Date;
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* API Response shape to ask the /learn end point to learn from conversation history and pass back "notes", an array of notes are provided that should be stored in the database
|
|
540
|
+
* to then be passed into future Skip API requests for analysis/etc.
|
|
541
|
+
*/
|
|
542
|
+
export declare class SkipAPILearningCycleResponse {
|
|
543
|
+
/**
|
|
544
|
+
* Indicates if the learning cycle was successful or not
|
|
545
|
+
*/
|
|
546
|
+
success: boolean;
|
|
547
|
+
/**
|
|
548
|
+
* If the learning cycle was not successful, this property will contain an error message that describes the reason for the failure
|
|
549
|
+
*/
|
|
550
|
+
error?: string;
|
|
551
|
+
/**
|
|
552
|
+
* The number of milliseconds that have elapsed since the learning cycle process started
|
|
553
|
+
*/
|
|
554
|
+
elapsedTime: number;
|
|
555
|
+
/**
|
|
556
|
+
* The notes that were generated by the Skip API server during the learning cycle process
|
|
557
|
+
*/
|
|
558
|
+
notes: SkipAPIAgentNote[];
|
|
559
|
+
}
|
|
424
560
|
//# sourceMappingURL=types.d.ts.map
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IAEjC;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,+BAA+B,EAAE,MAAM,CAAC;IAExC;;;OAGG;IACH,6BAA6B,EAAE,MAAM,CAAC;CACzC;AAGD;;;;GAIG;AACH,qBAAa,sBAAsB;IAC/B,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC;IAC5B,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC5C,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE;QAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,GAAG,IAAI,CAAC;IAC9C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAGD;;;GAGG;AACH,qBAAa,WAAW;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IAEjC;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,+BAA+B,EAAE,MAAM,CAAC;IAExC;;;OAGG;IACH,6BAA6B,EAAE,MAAM,CAAC;CACzC;AAGD;;;;GAIG;AACH,qBAAa,sBAAsB;IAC/B,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC;IAC5B,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC5C,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE;QAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,GAAG,IAAI,CAAC;IAC9C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAGD;;GAEG;AACH,qBAAa,gBAAgB;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;CACnB;AAGD;;;GAGG;AACH,qBAAa,WAAW;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;CACpB;AAID;;GAEG;AACH,qBAAa,cAAc;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IACzD,WAAW,EAAE,MAAM,CAAC;CACvB;AAGD;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;CAOnB,CAAC;AACX,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAEtF,qBAAa,mBAAmB;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,qBAAa,0BAA0B;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,0BAA0B,EAAE,MAAM,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,MAAM,CAAC;CACjC;AAED,qBAAa,cAAc;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAG,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAG,MAAM,CAAC;IACpB,QAAQ,EAAG,MAAM,CAAC;IAClB,MAAM,EAAE,mBAAmB,EAAE,CAAK;IAClC,eAAe,EAAE,0BAA0B,EAAE,CAAM;CACtD;AAED,qBAAa,aAAa;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IACvE,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,kBAAkB,EAAE,CAAC;CAChC;AACD,qBAAa,kBAAkB;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,SAAS,EAAE,OAAO,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACxB;AAGD,qBAAa,oBAAoB;IAC7B;;;;OAIG;IACH,gBAAgB,EAAE,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,SAAS,CAAC;IACxF;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,cAAc;IACvB;;;;OAIG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,gBAAgB,CAAC;IAE/B;;;OAGG;IACH,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,gBAAgB;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,uBAAwB,SAAQ,cAAc;IACvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAGzF;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IACjC;;;OAGG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,8BAA8B;IACvC,eAAe,EAAE,MAAM,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,8BAA8B,EAAE,CAAC;CAC7C;AAGD;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,eAAe;IAC9D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,eAAe;IAChE,gBAAgB,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACjD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,cAAc,EAAE,CAAC;IACpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAC5C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,eAAe;IAClE;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,eAAe;IAC3D,WAAW,EAAE,eAAe,EAAE,CAAC;CAClC;AAGD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;CAGtB,CAAC;AACX,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAG/F;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,IAAI,EAAG,mBAAmB,CAAC;IAC3B;;OAEG;IACH,IAAI,EAAG,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAGD;;GAEG;AACH,qBAAa,2BAA2B;IACpC;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;IAErC;;OAEG;IACH,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAE1B;;OAEG;IACH,qBAAqB,EAAE,IAAI,CAAC;CAC/B;AAED;;;GAGG;AACH,qBAAa,4BAA4B;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC7B"}
|
package/dist/types.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SkipDataRequest = exports.SkipDataRequestType = exports.SkipAPIDataRequestResponse = exports.SkipAPIClarifyingQuestionResponse = exports.SkipAPIAnalysisCompleteResponse = exports.SkipAPIChatWithRecordResponse = exports.SkipAPIAnalysisDrillDown = exports.SkipAPIAnalysisDrillDownFilter = exports.SkipAPIResponse = exports.SkipResponsePhase = exports.SkipAPIRunScriptRequest = exports.SkipAPIRequest = exports.SkipAPIRequestAPIKey = exports.SkipQueryFieldInfo = exports.SkipQueryInfo = exports.SkipEntityInfo = exports.SkipEntityRelationshipInfo = exports.SkipEntityFieldInfo = exports.SkipRequestPhase = exports.SkipColumnInfo = exports.SkipMessage = exports.SkipSubProcessResponse = exports.MJAPISkipResult = void 0;
|
|
3
|
+
exports.SkipAPILearningCycleResponse = exports.SkipAPILearningCycleRequest = exports.SkipDataRequest = exports.SkipDataRequestType = exports.SkipAPIDataRequestResponse = exports.SkipAPIClarifyingQuestionResponse = exports.SkipAPIAnalysisCompleteResponse = exports.SkipAPIChatWithRecordResponse = exports.SkipAPIAnalysisDrillDown = exports.SkipAPIAnalysisDrillDownFilter = exports.SkipAPIResponse = exports.SkipResponsePhase = exports.SkipAPIRunScriptRequest = exports.SkipAPIAgentNote = exports.SkipAPIRequest = exports.SkipAPIRequestAPIKey = exports.SkipQueryFieldInfo = exports.SkipQueryInfo = exports.SkipEntityInfo = exports.SkipEntityRelationshipInfo = exports.SkipEntityFieldInfo = exports.SkipRequestPhase = exports.SkipColumnInfo = exports.SkipMessage = exports.SkipConversation = exports.SkipSubProcessResponse = exports.MJAPISkipResult = void 0;
|
|
4
4
|
/**
|
|
5
5
|
* This type defines the shape of data that is passed back from the MJ API server to callers, typically the MJ Explorer UI
|
|
6
6
|
*/
|
|
@@ -15,6 +15,12 @@ exports.MJAPISkipResult = MJAPISkipResult;
|
|
|
15
15
|
class SkipSubProcessResponse {
|
|
16
16
|
}
|
|
17
17
|
exports.SkipSubProcessResponse = SkipSubProcessResponse;
|
|
18
|
+
/**
|
|
19
|
+
* Defines the shape of the conversations that can be passed back and forth with the Skip API Server - primarily used for the learning cycle process
|
|
20
|
+
*/
|
|
21
|
+
class SkipConversation {
|
|
22
|
+
}
|
|
23
|
+
exports.SkipConversation = SkipConversation;
|
|
18
24
|
/**
|
|
19
25
|
* Defines the shape of the individual message that makes up the messages array that is passed back and
|
|
20
26
|
* forth with the Skip API Server
|
|
@@ -74,6 +80,12 @@ exports.SkipAPIRequestAPIKey = SkipAPIRequestAPIKey;
|
|
|
74
80
|
class SkipAPIRequest {
|
|
75
81
|
}
|
|
76
82
|
exports.SkipAPIRequest = SkipAPIRequest;
|
|
83
|
+
/**
|
|
84
|
+
* Defines the shape of an individual Agent note that is stored in MJ that can be passed to Skip for additional context.
|
|
85
|
+
*/
|
|
86
|
+
class SkipAPIAgentNote {
|
|
87
|
+
}
|
|
88
|
+
exports.SkipAPIAgentNote = SkipAPIAgentNote;
|
|
77
89
|
class SkipAPIRunScriptRequest extends SkipAPIRequest {
|
|
78
90
|
}
|
|
79
91
|
exports.SkipAPIRunScriptRequest = SkipAPIRunScriptRequest;
|
|
@@ -149,4 +161,17 @@ exports.SkipDataRequestType = {
|
|
|
149
161
|
class SkipDataRequest {
|
|
150
162
|
}
|
|
151
163
|
exports.SkipDataRequest = SkipDataRequest;
|
|
164
|
+
/**
|
|
165
|
+
* API Request shape to ask the /learn end point to learn from conversation history and pass back "notes" that can be stored in the database for future requests
|
|
166
|
+
*/
|
|
167
|
+
class SkipAPILearningCycleRequest {
|
|
168
|
+
}
|
|
169
|
+
exports.SkipAPILearningCycleRequest = SkipAPILearningCycleRequest;
|
|
170
|
+
/**
|
|
171
|
+
* API Response shape to ask the /learn end point to learn from conversation history and pass back "notes", an array of notes are provided that should be stored in the database
|
|
172
|
+
* to then be passed into future Skip API requests for analysis/etc.
|
|
173
|
+
*/
|
|
174
|
+
class SkipAPILearningCycleResponse {
|
|
175
|
+
}
|
|
176
|
+
exports.SkipAPILearningCycleResponse = SkipAPILearningCycleResponse;
|
|
152
177
|
//# sourceMappingURL=types.js.map
|
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,eAAe;CAgD3B;AAhDD,0CAgDC;AAGD;;;;GAIG;AACH,MAAa,sBAAsB;CAOlC;AAPD,wDAOC;AAGD;;;GAGG;AACH,MAAa,WAAW;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,eAAe;CAgD3B;AAhDD,0CAgDC;AAGD;;;;GAIG;AACH,MAAa,sBAAsB;CAOlC;AAPD,wDAOC;AAGD;;GAEG;AACH,MAAa,gBAAgB;CA4B5B;AA5BD,4CA4BC;AAGD;;;GAGG;AACH,MAAa,WAAW;CAuDvB;AAvDD,kCAuDC;AAID;;GAEG;AACH,MAAa,cAAc;CAK1B;AALD,wCAKC;AAGD;;;;;;;;;GASG;AACU,QAAA,gBAAgB,GAAG;IAC5B,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;CAClC,CAAC;AAGX,MAAa,mBAAmB;CA4B/B;AA5BD,kDA4BC;AAED,MAAa,0BAA0B;CAatC;AAbD,gEAaC;AAED,MAAa,cAAc;IAA3B;QAMI,WAAM,GAAyB,EAAE,CAAC;QAClC,oBAAe,GAAiC,EAAE,CAAC;IACvD,CAAC;CAAA;AARD,wCAQC;AAED,MAAa,aAAa;CAczB;AAdD,sCAcC;AACD,MAAa,kBAAkB;CAsB9B;AAtBD,gDAsBC;AAGD,MAAa,oBAAoB;CAYhC;AAZD,oDAYC;AAED;;GAEG;AACH,MAAa,cAAc;CAsD1B;AAtDD,wCAsDC;AAED;;GAEG;AACH,MAAa,gBAAgB;CAyB5B;AAzBD,4CAyBC;AAED,MAAa,uBAAwB,SAAQ,cAAc;CAK1D;AALD,0DAKC;AAED;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG;IAC7B,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,2BAA2B,EAAE,6BAA6B;CACpD,CAAC;AAIX;;GAEG;AACH,MAAa,eAAe;CAkB3B;AAlBD,0CAkBC;AAED;;GAEG;AACH,MAAa,8BAA8B;CAG1C;AAHD,wEAGC;AAED;;GAEG;AACH,MAAa,wBAAwB;CAepC;AAfD,4DAeC;AAGD;;GAEG;AACH,MAAa,6BAA8B,SAAQ,eAAe;CAKjE;AALD,sEAKC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,eAAe;CAkCnE;AAlCD,0EAkCC;AAED;;GAEG;AACH,MAAa,iCAAkC,SAAQ,eAAe;CASrE;AATD,8EASC;AAED;;GAEG;AACH,MAAa,0BAA2B,SAAQ,eAAe;CAE9D;AAFD,gEAEC;AAGD;;;;GAIG;AACU,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,KAAK;IACV,YAAY,EAAE,cAAc;CACtB,CAAC;AAIX;;GAEG;AACH,MAAa,eAAe;CAa3B;AAbD,0CAaC;AAGD;;GAEG;AACH,MAAa,2BAA2B;CAevC;AAfD,kEAeC;AAED;;;GAGG;AACH,MAAa,4BAA4B;CAmBxC;AAnBD,oEAmBC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memberjunction/skip-types",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.16.1",
|
|
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",
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"typescript": "^5.4.5"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@memberjunction/core-entities": "2.
|
|
23
|
-
"@memberjunction/data-context": "2.
|
|
22
|
+
"@memberjunction/core-entities": "2.16.1",
|
|
23
|
+
"@memberjunction/data-context": "2.16.1"
|
|
24
24
|
}
|
|
25
25
|
}
|