@digipair/skill-chatbot 0.28.14 → 0.29.2
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/package.json +1 -1
- package/schema.en.json +453 -0
package/package.json
CHANGED
package/schema.en.json
ADDED
|
@@ -0,0 +1,453 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.0",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "@digipair/skill-chatbot",
|
|
5
|
+
"summary": "Communication with the chatbot",
|
|
6
|
+
"description": "The skill allows managing communication with the chatbot.",
|
|
7
|
+
"version": "0.1.0",
|
|
8
|
+
"x-icon": "🤖"
|
|
9
|
+
},
|
|
10
|
+
"paths": {
|
|
11
|
+
"/chatbot": {
|
|
12
|
+
"post": {
|
|
13
|
+
"tags": ["boost"],
|
|
14
|
+
"summary": "Return to the chatbot",
|
|
15
|
+
"parameters": [
|
|
16
|
+
{
|
|
17
|
+
"name": "assistant",
|
|
18
|
+
"required": true,
|
|
19
|
+
"description": "Response from the assistant",
|
|
20
|
+
"schema": {
|
|
21
|
+
"type": "string"
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "command",
|
|
26
|
+
"required": false,
|
|
27
|
+
"description": "Command executed on the chatbot",
|
|
28
|
+
"schema": {
|
|
29
|
+
"type": "array",
|
|
30
|
+
"items": {
|
|
31
|
+
"$ref": "https://schemas.digipair.ai/pinsSettings"
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"name": "sources",
|
|
37
|
+
"required": false,
|
|
38
|
+
"description": "List of sources used to respond to the user",
|
|
39
|
+
"schema": {
|
|
40
|
+
"type": "array",
|
|
41
|
+
"items": {
|
|
42
|
+
"type": "object"
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "logs",
|
|
48
|
+
"required": false,
|
|
49
|
+
"description": "Useful information for debugging reasoning",
|
|
50
|
+
"schema": {
|
|
51
|
+
"type": "object"
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"name": "model",
|
|
56
|
+
"summary": "LLM Model",
|
|
57
|
+
"required": false,
|
|
58
|
+
"description": "LLM model to load",
|
|
59
|
+
"schema": {
|
|
60
|
+
"type": "array",
|
|
61
|
+
"items": {
|
|
62
|
+
"$ref": "https://schemas.digipair.ai/pinsSettings"
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "embeddings",
|
|
68
|
+
"summary": "Embeddings Model",
|
|
69
|
+
"required": false,
|
|
70
|
+
"description": "Embeddings model to load",
|
|
71
|
+
"schema": {
|
|
72
|
+
"type": "array",
|
|
73
|
+
"items": {
|
|
74
|
+
"$ref": "https://schemas.digipair.ai/pinsSettings"
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "baseUrlVespa",
|
|
80
|
+
"required": false,
|
|
81
|
+
"description": "URL of the Vespa server",
|
|
82
|
+
"schema": {
|
|
83
|
+
"type": "string"
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "promptSummary",
|
|
88
|
+
"required": false,
|
|
89
|
+
"description": "Prompt used for the system summary",
|
|
90
|
+
"schema": {
|
|
91
|
+
"type": "string"
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
],
|
|
95
|
+
"x-events": []
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
"/find": {
|
|
99
|
+
"post": {
|
|
100
|
+
"tags": ["service"],
|
|
101
|
+
"summary": "Retrieve from the conversation",
|
|
102
|
+
"description": "Retrieve data from the conversation history",
|
|
103
|
+
"parameters": [
|
|
104
|
+
{
|
|
105
|
+
"name": "limit",
|
|
106
|
+
"required": false,
|
|
107
|
+
"description": "limit",
|
|
108
|
+
"schema": {
|
|
109
|
+
"type": "number"
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"name": "orderby",
|
|
114
|
+
"required": false,
|
|
115
|
+
"description": "orderby",
|
|
116
|
+
"schema": {
|
|
117
|
+
"type": "string"
|
|
118
|
+
}
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"name": "query",
|
|
122
|
+
"required": true,
|
|
123
|
+
"description": "query",
|
|
124
|
+
"schema": {
|
|
125
|
+
"type": "string"
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"name": "baseUrl",
|
|
130
|
+
"required": false,
|
|
131
|
+
"description": "URL of the Vespa server",
|
|
132
|
+
"schema": {
|
|
133
|
+
"type": "string"
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
],
|
|
137
|
+
"x-events": []
|
|
138
|
+
}
|
|
139
|
+
},
|
|
140
|
+
"/search": {
|
|
141
|
+
"post": {
|
|
142
|
+
"tags": ["service"],
|
|
143
|
+
"summary": "Search in the conversation",
|
|
144
|
+
"description": "Search for data in the conversation history",
|
|
145
|
+
"parameters": [
|
|
146
|
+
{
|
|
147
|
+
"name": "embeddings",
|
|
148
|
+
"summary": "Embeddings Model",
|
|
149
|
+
"required": false,
|
|
150
|
+
"description": "Embeddings model to load",
|
|
151
|
+
"schema": {
|
|
152
|
+
"type": "array",
|
|
153
|
+
"items": {
|
|
154
|
+
"$ref": "https://schemas.digipair.ai/pinsSettings"
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "limit",
|
|
160
|
+
"required": false,
|
|
161
|
+
"description": "limit",
|
|
162
|
+
"schema": {
|
|
163
|
+
"type": "number"
|
|
164
|
+
}
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"name": "orderby",
|
|
168
|
+
"required": false,
|
|
169
|
+
"description": "orderby",
|
|
170
|
+
"schema": {
|
|
171
|
+
"type": "string"
|
|
172
|
+
}
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
"name": "targetHits",
|
|
176
|
+
"required": false,
|
|
177
|
+
"description": "targetHits",
|
|
178
|
+
"schema": {
|
|
179
|
+
"type": "number"
|
|
180
|
+
}
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"name": "query",
|
|
184
|
+
"required": true,
|
|
185
|
+
"description": "query",
|
|
186
|
+
"schema": {
|
|
187
|
+
"type": "string"
|
|
188
|
+
}
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"name": "baseUrl",
|
|
192
|
+
"required": false,
|
|
193
|
+
"description": "URL of the Vespa server",
|
|
194
|
+
"schema": {
|
|
195
|
+
"type": "string"
|
|
196
|
+
}
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "language",
|
|
200
|
+
"required": false,
|
|
201
|
+
"description": "Search language",
|
|
202
|
+
"schema": {
|
|
203
|
+
"type": "string"
|
|
204
|
+
}
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"name": "filter",
|
|
208
|
+
"required": false,
|
|
209
|
+
"description": "Search filter",
|
|
210
|
+
"schema": {
|
|
211
|
+
"type": "string"
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
],
|
|
215
|
+
"x-events": []
|
|
216
|
+
}
|
|
217
|
+
},
|
|
218
|
+
"/history": {
|
|
219
|
+
"post": {
|
|
220
|
+
"tags": ["service"],
|
|
221
|
+
"summary": "History",
|
|
222
|
+
"parameters": [
|
|
223
|
+
{
|
|
224
|
+
"name": "baseUrl",
|
|
225
|
+
"summary": "URL of the Vespa server",
|
|
226
|
+
"required": false,
|
|
227
|
+
"description": "URL of the Vespa server",
|
|
228
|
+
"schema": {
|
|
229
|
+
"type": "string"
|
|
230
|
+
}
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": "maxHistory",
|
|
234
|
+
"summary": "Maximum number of items",
|
|
235
|
+
"required": false,
|
|
236
|
+
"description": "orderby",
|
|
237
|
+
"schema": {
|
|
238
|
+
"type": "number"
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"name": "system",
|
|
243
|
+
"summary": "System",
|
|
244
|
+
"required": false,
|
|
245
|
+
"description": "targetHits",
|
|
246
|
+
"schema": {
|
|
247
|
+
"type": "string"
|
|
248
|
+
}
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "question",
|
|
252
|
+
"summary": "Assistant's question",
|
|
253
|
+
"required": false,
|
|
254
|
+
"description": "Assistant's question",
|
|
255
|
+
"schema": {
|
|
256
|
+
"type": "string"
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
],
|
|
260
|
+
"x-events": []
|
|
261
|
+
}
|
|
262
|
+
},
|
|
263
|
+
"/getRole": {
|
|
264
|
+
"post": {
|
|
265
|
+
"tags": ["service"],
|
|
266
|
+
"summary": "Role retrieval",
|
|
267
|
+
"parameters": [
|
|
268
|
+
{
|
|
269
|
+
"name": "role",
|
|
270
|
+
"summary": "Name",
|
|
271
|
+
"required": true,
|
|
272
|
+
"description": "Role name",
|
|
273
|
+
"schema": {
|
|
274
|
+
"type": "string"
|
|
275
|
+
}
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
"name": "baseUrl",
|
|
279
|
+
"summary": "URL of the Vespa server",
|
|
280
|
+
"required": false,
|
|
281
|
+
"description": "URL of the Vespa server",
|
|
282
|
+
"schema": {
|
|
283
|
+
"type": "string"
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
],
|
|
287
|
+
"x-events": []
|
|
288
|
+
}
|
|
289
|
+
},
|
|
290
|
+
"/setRole": {
|
|
291
|
+
"post": {
|
|
292
|
+
"tags": ["service"],
|
|
293
|
+
"summary": "Role update",
|
|
294
|
+
"parameters": [
|
|
295
|
+
{
|
|
296
|
+
"name": "role",
|
|
297
|
+
"summary": "Name",
|
|
298
|
+
"required": true,
|
|
299
|
+
"description": "Role name",
|
|
300
|
+
"schema": {
|
|
301
|
+
"type": "string"
|
|
302
|
+
}
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"name": "value",
|
|
306
|
+
"summary": "Value",
|
|
307
|
+
"required": true,
|
|
308
|
+
"description": "Role value",
|
|
309
|
+
"schema": {
|
|
310
|
+
"type": "string"
|
|
311
|
+
}
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "baseUrl",
|
|
315
|
+
"summary": "URL of the Vespa server",
|
|
316
|
+
"required": false,
|
|
317
|
+
"description": "URL of the Vespa server",
|
|
318
|
+
"schema": {
|
|
319
|
+
"type": "string"
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
],
|
|
323
|
+
"x-events": []
|
|
324
|
+
}
|
|
325
|
+
},
|
|
326
|
+
"/answer": {
|
|
327
|
+
"post": {
|
|
328
|
+
"tags": ["boost"],
|
|
329
|
+
"summary": "Chatbot response",
|
|
330
|
+
"parameters": [
|
|
331
|
+
{
|
|
332
|
+
"name": "assistant",
|
|
333
|
+
"required": true,
|
|
334
|
+
"description": "Response from the assistant",
|
|
335
|
+
"schema": {
|
|
336
|
+
"type": "string"
|
|
337
|
+
}
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"name": "command",
|
|
341
|
+
"required": false,
|
|
342
|
+
"description": "Commands executed on the chatbot",
|
|
343
|
+
"schema": {
|
|
344
|
+
"type": "array",
|
|
345
|
+
"items": {
|
|
346
|
+
"$ref": "https://schemas.digipair.ai/pinsSettings"
|
|
347
|
+
}
|
|
348
|
+
}
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"name": "boosts",
|
|
352
|
+
"required": false,
|
|
353
|
+
"description": "List of proposed boosts",
|
|
354
|
+
"schema": {
|
|
355
|
+
"type": "object"
|
|
356
|
+
}
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "sources",
|
|
360
|
+
"required": false,
|
|
361
|
+
"description": "List of sources used to respond to the user",
|
|
362
|
+
"schema": {
|
|
363
|
+
"type": "array",
|
|
364
|
+
"items": {
|
|
365
|
+
"type": "object"
|
|
366
|
+
}
|
|
367
|
+
}
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
"name": "logs",
|
|
371
|
+
"required": false,
|
|
372
|
+
"description": "Useful information for debugging reasoning",
|
|
373
|
+
"schema": {
|
|
374
|
+
"type": "object"
|
|
375
|
+
}
|
|
376
|
+
}
|
|
377
|
+
],
|
|
378
|
+
"x-events": []
|
|
379
|
+
}
|
|
380
|
+
}
|
|
381
|
+
},
|
|
382
|
+
"components": {
|
|
383
|
+
"schemas": {
|
|
384
|
+
"Boost": {
|
|
385
|
+
"type": "object",
|
|
386
|
+
"tags": ["boost"],
|
|
387
|
+
"summary": "Trigger",
|
|
388
|
+
"properties": {
|
|
389
|
+
"name": {
|
|
390
|
+
"type": "string"
|
|
391
|
+
},
|
|
392
|
+
"prompt": {
|
|
393
|
+
"type": "boolean"
|
|
394
|
+
},
|
|
395
|
+
"required": {
|
|
396
|
+
"type": "boolean"
|
|
397
|
+
},
|
|
398
|
+
"text": {
|
|
399
|
+
"type": "string"
|
|
400
|
+
},
|
|
401
|
+
"selector": {
|
|
402
|
+
"type": "string"
|
|
403
|
+
},
|
|
404
|
+
"url": {
|
|
405
|
+
"type": "string"
|
|
406
|
+
},
|
|
407
|
+
"inputs": {
|
|
408
|
+
"type": "array",
|
|
409
|
+
"items": {
|
|
410
|
+
"$ref": "https://schemas.digipair.ai/pinsSettings"
|
|
411
|
+
}
|
|
412
|
+
}
|
|
413
|
+
},
|
|
414
|
+
"required": []
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
},
|
|
418
|
+
"x-scene-blocks": {
|
|
419
|
+
"/boost": {
|
|
420
|
+
"summary": "Boost",
|
|
421
|
+
"description": "Boost proposed by Digipair",
|
|
422
|
+
"tags": ["boost", "service"],
|
|
423
|
+
"metadata": [
|
|
424
|
+
{
|
|
425
|
+
"name": "boosts",
|
|
426
|
+
"summary": "List of triggers",
|
|
427
|
+
"required": true,
|
|
428
|
+
"description": "List of boost triggers",
|
|
429
|
+
"schema": {
|
|
430
|
+
"type": "array",
|
|
431
|
+
"items": {
|
|
432
|
+
"$ref": "#/components/schemas/Boost"
|
|
433
|
+
}
|
|
434
|
+
}
|
|
435
|
+
}
|
|
436
|
+
],
|
|
437
|
+
"parameters": [
|
|
438
|
+
{
|
|
439
|
+
"name": "execute",
|
|
440
|
+
"summary": "Execution of actions",
|
|
441
|
+
"required": false,
|
|
442
|
+
"description": "List of actions to execute",
|
|
443
|
+
"schema": {
|
|
444
|
+
"type": "array",
|
|
445
|
+
"items": {
|
|
446
|
+
"$ref": "https://schemas.digipair.ai/pinsSettings"
|
|
447
|
+
}
|
|
448
|
+
}
|
|
449
|
+
}
|
|
450
|
+
]
|
|
451
|
+
}
|
|
452
|
+
}
|
|
453
|
+
}
|