n8n-nodes-qlik-cloud 1.0.1 → 1.0.3
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/icons/icons/qlik.svg +1 -0
- package/dist/nodes/QlikCloud/QlikCloud.node.js +84 -3
- package/dist/nodes/QlikCloud/resources/assistants/index.d.ts +7 -0
- package/dist/nodes/QlikCloud/resources/assistants/index.js +401 -8
- package/package.json +4 -3
- package/specifications/assistants.json +4531 -0
- package/specifications/assistants.json:MSOAVINFO +0 -0
- package/specifications/assistants.json:Zone.Identifier +0 -0
- package/src/icons/qlik.svg +1 -0
- package/src/nodes/QlikCloud/QlikCloud.node.ts +123 -3
- package/src/nodes/QlikCloud/resources/assistants/index.ts +407 -7
|
@@ -0,0 +1,4531 @@
|
|
|
1
|
+
{
|
|
2
|
+
"info": {
|
|
3
|
+
"title": "assistants",
|
|
4
|
+
"version": ""
|
|
5
|
+
},
|
|
6
|
+
"paths": {
|
|
7
|
+
"/api/v1/assistants": {
|
|
8
|
+
"get": {
|
|
9
|
+
"tags": [
|
|
10
|
+
"assistants"
|
|
11
|
+
],
|
|
12
|
+
"summary": "List assistants",
|
|
13
|
+
"responses": {
|
|
14
|
+
"200": {
|
|
15
|
+
"content": {
|
|
16
|
+
"application/json": {
|
|
17
|
+
"schema": {
|
|
18
|
+
"$ref": "#/components/schemas/assistantsResult"
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"description": "Successful operation."
|
|
23
|
+
},
|
|
24
|
+
"400": {
|
|
25
|
+
"content": {
|
|
26
|
+
"application/json": {
|
|
27
|
+
"schema": {
|
|
28
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
29
|
+
"x-qlik-merge-conflict": true
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"description": "The request is in incorrect format."
|
|
34
|
+
},
|
|
35
|
+
"403": {
|
|
36
|
+
"content": {
|
|
37
|
+
"application/json": {
|
|
38
|
+
"schema": {
|
|
39
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
40
|
+
"x-qlik-merge-conflict": true
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
"parameters": [
|
|
48
|
+
{
|
|
49
|
+
"in": "query",
|
|
50
|
+
"name": "limit",
|
|
51
|
+
"schema": {
|
|
52
|
+
"type": "integer",
|
|
53
|
+
"default": 20,
|
|
54
|
+
"maximum": 100,
|
|
55
|
+
"minimum": 1
|
|
56
|
+
},
|
|
57
|
+
"description": "The number of assistants to get."
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"in": "query",
|
|
61
|
+
"name": "next",
|
|
62
|
+
"schema": {
|
|
63
|
+
"type": "string"
|
|
64
|
+
},
|
|
65
|
+
"description": "Optional parameter to request the next page."
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"in": "query",
|
|
69
|
+
"name": "prev",
|
|
70
|
+
"schema": {
|
|
71
|
+
"type": "string"
|
|
72
|
+
},
|
|
73
|
+
"description": "Optional parameter to request the previous page."
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"in": "query",
|
|
77
|
+
"name": "sort",
|
|
78
|
+
"schema": {
|
|
79
|
+
"enum": [
|
|
80
|
+
"NAME",
|
|
81
|
+
"-NAME",
|
|
82
|
+
"DESCRIPTION",
|
|
83
|
+
"-DESCRIPTION",
|
|
84
|
+
"CREATED",
|
|
85
|
+
"-CREATED",
|
|
86
|
+
"UPDATED",
|
|
87
|
+
"-UPDATED"
|
|
88
|
+
],
|
|
89
|
+
"type": "string"
|
|
90
|
+
},
|
|
91
|
+
"description": "Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending."
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"in": "query",
|
|
95
|
+
"name": "countTotal",
|
|
96
|
+
"schema": {
|
|
97
|
+
"type": "boolean",
|
|
98
|
+
"default": false
|
|
99
|
+
},
|
|
100
|
+
"description": "Optional parameter to request total count for query.",
|
|
101
|
+
"x-qlik-deprecated": true
|
|
102
|
+
}
|
|
103
|
+
],
|
|
104
|
+
"description": "Retrieves the list of assistants. The result can be filtered, sorted, and paginated.",
|
|
105
|
+
"x-qlik-visibility": "public",
|
|
106
|
+
"x-qlik-stability": "stable",
|
|
107
|
+
"x-qlik-categories": [],
|
|
108
|
+
"x-qlik-deprecated": false,
|
|
109
|
+
"x-qlik-tier": {
|
|
110
|
+
"tier": "1",
|
|
111
|
+
"limit": 1000
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"post": {
|
|
115
|
+
"tags": [
|
|
116
|
+
"assistants"
|
|
117
|
+
],
|
|
118
|
+
"summary": "Create an assistant",
|
|
119
|
+
"responses": {
|
|
120
|
+
"201": {
|
|
121
|
+
"content": {
|
|
122
|
+
"application/json": {
|
|
123
|
+
"schema": {
|
|
124
|
+
"$ref": "#/components/schemas/Assistant"
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
"headers": {
|
|
129
|
+
"Etag": {
|
|
130
|
+
"schema": {
|
|
131
|
+
"type": "string"
|
|
132
|
+
},
|
|
133
|
+
"description": "Assistant version."
|
|
134
|
+
},
|
|
135
|
+
"Last-Modified": {
|
|
136
|
+
"schema": {
|
|
137
|
+
"type": "string"
|
|
138
|
+
},
|
|
139
|
+
"description": "Last modified date and time of the assistant."
|
|
140
|
+
}
|
|
141
|
+
},
|
|
142
|
+
"description": "Successfully created an assistant."
|
|
143
|
+
},
|
|
144
|
+
"400": {
|
|
145
|
+
"content": {
|
|
146
|
+
"application/json": {
|
|
147
|
+
"schema": {
|
|
148
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
149
|
+
"x-qlik-merge-conflict": true
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
"description": "The request is in incorrect format."
|
|
154
|
+
},
|
|
155
|
+
"403": {
|
|
156
|
+
"content": {
|
|
157
|
+
"application/json": {
|
|
158
|
+
"schema": {
|
|
159
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
160
|
+
"x-qlik-merge-conflict": true
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
165
|
+
}
|
|
166
|
+
},
|
|
167
|
+
"description": "Creates a new assistant.",
|
|
168
|
+
"requestBody": {
|
|
169
|
+
"content": {
|
|
170
|
+
"application/json": {
|
|
171
|
+
"schema": {
|
|
172
|
+
"$ref": "#/components/schemas/createAssistant"
|
|
173
|
+
}
|
|
174
|
+
},
|
|
175
|
+
"multipart/form-data": {
|
|
176
|
+
"schema": {
|
|
177
|
+
"$ref": "#/components/schemas/createAssistantWithAvatar"
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
},
|
|
182
|
+
"x-qlik-visibility": "public",
|
|
183
|
+
"x-qlik-stability": "stable",
|
|
184
|
+
"x-qlik-categories": [],
|
|
185
|
+
"x-qlik-deprecated": false,
|
|
186
|
+
"x-qlik-tier": {
|
|
187
|
+
"tier": "2",
|
|
188
|
+
"limit": 100
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
},
|
|
192
|
+
"/api/v1/assistants/{assistantId}/actions/search": {
|
|
193
|
+
"post": {
|
|
194
|
+
"tags": [
|
|
195
|
+
"search"
|
|
196
|
+
],
|
|
197
|
+
"summary": "Perform search on an assistant",
|
|
198
|
+
"responses": {
|
|
199
|
+
"200": {
|
|
200
|
+
"content": {
|
|
201
|
+
"application/json": {
|
|
202
|
+
"schema": {
|
|
203
|
+
"$ref": "#/components/schemas/searchResponse"
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
},
|
|
207
|
+
"description": "Chunks retrieved successfully."
|
|
208
|
+
},
|
|
209
|
+
"400": {
|
|
210
|
+
"content": {
|
|
211
|
+
"application/json": {
|
|
212
|
+
"schema": {
|
|
213
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
},
|
|
217
|
+
"description": "The request is in incorrect format"
|
|
218
|
+
},
|
|
219
|
+
"403": {
|
|
220
|
+
"content": {
|
|
221
|
+
"application/json": {
|
|
222
|
+
"schema": {
|
|
223
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
224
|
+
}
|
|
225
|
+
}
|
|
226
|
+
},
|
|
227
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
228
|
+
},
|
|
229
|
+
"404": {
|
|
230
|
+
"content": {
|
|
231
|
+
"application/json": {
|
|
232
|
+
"schema": {
|
|
233
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
},
|
|
237
|
+
"description": "Assistant is not found."
|
|
238
|
+
},
|
|
239
|
+
"405": {
|
|
240
|
+
"content": {
|
|
241
|
+
"application/json": {
|
|
242
|
+
"schema": {
|
|
243
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
},
|
|
247
|
+
"description": "Method is not allowed."
|
|
248
|
+
},
|
|
249
|
+
"500": {
|
|
250
|
+
"content": {
|
|
251
|
+
"application/json": {
|
|
252
|
+
"schema": {
|
|
253
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
},
|
|
257
|
+
"description": "Prompt processing error."
|
|
258
|
+
}
|
|
259
|
+
},
|
|
260
|
+
"parameters": [
|
|
261
|
+
{
|
|
262
|
+
"in": "path",
|
|
263
|
+
"name": "assistantId",
|
|
264
|
+
"schema": {
|
|
265
|
+
"type": "string",
|
|
266
|
+
"format": "uuid",
|
|
267
|
+
"example": "507f191e810c19729de860ea"
|
|
268
|
+
},
|
|
269
|
+
"required": true,
|
|
270
|
+
"description": "The ID for the Assistant of interest"
|
|
271
|
+
}
|
|
272
|
+
],
|
|
273
|
+
"description": "Perform search with either `SIMPLE` or `FULL` mode. SIMPLE does semantic search while FULL does semantic search, reranking and hybrid search. Use topN to control number of chunks in response, max limit is 50. Default to 5.\n",
|
|
274
|
+
"operationId": "searchAssistants",
|
|
275
|
+
"requestBody": {
|
|
276
|
+
"content": {
|
|
277
|
+
"application/json": {
|
|
278
|
+
"schema": {
|
|
279
|
+
"$ref": "#/components/schemas/searchRequest"
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
}
|
|
283
|
+
},
|
|
284
|
+
"x-qlik-visibility": "public",
|
|
285
|
+
"x-qlik-stability": "stable",
|
|
286
|
+
"x-qlik-categories": [],
|
|
287
|
+
"x-qlik-deprecated": false,
|
|
288
|
+
"x-qlik-tier": {
|
|
289
|
+
"tier": "2",
|
|
290
|
+
"limit": 100
|
|
291
|
+
}
|
|
292
|
+
}
|
|
293
|
+
},
|
|
294
|
+
"/api/v1/assistants/{assistantId}/feedback": {
|
|
295
|
+
"get": {
|
|
296
|
+
"tags": [
|
|
297
|
+
"assistants"
|
|
298
|
+
],
|
|
299
|
+
"summary": "Get feedback",
|
|
300
|
+
"responses": {
|
|
301
|
+
"200": {
|
|
302
|
+
"content": {
|
|
303
|
+
"application/json": {
|
|
304
|
+
"schema": {
|
|
305
|
+
"$ref": "#/components/schemas/feedbackSummary"
|
|
306
|
+
}
|
|
307
|
+
}
|
|
308
|
+
},
|
|
309
|
+
"description": "Successfully retrieved the feedback summary for the assistant."
|
|
310
|
+
},
|
|
311
|
+
"400": {
|
|
312
|
+
"content": {
|
|
313
|
+
"application/json": {
|
|
314
|
+
"schema": {
|
|
315
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
316
|
+
"x-qlik-merge-conflict": true
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
},
|
|
320
|
+
"description": "The request is in incorrect format."
|
|
321
|
+
},
|
|
322
|
+
"403": {
|
|
323
|
+
"content": {
|
|
324
|
+
"application/json": {
|
|
325
|
+
"schema": {
|
|
326
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
327
|
+
"x-qlik-merge-conflict": true
|
|
328
|
+
}
|
|
329
|
+
}
|
|
330
|
+
},
|
|
331
|
+
"description": "The operation failed due to insufficient permissions."
|
|
332
|
+
},
|
|
333
|
+
"404": {
|
|
334
|
+
"content": {
|
|
335
|
+
"application/json": {
|
|
336
|
+
"schema": {
|
|
337
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
338
|
+
"x-qlik-merge-conflict": true
|
|
339
|
+
}
|
|
340
|
+
}
|
|
341
|
+
},
|
|
342
|
+
"description": "The assistant was not found."
|
|
343
|
+
}
|
|
344
|
+
},
|
|
345
|
+
"parameters": [
|
|
346
|
+
{
|
|
347
|
+
"in": "path",
|
|
348
|
+
"name": "assistantId",
|
|
349
|
+
"schema": {
|
|
350
|
+
"type": "string",
|
|
351
|
+
"format": "uuid",
|
|
352
|
+
"example": "507f191e810c19729de860ea"
|
|
353
|
+
},
|
|
354
|
+
"required": true,
|
|
355
|
+
"description": "The ID of the assistant from which to retrieve feedback summary."
|
|
356
|
+
}
|
|
357
|
+
],
|
|
358
|
+
"description": "Retrieves feedback summary for the assistant.",
|
|
359
|
+
"x-qlik-visibility": "public",
|
|
360
|
+
"x-qlik-stability": "stable",
|
|
361
|
+
"x-qlik-categories": [],
|
|
362
|
+
"x-qlik-deprecated": false,
|
|
363
|
+
"x-qlik-tier": {
|
|
364
|
+
"tier": "1",
|
|
365
|
+
"limit": 1000
|
|
366
|
+
}
|
|
367
|
+
}
|
|
368
|
+
},
|
|
369
|
+
"/api/v1/assistants/{assistantId}/sources/plaintexts": {
|
|
370
|
+
"post": {
|
|
371
|
+
"tags": [
|
|
372
|
+
"assistants"
|
|
373
|
+
],
|
|
374
|
+
"summary": "Bulk search source chunks",
|
|
375
|
+
"responses": {
|
|
376
|
+
"202": {
|
|
377
|
+
"content": {
|
|
378
|
+
"application/json": {
|
|
379
|
+
"schema": {
|
|
380
|
+
"$ref": "#/components/schemas/sourcesPlaintext"
|
|
381
|
+
}
|
|
382
|
+
}
|
|
383
|
+
},
|
|
384
|
+
"description": "Successfully retrieved plaintext of the chunks."
|
|
385
|
+
},
|
|
386
|
+
"400": {
|
|
387
|
+
"content": {
|
|
388
|
+
"application/json": {
|
|
389
|
+
"schema": {
|
|
390
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
391
|
+
"x-qlik-merge-conflict": true
|
|
392
|
+
}
|
|
393
|
+
}
|
|
394
|
+
},
|
|
395
|
+
"description": "The request is in incorrect format."
|
|
396
|
+
},
|
|
397
|
+
"403": {
|
|
398
|
+
"content": {
|
|
399
|
+
"application/json": {
|
|
400
|
+
"schema": {
|
|
401
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
402
|
+
"x-qlik-merge-conflict": true
|
|
403
|
+
}
|
|
404
|
+
}
|
|
405
|
+
},
|
|
406
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
407
|
+
},
|
|
408
|
+
"404": {
|
|
409
|
+
"content": {
|
|
410
|
+
"application/json": {
|
|
411
|
+
"schema": {
|
|
412
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
413
|
+
"x-qlik-merge-conflict": true
|
|
414
|
+
}
|
|
415
|
+
}
|
|
416
|
+
},
|
|
417
|
+
"description": "The resource was not found."
|
|
418
|
+
}
|
|
419
|
+
},
|
|
420
|
+
"parameters": [
|
|
421
|
+
{
|
|
422
|
+
"in": "path",
|
|
423
|
+
"name": "assistantId",
|
|
424
|
+
"schema": {
|
|
425
|
+
"type": "string",
|
|
426
|
+
"format": "uuid",
|
|
427
|
+
"example": "507f191e810c19729de860ea"
|
|
428
|
+
},
|
|
429
|
+
"required": true,
|
|
430
|
+
"description": "The ID of the assistant in which to search for source chunks."
|
|
431
|
+
}
|
|
432
|
+
],
|
|
433
|
+
"description": "Perform a bulk search for the plaintext of source chunks for the assistant.",
|
|
434
|
+
"requestBody": {
|
|
435
|
+
"content": {
|
|
436
|
+
"application/json": {
|
|
437
|
+
"schema": {
|
|
438
|
+
"$ref": "#/components/schemas/ChunksRefs"
|
|
439
|
+
}
|
|
440
|
+
}
|
|
441
|
+
}
|
|
442
|
+
},
|
|
443
|
+
"x-qlik-visibility": "public",
|
|
444
|
+
"x-qlik-stability": "stable",
|
|
445
|
+
"x-qlik-categories": [],
|
|
446
|
+
"x-qlik-deprecated": false,
|
|
447
|
+
"x-qlik-tier": {
|
|
448
|
+
"tier": "2",
|
|
449
|
+
"limit": 100
|
|
450
|
+
}
|
|
451
|
+
}
|
|
452
|
+
},
|
|
453
|
+
"/api/v1/assistants/{assistantId}/starters": {
|
|
454
|
+
"get": {
|
|
455
|
+
"tags": [
|
|
456
|
+
"starters"
|
|
457
|
+
],
|
|
458
|
+
"summary": "List starters",
|
|
459
|
+
"responses": {
|
|
460
|
+
"200": {
|
|
461
|
+
"content": {
|
|
462
|
+
"application/json": {
|
|
463
|
+
"schema": {
|
|
464
|
+
"$ref": "#/components/schemas/startersResult"
|
|
465
|
+
}
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
"description": "Successfully retrieved the assistant's starters."
|
|
469
|
+
},
|
|
470
|
+
"400": {
|
|
471
|
+
"content": {
|
|
472
|
+
"application/json": {
|
|
473
|
+
"schema": {
|
|
474
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
475
|
+
"x-qlik-merge-conflict": true
|
|
476
|
+
}
|
|
477
|
+
}
|
|
478
|
+
},
|
|
479
|
+
"description": "The request is in incorrect format."
|
|
480
|
+
},
|
|
481
|
+
"403": {
|
|
482
|
+
"content": {
|
|
483
|
+
"application/json": {
|
|
484
|
+
"schema": {
|
|
485
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
486
|
+
"x-qlik-merge-conflict": true
|
|
487
|
+
}
|
|
488
|
+
}
|
|
489
|
+
},
|
|
490
|
+
"description": "The operation failed due to insufficient permissions."
|
|
491
|
+
},
|
|
492
|
+
"404": {
|
|
493
|
+
"content": {
|
|
494
|
+
"application/json": {
|
|
495
|
+
"schema": {
|
|
496
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
497
|
+
"x-qlik-merge-conflict": true
|
|
498
|
+
}
|
|
499
|
+
}
|
|
500
|
+
},
|
|
501
|
+
"description": "The assistant was not found."
|
|
502
|
+
}
|
|
503
|
+
},
|
|
504
|
+
"parameters": [
|
|
505
|
+
{
|
|
506
|
+
"in": "path",
|
|
507
|
+
"name": "assistantId",
|
|
508
|
+
"schema": {
|
|
509
|
+
"type": "string",
|
|
510
|
+
"format": "uuid",
|
|
511
|
+
"example": "507f191e810c19729de860ea"
|
|
512
|
+
},
|
|
513
|
+
"required": true,
|
|
514
|
+
"description": "The ID of the assistant from which to retrieve starters."
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"in": "query",
|
|
518
|
+
"name": "limit",
|
|
519
|
+
"schema": {
|
|
520
|
+
"type": "integer",
|
|
521
|
+
"default": 20,
|
|
522
|
+
"maximum": 100,
|
|
523
|
+
"minimum": 1
|
|
524
|
+
},
|
|
525
|
+
"description": "The number of starters to get."
|
|
526
|
+
},
|
|
527
|
+
{
|
|
528
|
+
"in": "query",
|
|
529
|
+
"name": "next",
|
|
530
|
+
"schema": {
|
|
531
|
+
"type": "string"
|
|
532
|
+
},
|
|
533
|
+
"description": "Optional parameter to request the next page."
|
|
534
|
+
},
|
|
535
|
+
{
|
|
536
|
+
"in": "query",
|
|
537
|
+
"name": "prev",
|
|
538
|
+
"schema": {
|
|
539
|
+
"type": "string"
|
|
540
|
+
},
|
|
541
|
+
"description": "Optional parameter to request the previous page."
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
"in": "query",
|
|
545
|
+
"name": "sort",
|
|
546
|
+
"schema": {
|
|
547
|
+
"enum": [
|
|
548
|
+
"QUESTION",
|
|
549
|
+
"-QUESTION",
|
|
550
|
+
"CREATED",
|
|
551
|
+
"-CREATED",
|
|
552
|
+
"UPDATED",
|
|
553
|
+
"-UPDATED"
|
|
554
|
+
],
|
|
555
|
+
"type": "string"
|
|
556
|
+
},
|
|
557
|
+
"description": "Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending."
|
|
558
|
+
}
|
|
559
|
+
],
|
|
560
|
+
"description": "Retrieves the list of starters for the assistant.",
|
|
561
|
+
"x-qlik-visibility": "public",
|
|
562
|
+
"x-qlik-stability": "stable",
|
|
563
|
+
"x-qlik-categories": [],
|
|
564
|
+
"x-qlik-deprecated": false,
|
|
565
|
+
"x-qlik-tier": {
|
|
566
|
+
"tier": "1",
|
|
567
|
+
"limit": 1000
|
|
568
|
+
}
|
|
569
|
+
},
|
|
570
|
+
"post": {
|
|
571
|
+
"tags": [
|
|
572
|
+
"starters"
|
|
573
|
+
],
|
|
574
|
+
"summary": "Create a starter",
|
|
575
|
+
"responses": {
|
|
576
|
+
"201": {
|
|
577
|
+
"content": {
|
|
578
|
+
"application/json": {
|
|
579
|
+
"schema": {
|
|
580
|
+
"$ref": "#/components/schemas/Starter"
|
|
581
|
+
}
|
|
582
|
+
}
|
|
583
|
+
},
|
|
584
|
+
"headers": {
|
|
585
|
+
"Etag": {
|
|
586
|
+
"schema": {
|
|
587
|
+
"type": "string"
|
|
588
|
+
},
|
|
589
|
+
"description": "Assistant starter version."
|
|
590
|
+
},
|
|
591
|
+
"Last-Modified": {
|
|
592
|
+
"schema": {
|
|
593
|
+
"type": "string"
|
|
594
|
+
},
|
|
595
|
+
"description": "Last modified date and time of the assistant starter."
|
|
596
|
+
}
|
|
597
|
+
},
|
|
598
|
+
"description": "Successfully created a new assistant starter."
|
|
599
|
+
},
|
|
600
|
+
"400": {
|
|
601
|
+
"content": {
|
|
602
|
+
"application/json": {
|
|
603
|
+
"schema": {
|
|
604
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
605
|
+
"x-qlik-merge-conflict": true
|
|
606
|
+
}
|
|
607
|
+
}
|
|
608
|
+
},
|
|
609
|
+
"description": "The request is in incorrect format or starter limit exceeded."
|
|
610
|
+
},
|
|
611
|
+
"403": {
|
|
612
|
+
"content": {
|
|
613
|
+
"application/json": {
|
|
614
|
+
"schema": {
|
|
615
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
616
|
+
"x-qlik-merge-conflict": true
|
|
617
|
+
}
|
|
618
|
+
}
|
|
619
|
+
},
|
|
620
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
621
|
+
},
|
|
622
|
+
"404": {
|
|
623
|
+
"content": {
|
|
624
|
+
"application/json": {
|
|
625
|
+
"schema": {
|
|
626
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
627
|
+
"x-qlik-merge-conflict": true
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
},
|
|
631
|
+
"description": "The assistant was not found."
|
|
632
|
+
}
|
|
633
|
+
},
|
|
634
|
+
"parameters": [
|
|
635
|
+
{
|
|
636
|
+
"in": "path",
|
|
637
|
+
"name": "assistantId",
|
|
638
|
+
"schema": {
|
|
639
|
+
"type": "string",
|
|
640
|
+
"format": "uuid",
|
|
641
|
+
"example": "507f191e810c19729de860ea"
|
|
642
|
+
},
|
|
643
|
+
"required": true,
|
|
644
|
+
"description": "The ID of the assistant in which to create the starter."
|
|
645
|
+
}
|
|
646
|
+
],
|
|
647
|
+
"description": "Creates a new starter for the assistant.",
|
|
648
|
+
"requestBody": {
|
|
649
|
+
"content": {
|
|
650
|
+
"application/json": {
|
|
651
|
+
"schema": {
|
|
652
|
+
"$ref": "#/components/schemas/createStarter"
|
|
653
|
+
}
|
|
654
|
+
}
|
|
655
|
+
}
|
|
656
|
+
},
|
|
657
|
+
"x-qlik-visibility": "public",
|
|
658
|
+
"x-qlik-stability": "stable",
|
|
659
|
+
"x-qlik-categories": [],
|
|
660
|
+
"x-qlik-deprecated": false,
|
|
661
|
+
"x-qlik-tier": {
|
|
662
|
+
"tier": "2",
|
|
663
|
+
"limit": 100
|
|
664
|
+
}
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
"/api/v1/assistants/{assistantId}/starters/{starterId}": {
|
|
668
|
+
"get": {
|
|
669
|
+
"tags": [
|
|
670
|
+
"starters"
|
|
671
|
+
],
|
|
672
|
+
"summary": "Get a starter",
|
|
673
|
+
"responses": {
|
|
674
|
+
"200": {
|
|
675
|
+
"content": {
|
|
676
|
+
"application/json": {
|
|
677
|
+
"schema": {
|
|
678
|
+
"$ref": "#/components/schemas/Starter"
|
|
679
|
+
}
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
"description": "Successfully retrieved the starter."
|
|
683
|
+
},
|
|
684
|
+
"400": {
|
|
685
|
+
"content": {
|
|
686
|
+
"application/json": {
|
|
687
|
+
"schema": {
|
|
688
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
689
|
+
"x-qlik-merge-conflict": true
|
|
690
|
+
}
|
|
691
|
+
}
|
|
692
|
+
},
|
|
693
|
+
"description": "The request is in incorrect format."
|
|
694
|
+
},
|
|
695
|
+
"403": {
|
|
696
|
+
"content": {
|
|
697
|
+
"application/json": {
|
|
698
|
+
"schema": {
|
|
699
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
700
|
+
"x-qlik-merge-conflict": true
|
|
701
|
+
}
|
|
702
|
+
}
|
|
703
|
+
},
|
|
704
|
+
"description": "The operation failed due to insufficient permissions."
|
|
705
|
+
},
|
|
706
|
+
"404": {
|
|
707
|
+
"content": {
|
|
708
|
+
"application/json": {
|
|
709
|
+
"schema": {
|
|
710
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
711
|
+
"x-qlik-merge-conflict": true
|
|
712
|
+
}
|
|
713
|
+
}
|
|
714
|
+
},
|
|
715
|
+
"description": "The starter was not found."
|
|
716
|
+
}
|
|
717
|
+
},
|
|
718
|
+
"parameters": [
|
|
719
|
+
{
|
|
720
|
+
"in": "path",
|
|
721
|
+
"name": "assistantId",
|
|
722
|
+
"schema": {
|
|
723
|
+
"type": "string",
|
|
724
|
+
"format": "uuid",
|
|
725
|
+
"example": "507f191e810c19729de860ea"
|
|
726
|
+
},
|
|
727
|
+
"required": true,
|
|
728
|
+
"description": "The ID of the assistant containing the requested starter."
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
"in": "path",
|
|
732
|
+
"name": "starterId",
|
|
733
|
+
"schema": {
|
|
734
|
+
"type": "string",
|
|
735
|
+
"format": "uuid",
|
|
736
|
+
"example": "507f191e810c19729de860ea"
|
|
737
|
+
},
|
|
738
|
+
"required": true,
|
|
739
|
+
"description": "The ID of the starter to retrieve."
|
|
740
|
+
}
|
|
741
|
+
],
|
|
742
|
+
"description": "Retrieves the specified starter.",
|
|
743
|
+
"x-qlik-visibility": "public",
|
|
744
|
+
"x-qlik-stability": "stable",
|
|
745
|
+
"x-qlik-categories": [],
|
|
746
|
+
"x-qlik-deprecated": false,
|
|
747
|
+
"x-qlik-tier": {
|
|
748
|
+
"tier": "1",
|
|
749
|
+
"limit": 1000
|
|
750
|
+
}
|
|
751
|
+
},
|
|
752
|
+
"put": {
|
|
753
|
+
"tags": [
|
|
754
|
+
"starters"
|
|
755
|
+
],
|
|
756
|
+
"summary": "Update a starter",
|
|
757
|
+
"responses": {
|
|
758
|
+
"200": {
|
|
759
|
+
"content": {
|
|
760
|
+
"application/json": {
|
|
761
|
+
"schema": {
|
|
762
|
+
"$ref": "#/components/schemas/Starter"
|
|
763
|
+
}
|
|
764
|
+
}
|
|
765
|
+
},
|
|
766
|
+
"headers": {
|
|
767
|
+
"Etag": {
|
|
768
|
+
"schema": {
|
|
769
|
+
"type": "string"
|
|
770
|
+
},
|
|
771
|
+
"description": "Assistant version."
|
|
772
|
+
},
|
|
773
|
+
"Last-Modified": {
|
|
774
|
+
"schema": {
|
|
775
|
+
"type": "string"
|
|
776
|
+
},
|
|
777
|
+
"description": "Last modified date and time of the assistant."
|
|
778
|
+
}
|
|
779
|
+
},
|
|
780
|
+
"description": "Successfully updated the starter."
|
|
781
|
+
},
|
|
782
|
+
"400": {
|
|
783
|
+
"content": {
|
|
784
|
+
"application/json": {
|
|
785
|
+
"schema": {
|
|
786
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
787
|
+
"x-qlik-merge-conflict": true
|
|
788
|
+
}
|
|
789
|
+
}
|
|
790
|
+
},
|
|
791
|
+
"description": "The request is in incorrect format."
|
|
792
|
+
},
|
|
793
|
+
"403": {
|
|
794
|
+
"content": {
|
|
795
|
+
"application/json": {
|
|
796
|
+
"schema": {
|
|
797
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
798
|
+
"x-qlik-merge-conflict": true
|
|
799
|
+
}
|
|
800
|
+
}
|
|
801
|
+
},
|
|
802
|
+
"description": "The operation failed due to insufficient permissions."
|
|
803
|
+
},
|
|
804
|
+
"404": {
|
|
805
|
+
"content": {
|
|
806
|
+
"application/json": {
|
|
807
|
+
"schema": {
|
|
808
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
809
|
+
"x-qlik-merge-conflict": true
|
|
810
|
+
}
|
|
811
|
+
}
|
|
812
|
+
},
|
|
813
|
+
"description": "The record was not found."
|
|
814
|
+
}
|
|
815
|
+
},
|
|
816
|
+
"parameters": [
|
|
817
|
+
{
|
|
818
|
+
"in": "path",
|
|
819
|
+
"name": "assistantId",
|
|
820
|
+
"schema": {
|
|
821
|
+
"type": "string",
|
|
822
|
+
"format": "uuid",
|
|
823
|
+
"example": "507f191e810c19729de860ea"
|
|
824
|
+
},
|
|
825
|
+
"required": true,
|
|
826
|
+
"description": "The ID of the assistant containing the requested starter."
|
|
827
|
+
},
|
|
828
|
+
{
|
|
829
|
+
"in": "path",
|
|
830
|
+
"name": "starterId",
|
|
831
|
+
"schema": {
|
|
832
|
+
"type": "string",
|
|
833
|
+
"format": "uuid",
|
|
834
|
+
"example": "507f191e810c19729de860ea"
|
|
835
|
+
},
|
|
836
|
+
"required": true,
|
|
837
|
+
"description": "The ID of the starter to retrieve."
|
|
838
|
+
}
|
|
839
|
+
],
|
|
840
|
+
"description": "Updates the specified starter.",
|
|
841
|
+
"requestBody": {
|
|
842
|
+
"content": {
|
|
843
|
+
"application/json": {
|
|
844
|
+
"schema": {
|
|
845
|
+
"$ref": "#/components/schemas/Starter"
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
}
|
|
849
|
+
},
|
|
850
|
+
"x-qlik-visibility": "public",
|
|
851
|
+
"x-qlik-stability": "stable",
|
|
852
|
+
"x-qlik-categories": [],
|
|
853
|
+
"x-qlik-deprecated": false,
|
|
854
|
+
"x-qlik-tier": {
|
|
855
|
+
"tier": "2",
|
|
856
|
+
"limit": 100
|
|
857
|
+
}
|
|
858
|
+
},
|
|
859
|
+
"delete": {
|
|
860
|
+
"tags": [
|
|
861
|
+
"starters"
|
|
862
|
+
],
|
|
863
|
+
"summary": "Delete a starter",
|
|
864
|
+
"responses": {
|
|
865
|
+
"204": {
|
|
866
|
+
"description": "Successful operation."
|
|
867
|
+
},
|
|
868
|
+
"400": {
|
|
869
|
+
"content": {
|
|
870
|
+
"application/json": {
|
|
871
|
+
"schema": {
|
|
872
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
873
|
+
"x-qlik-merge-conflict": true
|
|
874
|
+
}
|
|
875
|
+
}
|
|
876
|
+
},
|
|
877
|
+
"description": "The request is in incorrect format."
|
|
878
|
+
},
|
|
879
|
+
"403": {
|
|
880
|
+
"content": {
|
|
881
|
+
"application/json": {
|
|
882
|
+
"schema": {
|
|
883
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
884
|
+
"x-qlik-merge-conflict": true
|
|
885
|
+
}
|
|
886
|
+
}
|
|
887
|
+
},
|
|
888
|
+
"description": "The operation failed due to insufficient permissions."
|
|
889
|
+
},
|
|
890
|
+
"404": {
|
|
891
|
+
"content": {
|
|
892
|
+
"application/json": {
|
|
893
|
+
"schema": {
|
|
894
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
895
|
+
"x-qlik-merge-conflict": true
|
|
896
|
+
}
|
|
897
|
+
}
|
|
898
|
+
},
|
|
899
|
+
"description": "The assistant was not found."
|
|
900
|
+
}
|
|
901
|
+
},
|
|
902
|
+
"parameters": [
|
|
903
|
+
{
|
|
904
|
+
"in": "path",
|
|
905
|
+
"name": "assistantId",
|
|
906
|
+
"schema": {
|
|
907
|
+
"type": "string",
|
|
908
|
+
"format": "uuid",
|
|
909
|
+
"example": "507f191e810c19729de860ea"
|
|
910
|
+
},
|
|
911
|
+
"required": true,
|
|
912
|
+
"description": "The ID of the assistant containing the requested starter."
|
|
913
|
+
},
|
|
914
|
+
{
|
|
915
|
+
"in": "path",
|
|
916
|
+
"name": "starterId",
|
|
917
|
+
"schema": {
|
|
918
|
+
"type": "string",
|
|
919
|
+
"format": "uuid",
|
|
920
|
+
"example": "507f191e810c19729de860ea"
|
|
921
|
+
},
|
|
922
|
+
"required": true,
|
|
923
|
+
"description": "The ID of the starter to delete."
|
|
924
|
+
}
|
|
925
|
+
],
|
|
926
|
+
"description": "Deletes the starter and all of its resources.",
|
|
927
|
+
"x-qlik-visibility": "public",
|
|
928
|
+
"x-qlik-stability": "stable",
|
|
929
|
+
"x-qlik-categories": [],
|
|
930
|
+
"x-qlik-deprecated": false,
|
|
931
|
+
"x-qlik-tier": {
|
|
932
|
+
"tier": "2",
|
|
933
|
+
"limit": 100
|
|
934
|
+
}
|
|
935
|
+
}
|
|
936
|
+
},
|
|
937
|
+
"/api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}": {
|
|
938
|
+
"put": {
|
|
939
|
+
"tags": [
|
|
940
|
+
"starters"
|
|
941
|
+
],
|
|
942
|
+
"summary": "Update a Followup",
|
|
943
|
+
"responses": {
|
|
944
|
+
"200": {
|
|
945
|
+
"content": {
|
|
946
|
+
"application/json": {
|
|
947
|
+
"schema": {
|
|
948
|
+
"$ref": "#/components/schemas/Starter"
|
|
949
|
+
}
|
|
950
|
+
}
|
|
951
|
+
},
|
|
952
|
+
"headers": {
|
|
953
|
+
"Etag": {
|
|
954
|
+
"schema": {
|
|
955
|
+
"type": "string"
|
|
956
|
+
},
|
|
957
|
+
"description": "Assistant version."
|
|
958
|
+
},
|
|
959
|
+
"Last-Modified": {
|
|
960
|
+
"schema": {
|
|
961
|
+
"type": "string"
|
|
962
|
+
},
|
|
963
|
+
"description": "Last modified date and time of the Followup."
|
|
964
|
+
}
|
|
965
|
+
},
|
|
966
|
+
"description": "Successfully updated the Followup."
|
|
967
|
+
},
|
|
968
|
+
"400": {
|
|
969
|
+
"content": {
|
|
970
|
+
"application/json": {
|
|
971
|
+
"schema": {
|
|
972
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
973
|
+
"x-qlik-merge-conflict": true
|
|
974
|
+
}
|
|
975
|
+
}
|
|
976
|
+
},
|
|
977
|
+
"description": "The request is in incorrect format."
|
|
978
|
+
},
|
|
979
|
+
"403": {
|
|
980
|
+
"content": {
|
|
981
|
+
"application/json": {
|
|
982
|
+
"schema": {
|
|
983
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
984
|
+
"x-qlik-merge-conflict": true
|
|
985
|
+
}
|
|
986
|
+
}
|
|
987
|
+
},
|
|
988
|
+
"description": "The operation failed due to insufficient permissions."
|
|
989
|
+
},
|
|
990
|
+
"404": {
|
|
991
|
+
"content": {
|
|
992
|
+
"application/json": {
|
|
993
|
+
"schema": {
|
|
994
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
995
|
+
"x-qlik-merge-conflict": true
|
|
996
|
+
}
|
|
997
|
+
}
|
|
998
|
+
},
|
|
999
|
+
"description": "The record was not found."
|
|
1000
|
+
}
|
|
1001
|
+
},
|
|
1002
|
+
"parameters": [
|
|
1003
|
+
{
|
|
1004
|
+
"in": "path",
|
|
1005
|
+
"name": "assistantId",
|
|
1006
|
+
"schema": {
|
|
1007
|
+
"type": "string",
|
|
1008
|
+
"format": "uuid",
|
|
1009
|
+
"example": "507f191e810c19729de860ea"
|
|
1010
|
+
},
|
|
1011
|
+
"required": true,
|
|
1012
|
+
"description": "The ID of the assistant containing the requested Followup."
|
|
1013
|
+
},
|
|
1014
|
+
{
|
|
1015
|
+
"in": "path",
|
|
1016
|
+
"name": "followupId",
|
|
1017
|
+
"schema": {
|
|
1018
|
+
"type": "string",
|
|
1019
|
+
"format": "uuid",
|
|
1020
|
+
"example": "507f191e810c19729de860ea"
|
|
1021
|
+
},
|
|
1022
|
+
"required": true,
|
|
1023
|
+
"description": "The ID of the Followup to update."
|
|
1024
|
+
},
|
|
1025
|
+
{
|
|
1026
|
+
"in": "path",
|
|
1027
|
+
"name": "starterId",
|
|
1028
|
+
"schema": {
|
|
1029
|
+
"type": "string",
|
|
1030
|
+
"format": "uuid",
|
|
1031
|
+
"example": "507f191e810c19729de860ea"
|
|
1032
|
+
},
|
|
1033
|
+
"required": true,
|
|
1034
|
+
"description": "The ID of the starter containing the requested Followup."
|
|
1035
|
+
}
|
|
1036
|
+
],
|
|
1037
|
+
"description": "Updates the specified Followup.",
|
|
1038
|
+
"requestBody": {
|
|
1039
|
+
"content": {
|
|
1040
|
+
"application/json": {
|
|
1041
|
+
"schema": {
|
|
1042
|
+
"$ref": "#/components/schemas/followup"
|
|
1043
|
+
}
|
|
1044
|
+
}
|
|
1045
|
+
}
|
|
1046
|
+
},
|
|
1047
|
+
"x-qlik-visibility": "public",
|
|
1048
|
+
"x-qlik-stability": "stable",
|
|
1049
|
+
"x-qlik-categories": [],
|
|
1050
|
+
"x-qlik-deprecated": false,
|
|
1051
|
+
"x-qlik-tier": {
|
|
1052
|
+
"tier": "2",
|
|
1053
|
+
"limit": 100
|
|
1054
|
+
}
|
|
1055
|
+
},
|
|
1056
|
+
"delete": {
|
|
1057
|
+
"tags": [
|
|
1058
|
+
"starters"
|
|
1059
|
+
],
|
|
1060
|
+
"summary": "Delete a Followup",
|
|
1061
|
+
"responses": {
|
|
1062
|
+
"204": {
|
|
1063
|
+
"description": "Successful operation."
|
|
1064
|
+
},
|
|
1065
|
+
"400": {
|
|
1066
|
+
"content": {
|
|
1067
|
+
"application/json": {
|
|
1068
|
+
"schema": {
|
|
1069
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1070
|
+
"x-qlik-merge-conflict": true
|
|
1071
|
+
}
|
|
1072
|
+
}
|
|
1073
|
+
},
|
|
1074
|
+
"description": "The request is in incorrect format."
|
|
1075
|
+
},
|
|
1076
|
+
"403": {
|
|
1077
|
+
"content": {
|
|
1078
|
+
"application/json": {
|
|
1079
|
+
"schema": {
|
|
1080
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1081
|
+
"x-qlik-merge-conflict": true
|
|
1082
|
+
}
|
|
1083
|
+
}
|
|
1084
|
+
},
|
|
1085
|
+
"description": "The operation failed due to insufficient permissions."
|
|
1086
|
+
},
|
|
1087
|
+
"404": {
|
|
1088
|
+
"content": {
|
|
1089
|
+
"application/json": {
|
|
1090
|
+
"schema": {
|
|
1091
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1092
|
+
"x-qlik-merge-conflict": true
|
|
1093
|
+
}
|
|
1094
|
+
}
|
|
1095
|
+
},
|
|
1096
|
+
"description": "The Followup was not found."
|
|
1097
|
+
}
|
|
1098
|
+
},
|
|
1099
|
+
"parameters": [
|
|
1100
|
+
{
|
|
1101
|
+
"in": "path",
|
|
1102
|
+
"name": "assistantId",
|
|
1103
|
+
"schema": {
|
|
1104
|
+
"type": "string",
|
|
1105
|
+
"format": "uuid",
|
|
1106
|
+
"example": "507f191e810c19729de860ea"
|
|
1107
|
+
},
|
|
1108
|
+
"required": true,
|
|
1109
|
+
"description": "The ID of the assistant containing the requested Followup."
|
|
1110
|
+
},
|
|
1111
|
+
{
|
|
1112
|
+
"in": "path",
|
|
1113
|
+
"name": "followupId",
|
|
1114
|
+
"schema": {
|
|
1115
|
+
"type": "string",
|
|
1116
|
+
"format": "uuid",
|
|
1117
|
+
"example": "507f191e810c19729de860ea"
|
|
1118
|
+
},
|
|
1119
|
+
"required": true,
|
|
1120
|
+
"description": "The ID of the Followup to delete."
|
|
1121
|
+
},
|
|
1122
|
+
{
|
|
1123
|
+
"in": "path",
|
|
1124
|
+
"name": "starterId",
|
|
1125
|
+
"schema": {
|
|
1126
|
+
"type": "string",
|
|
1127
|
+
"format": "uuid",
|
|
1128
|
+
"example": "507f191e810c19729de860ea"
|
|
1129
|
+
},
|
|
1130
|
+
"required": true,
|
|
1131
|
+
"description": "The ID of the starter containing the requested Followup."
|
|
1132
|
+
}
|
|
1133
|
+
],
|
|
1134
|
+
"description": "Deletes the specified Followup.",
|
|
1135
|
+
"x-qlik-visibility": "public",
|
|
1136
|
+
"x-qlik-stability": "stable",
|
|
1137
|
+
"x-qlik-categories": [],
|
|
1138
|
+
"x-qlik-deprecated": false,
|
|
1139
|
+
"x-qlik-tier": {
|
|
1140
|
+
"tier": "2",
|
|
1141
|
+
"limit": 100
|
|
1142
|
+
}
|
|
1143
|
+
}
|
|
1144
|
+
},
|
|
1145
|
+
"/api/v1/assistants/{assistantId}/threads": {
|
|
1146
|
+
"get": {
|
|
1147
|
+
"tags": [
|
|
1148
|
+
"threads"
|
|
1149
|
+
],
|
|
1150
|
+
"summary": "List threads",
|
|
1151
|
+
"responses": {
|
|
1152
|
+
"200": {
|
|
1153
|
+
"content": {
|
|
1154
|
+
"application/json": {
|
|
1155
|
+
"schema": {
|
|
1156
|
+
"$ref": "#/components/schemas/threadsResult"
|
|
1157
|
+
}
|
|
1158
|
+
}
|
|
1159
|
+
},
|
|
1160
|
+
"description": "Successfully retrieved the threads for the assistant."
|
|
1161
|
+
},
|
|
1162
|
+
"400": {
|
|
1163
|
+
"content": {
|
|
1164
|
+
"application/json": {
|
|
1165
|
+
"schema": {
|
|
1166
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1167
|
+
"x-qlik-merge-conflict": true
|
|
1168
|
+
}
|
|
1169
|
+
}
|
|
1170
|
+
},
|
|
1171
|
+
"description": "The request is in incorrect format."
|
|
1172
|
+
},
|
|
1173
|
+
"403": {
|
|
1174
|
+
"content": {
|
|
1175
|
+
"application/json": {
|
|
1176
|
+
"schema": {
|
|
1177
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1178
|
+
"x-qlik-merge-conflict": true
|
|
1179
|
+
}
|
|
1180
|
+
}
|
|
1181
|
+
},
|
|
1182
|
+
"description": "The operation failed due to insufficient permissions."
|
|
1183
|
+
},
|
|
1184
|
+
"404": {
|
|
1185
|
+
"content": {
|
|
1186
|
+
"application/json": {
|
|
1187
|
+
"schema": {
|
|
1188
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1189
|
+
"x-qlik-merge-conflict": true
|
|
1190
|
+
}
|
|
1191
|
+
}
|
|
1192
|
+
},
|
|
1193
|
+
"description": "The assistant was not found."
|
|
1194
|
+
}
|
|
1195
|
+
},
|
|
1196
|
+
"parameters": [
|
|
1197
|
+
{
|
|
1198
|
+
"in": "path",
|
|
1199
|
+
"name": "assistantId",
|
|
1200
|
+
"schema": {
|
|
1201
|
+
"type": "string",
|
|
1202
|
+
"format": "uuid",
|
|
1203
|
+
"example": "507f191e810c19729de860ea"
|
|
1204
|
+
},
|
|
1205
|
+
"required": true,
|
|
1206
|
+
"description": "The ID of the assistant from which to retrieve threads."
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"in": "query",
|
|
1210
|
+
"name": "filter",
|
|
1211
|
+
"schema": {
|
|
1212
|
+
"type": "string"
|
|
1213
|
+
},
|
|
1214
|
+
"examples": {
|
|
1215
|
+
"favorite": {
|
|
1216
|
+
"value": "favorite eq \"true\""
|
|
1217
|
+
},
|
|
1218
|
+
"hasLikes": {
|
|
1219
|
+
"value": "summaryStats.likes gt \"0\""
|
|
1220
|
+
},
|
|
1221
|
+
"hasReview": {
|
|
1222
|
+
"value": "summaryStats.reviews gt \"0\""
|
|
1223
|
+
},
|
|
1224
|
+
"hasDislikes": {
|
|
1225
|
+
"value": "summaryStats.dislikes gt \"0\""
|
|
1226
|
+
},
|
|
1227
|
+
"hasFeedback": {
|
|
1228
|
+
"value": "hasFeedback eq \"true\""
|
|
1229
|
+
},
|
|
1230
|
+
"filterOwnerAndHideDeleted": {
|
|
1231
|
+
"value": "ownerId co \"669603a035eb5fedab45987f\" and not(deletedAt pr)"
|
|
1232
|
+
}
|
|
1233
|
+
},
|
|
1234
|
+
"description": "Optional parameter to filter threads."
|
|
1235
|
+
},
|
|
1236
|
+
{
|
|
1237
|
+
"in": "query",
|
|
1238
|
+
"name": "limit",
|
|
1239
|
+
"schema": {
|
|
1240
|
+
"type": "integer",
|
|
1241
|
+
"default": 20,
|
|
1242
|
+
"maximum": 100,
|
|
1243
|
+
"minimum": 1
|
|
1244
|
+
},
|
|
1245
|
+
"description": "The number of assistants to get."
|
|
1246
|
+
},
|
|
1247
|
+
{
|
|
1248
|
+
"in": "query",
|
|
1249
|
+
"name": "next",
|
|
1250
|
+
"schema": {
|
|
1251
|
+
"type": "string"
|
|
1252
|
+
},
|
|
1253
|
+
"description": "Optional parameter to request the next page."
|
|
1254
|
+
},
|
|
1255
|
+
{
|
|
1256
|
+
"in": "query",
|
|
1257
|
+
"name": "prev",
|
|
1258
|
+
"schema": {
|
|
1259
|
+
"type": "string"
|
|
1260
|
+
},
|
|
1261
|
+
"description": "Optional parameter to request the previous page."
|
|
1262
|
+
},
|
|
1263
|
+
{
|
|
1264
|
+
"in": "query",
|
|
1265
|
+
"name": "sort",
|
|
1266
|
+
"schema": {
|
|
1267
|
+
"enum": [
|
|
1268
|
+
"NAME",
|
|
1269
|
+
"-NAME",
|
|
1270
|
+
"CREATED",
|
|
1271
|
+
"-CREATED",
|
|
1272
|
+
"UPDATED",
|
|
1273
|
+
"-UPDATED"
|
|
1274
|
+
],
|
|
1275
|
+
"type": "string"
|
|
1276
|
+
},
|
|
1277
|
+
"description": "Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending."
|
|
1278
|
+
}
|
|
1279
|
+
],
|
|
1280
|
+
"description": "Retrieves the list of threads for the assistant.",
|
|
1281
|
+
"x-qlik-visibility": "public",
|
|
1282
|
+
"x-qlik-stability": "stable",
|
|
1283
|
+
"x-qlik-categories": [],
|
|
1284
|
+
"x-qlik-deprecated": false,
|
|
1285
|
+
"x-qlik-tier": {
|
|
1286
|
+
"tier": "1",
|
|
1287
|
+
"limit": 1000
|
|
1288
|
+
}
|
|
1289
|
+
},
|
|
1290
|
+
"post": {
|
|
1291
|
+
"tags": [
|
|
1292
|
+
"threads"
|
|
1293
|
+
],
|
|
1294
|
+
"summary": "Create a thread",
|
|
1295
|
+
"responses": {
|
|
1296
|
+
"201": {
|
|
1297
|
+
"content": {
|
|
1298
|
+
"application/json": {
|
|
1299
|
+
"schema": {
|
|
1300
|
+
"$ref": "#/components/schemas/Thread"
|
|
1301
|
+
}
|
|
1302
|
+
}
|
|
1303
|
+
},
|
|
1304
|
+
"headers": {
|
|
1305
|
+
"Etag": {
|
|
1306
|
+
"schema": {
|
|
1307
|
+
"type": "string"
|
|
1308
|
+
},
|
|
1309
|
+
"description": "Assistant thread version."
|
|
1310
|
+
},
|
|
1311
|
+
"Last-Modified": {
|
|
1312
|
+
"schema": {
|
|
1313
|
+
"type": "string"
|
|
1314
|
+
},
|
|
1315
|
+
"description": "Last modified date and time of the assistant thread."
|
|
1316
|
+
}
|
|
1317
|
+
},
|
|
1318
|
+
"description": "Successfully created a new assistant thread."
|
|
1319
|
+
},
|
|
1320
|
+
"400": {
|
|
1321
|
+
"content": {
|
|
1322
|
+
"application/json": {
|
|
1323
|
+
"schema": {
|
|
1324
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1325
|
+
"x-qlik-merge-conflict": true
|
|
1326
|
+
}
|
|
1327
|
+
}
|
|
1328
|
+
},
|
|
1329
|
+
"description": "The request is in incorrect format."
|
|
1330
|
+
},
|
|
1331
|
+
"403": {
|
|
1332
|
+
"content": {
|
|
1333
|
+
"application/json": {
|
|
1334
|
+
"schema": {
|
|
1335
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1336
|
+
"x-qlik-merge-conflict": true
|
|
1337
|
+
}
|
|
1338
|
+
}
|
|
1339
|
+
},
|
|
1340
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
1341
|
+
},
|
|
1342
|
+
"404": {
|
|
1343
|
+
"content": {
|
|
1344
|
+
"application/json": {
|
|
1345
|
+
"schema": {
|
|
1346
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1347
|
+
"x-qlik-merge-conflict": true
|
|
1348
|
+
}
|
|
1349
|
+
}
|
|
1350
|
+
},
|
|
1351
|
+
"description": "The assistant was not found."
|
|
1352
|
+
}
|
|
1353
|
+
},
|
|
1354
|
+
"parameters": [
|
|
1355
|
+
{
|
|
1356
|
+
"in": "path",
|
|
1357
|
+
"name": "assistantId",
|
|
1358
|
+
"schema": {
|
|
1359
|
+
"type": "string",
|
|
1360
|
+
"format": "uuid",
|
|
1361
|
+
"example": "507f191e810c19729de860ea"
|
|
1362
|
+
},
|
|
1363
|
+
"required": true,
|
|
1364
|
+
"description": "The ID of the assistant in which to create the thread."
|
|
1365
|
+
}
|
|
1366
|
+
],
|
|
1367
|
+
"description": "Creates a new thread for the assistant.",
|
|
1368
|
+
"requestBody": {
|
|
1369
|
+
"content": {
|
|
1370
|
+
"application/json": {
|
|
1371
|
+
"schema": {
|
|
1372
|
+
"$ref": "#/components/schemas/createThread"
|
|
1373
|
+
}
|
|
1374
|
+
}
|
|
1375
|
+
}
|
|
1376
|
+
},
|
|
1377
|
+
"x-qlik-visibility": "public",
|
|
1378
|
+
"x-qlik-stability": "stable",
|
|
1379
|
+
"x-qlik-categories": [],
|
|
1380
|
+
"x-qlik-deprecated": false,
|
|
1381
|
+
"x-qlik-tier": {
|
|
1382
|
+
"tier": "2",
|
|
1383
|
+
"limit": 100
|
|
1384
|
+
}
|
|
1385
|
+
}
|
|
1386
|
+
},
|
|
1387
|
+
"/api/v1/assistants/{assistantid}/threads/{threadid}": {
|
|
1388
|
+
"get": {
|
|
1389
|
+
"tags": [
|
|
1390
|
+
"threads"
|
|
1391
|
+
],
|
|
1392
|
+
"summary": "Get a thread",
|
|
1393
|
+
"responses": {
|
|
1394
|
+
"200": {
|
|
1395
|
+
"content": {
|
|
1396
|
+
"application/json": {
|
|
1397
|
+
"schema": {
|
|
1398
|
+
"$ref": "#/components/schemas/ThreadWithMessages"
|
|
1399
|
+
}
|
|
1400
|
+
}
|
|
1401
|
+
},
|
|
1402
|
+
"description": "Successfully retrieved the thread."
|
|
1403
|
+
},
|
|
1404
|
+
"400": {
|
|
1405
|
+
"content": {
|
|
1406
|
+
"application/json": {
|
|
1407
|
+
"schema": {
|
|
1408
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1409
|
+
"x-qlik-merge-conflict": true
|
|
1410
|
+
}
|
|
1411
|
+
}
|
|
1412
|
+
},
|
|
1413
|
+
"description": "The request is in incorrect format."
|
|
1414
|
+
},
|
|
1415
|
+
"403": {
|
|
1416
|
+
"content": {
|
|
1417
|
+
"application/json": {
|
|
1418
|
+
"schema": {
|
|
1419
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1420
|
+
"x-qlik-merge-conflict": true
|
|
1421
|
+
}
|
|
1422
|
+
}
|
|
1423
|
+
},
|
|
1424
|
+
"description": "The operation failed due to insufficient permissions."
|
|
1425
|
+
},
|
|
1426
|
+
"404": {
|
|
1427
|
+
"content": {
|
|
1428
|
+
"application/json": {
|
|
1429
|
+
"schema": {
|
|
1430
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1431
|
+
"x-qlik-merge-conflict": true
|
|
1432
|
+
}
|
|
1433
|
+
}
|
|
1434
|
+
},
|
|
1435
|
+
"description": "The thread was not found."
|
|
1436
|
+
}
|
|
1437
|
+
},
|
|
1438
|
+
"parameters": [
|
|
1439
|
+
{
|
|
1440
|
+
"in": "path",
|
|
1441
|
+
"name": "assistantid",
|
|
1442
|
+
"schema": {
|
|
1443
|
+
"type": "string",
|
|
1444
|
+
"format": "uuid",
|
|
1445
|
+
"example": "507f191e810c19729de860ea"
|
|
1446
|
+
},
|
|
1447
|
+
"required": true,
|
|
1448
|
+
"description": "The ID of the assistant containing the requested thread."
|
|
1449
|
+
},
|
|
1450
|
+
{
|
|
1451
|
+
"in": "path",
|
|
1452
|
+
"name": "threadid",
|
|
1453
|
+
"schema": {
|
|
1454
|
+
"type": "string",
|
|
1455
|
+
"format": "uuid",
|
|
1456
|
+
"example": "507f191e810c19729de860ea"
|
|
1457
|
+
},
|
|
1458
|
+
"required": true,
|
|
1459
|
+
"description": "The ID of the thread to retrieve."
|
|
1460
|
+
}
|
|
1461
|
+
],
|
|
1462
|
+
"description": "Retrieves a thread for the assistant.",
|
|
1463
|
+
"x-qlik-visibility": "public",
|
|
1464
|
+
"x-qlik-stability": "stable",
|
|
1465
|
+
"x-qlik-categories": [],
|
|
1466
|
+
"x-qlik-deprecated": false,
|
|
1467
|
+
"x-qlik-tier": {
|
|
1468
|
+
"tier": "1",
|
|
1469
|
+
"limit": 1000
|
|
1470
|
+
}
|
|
1471
|
+
},
|
|
1472
|
+
"patch": {
|
|
1473
|
+
"tags": [
|
|
1474
|
+
"threads"
|
|
1475
|
+
],
|
|
1476
|
+
"summary": "Update thread properties",
|
|
1477
|
+
"responses": {
|
|
1478
|
+
"204": {
|
|
1479
|
+
"description": "Thread updated successfully."
|
|
1480
|
+
},
|
|
1481
|
+
"400": {
|
|
1482
|
+
"content": {
|
|
1483
|
+
"application/json": {
|
|
1484
|
+
"schema": {
|
|
1485
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1486
|
+
"x-qlik-merge-conflict": true
|
|
1487
|
+
}
|
|
1488
|
+
}
|
|
1489
|
+
},
|
|
1490
|
+
"description": "Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid."
|
|
1491
|
+
},
|
|
1492
|
+
"401": {
|
|
1493
|
+
"content": {
|
|
1494
|
+
"application/json": {
|
|
1495
|
+
"schema": {
|
|
1496
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1497
|
+
"x-qlik-merge-conflict": true
|
|
1498
|
+
}
|
|
1499
|
+
}
|
|
1500
|
+
},
|
|
1501
|
+
"description": "Not authorized."
|
|
1502
|
+
},
|
|
1503
|
+
"403": {
|
|
1504
|
+
"content": {
|
|
1505
|
+
"application/json": {
|
|
1506
|
+
"schema": {
|
|
1507
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1508
|
+
"x-qlik-merge-conflict": true
|
|
1509
|
+
}
|
|
1510
|
+
}
|
|
1511
|
+
},
|
|
1512
|
+
"description": "The operation failed due to insufficient permissions."
|
|
1513
|
+
},
|
|
1514
|
+
"404": {
|
|
1515
|
+
"content": {
|
|
1516
|
+
"application/json": {
|
|
1517
|
+
"schema": {
|
|
1518
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1519
|
+
"x-qlik-merge-conflict": true
|
|
1520
|
+
}
|
|
1521
|
+
}
|
|
1522
|
+
},
|
|
1523
|
+
"description": "The term to patch was not found."
|
|
1524
|
+
},
|
|
1525
|
+
"429": {
|
|
1526
|
+
"content": {
|
|
1527
|
+
"application/json": {
|
|
1528
|
+
"schema": {
|
|
1529
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1530
|
+
"x-qlik-merge-conflict": true
|
|
1531
|
+
}
|
|
1532
|
+
}
|
|
1533
|
+
},
|
|
1534
|
+
"headers": {
|
|
1535
|
+
"retry-after": {
|
|
1536
|
+
"schema": {
|
|
1537
|
+
"type": "integer",
|
|
1538
|
+
"default": 1
|
|
1539
|
+
},
|
|
1540
|
+
"description": "The amount of seconds to wait before retrying the request."
|
|
1541
|
+
}
|
|
1542
|
+
},
|
|
1543
|
+
"description": "The request has been rate-limited."
|
|
1544
|
+
}
|
|
1545
|
+
},
|
|
1546
|
+
"parameters": [
|
|
1547
|
+
{
|
|
1548
|
+
"in": "path",
|
|
1549
|
+
"name": "assistantid",
|
|
1550
|
+
"schema": {
|
|
1551
|
+
"type": "string",
|
|
1552
|
+
"format": "uuid",
|
|
1553
|
+
"example": "507f191e810c19729de860ea"
|
|
1554
|
+
},
|
|
1555
|
+
"required": true,
|
|
1556
|
+
"description": "The ID of the assistant containing the requested thread."
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
"in": "path",
|
|
1560
|
+
"name": "threadid",
|
|
1561
|
+
"schema": {
|
|
1562
|
+
"type": "string",
|
|
1563
|
+
"format": "uuid",
|
|
1564
|
+
"example": "507f191e810c19729de860ea"
|
|
1565
|
+
},
|
|
1566
|
+
"required": true,
|
|
1567
|
+
"description": "The ID of the thread to retrieve."
|
|
1568
|
+
}
|
|
1569
|
+
],
|
|
1570
|
+
"description": "Updates the properties of an existing thread with JSON Patch-formatted data.",
|
|
1571
|
+
"requestBody": {
|
|
1572
|
+
"content": {
|
|
1573
|
+
"application/json": {
|
|
1574
|
+
"schema": {
|
|
1575
|
+
"$ref": "#/components/schemas/threadPatchArray"
|
|
1576
|
+
}
|
|
1577
|
+
}
|
|
1578
|
+
},
|
|
1579
|
+
"required": true
|
|
1580
|
+
},
|
|
1581
|
+
"x-qlik-visibility": "public",
|
|
1582
|
+
"x-qlik-stability": "stable",
|
|
1583
|
+
"x-qlik-categories": [],
|
|
1584
|
+
"x-qlik-deprecated": false,
|
|
1585
|
+
"x-qlik-tier": {
|
|
1586
|
+
"tier": "2",
|
|
1587
|
+
"limit": 100
|
|
1588
|
+
}
|
|
1589
|
+
},
|
|
1590
|
+
"delete": {
|
|
1591
|
+
"tags": [
|
|
1592
|
+
"threads"
|
|
1593
|
+
],
|
|
1594
|
+
"summary": "Delete a thread",
|
|
1595
|
+
"responses": {
|
|
1596
|
+
"204": {
|
|
1597
|
+
"description": "Successful operation."
|
|
1598
|
+
},
|
|
1599
|
+
"400": {
|
|
1600
|
+
"content": {
|
|
1601
|
+
"application/json": {
|
|
1602
|
+
"schema": {
|
|
1603
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1604
|
+
"x-qlik-merge-conflict": true
|
|
1605
|
+
}
|
|
1606
|
+
}
|
|
1607
|
+
},
|
|
1608
|
+
"description": "The request is in incorrect format."
|
|
1609
|
+
},
|
|
1610
|
+
"403": {
|
|
1611
|
+
"content": {
|
|
1612
|
+
"application/json": {
|
|
1613
|
+
"schema": {
|
|
1614
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1615
|
+
"x-qlik-merge-conflict": true
|
|
1616
|
+
}
|
|
1617
|
+
}
|
|
1618
|
+
},
|
|
1619
|
+
"description": "The operation failed due to insufficient permissions."
|
|
1620
|
+
},
|
|
1621
|
+
"404": {
|
|
1622
|
+
"content": {
|
|
1623
|
+
"application/json": {
|
|
1624
|
+
"schema": {
|
|
1625
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1626
|
+
"x-qlik-merge-conflict": true
|
|
1627
|
+
}
|
|
1628
|
+
}
|
|
1629
|
+
},
|
|
1630
|
+
"description": "The assistant was not found."
|
|
1631
|
+
}
|
|
1632
|
+
},
|
|
1633
|
+
"parameters": [
|
|
1634
|
+
{
|
|
1635
|
+
"in": "path",
|
|
1636
|
+
"name": "assistantid",
|
|
1637
|
+
"schema": {
|
|
1638
|
+
"type": "string",
|
|
1639
|
+
"format": "uuid",
|
|
1640
|
+
"example": "507f191e810c19729de860ea"
|
|
1641
|
+
},
|
|
1642
|
+
"required": true,
|
|
1643
|
+
"description": "The ID of the assistant containing the requested thread."
|
|
1644
|
+
},
|
|
1645
|
+
{
|
|
1646
|
+
"in": "path",
|
|
1647
|
+
"name": "threadid",
|
|
1648
|
+
"schema": {
|
|
1649
|
+
"type": "string",
|
|
1650
|
+
"format": "uuid",
|
|
1651
|
+
"example": "507f191e810c19729de860ea"
|
|
1652
|
+
},
|
|
1653
|
+
"required": true,
|
|
1654
|
+
"description": "The ID of the thread to retrieve."
|
|
1655
|
+
}
|
|
1656
|
+
],
|
|
1657
|
+
"description": "Deletes the specified thread and all of its resources.",
|
|
1658
|
+
"x-qlik-visibility": "public",
|
|
1659
|
+
"x-qlik-stability": "stable",
|
|
1660
|
+
"x-qlik-categories": [],
|
|
1661
|
+
"x-qlik-deprecated": false,
|
|
1662
|
+
"x-qlik-tier": {
|
|
1663
|
+
"tier": "2",
|
|
1664
|
+
"limit": 100
|
|
1665
|
+
}
|
|
1666
|
+
}
|
|
1667
|
+
},
|
|
1668
|
+
"/api/v1/assistants/{assistantId}/threads/{threadId}/actions/invoke": {
|
|
1669
|
+
"post": {
|
|
1670
|
+
"tags": [
|
|
1671
|
+
"chat"
|
|
1672
|
+
],
|
|
1673
|
+
"summary": "Execute synchronous prompt",
|
|
1674
|
+
"responses": {
|
|
1675
|
+
"200": {
|
|
1676
|
+
"content": {
|
|
1677
|
+
"application/json": {
|
|
1678
|
+
"schema": {
|
|
1679
|
+
"$ref": "#/components/schemas/promptOutputInvoke"
|
|
1680
|
+
}
|
|
1681
|
+
}
|
|
1682
|
+
},
|
|
1683
|
+
"headers": {
|
|
1684
|
+
"Etag": {
|
|
1685
|
+
"schema": {
|
|
1686
|
+
"type": "string"
|
|
1687
|
+
},
|
|
1688
|
+
"description": "Assistant version"
|
|
1689
|
+
},
|
|
1690
|
+
"Last-Modified": {
|
|
1691
|
+
"schema": {
|
|
1692
|
+
"type": "string"
|
|
1693
|
+
},
|
|
1694
|
+
"description": "Last modified date and time of the Assistant"
|
|
1695
|
+
}
|
|
1696
|
+
},
|
|
1697
|
+
"description": "Prompt is successfully executed."
|
|
1698
|
+
},
|
|
1699
|
+
"400": {
|
|
1700
|
+
"content": {
|
|
1701
|
+
"application/json": {
|
|
1702
|
+
"schema": {
|
|
1703
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
1704
|
+
}
|
|
1705
|
+
}
|
|
1706
|
+
},
|
|
1707
|
+
"description": "The request is in incorrect format"
|
|
1708
|
+
},
|
|
1709
|
+
"403": {
|
|
1710
|
+
"content": {
|
|
1711
|
+
"application/json": {
|
|
1712
|
+
"schema": {
|
|
1713
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
1714
|
+
}
|
|
1715
|
+
}
|
|
1716
|
+
},
|
|
1717
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
1718
|
+
},
|
|
1719
|
+
"404": {
|
|
1720
|
+
"content": {
|
|
1721
|
+
"application/json": {
|
|
1722
|
+
"schema": {
|
|
1723
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
1724
|
+
}
|
|
1725
|
+
}
|
|
1726
|
+
},
|
|
1727
|
+
"description": "Assistant is not found."
|
|
1728
|
+
},
|
|
1729
|
+
"500": {
|
|
1730
|
+
"content": {
|
|
1731
|
+
"application/json": {
|
|
1732
|
+
"schema": {
|
|
1733
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
1734
|
+
}
|
|
1735
|
+
}
|
|
1736
|
+
},
|
|
1737
|
+
"description": "Prompt processing error."
|
|
1738
|
+
}
|
|
1739
|
+
},
|
|
1740
|
+
"parameters": [
|
|
1741
|
+
{
|
|
1742
|
+
"in": "path",
|
|
1743
|
+
"name": "assistantId",
|
|
1744
|
+
"schema": {
|
|
1745
|
+
"type": "string",
|
|
1746
|
+
"format": "uuid",
|
|
1747
|
+
"example": "507f191e810c19729de860ea"
|
|
1748
|
+
},
|
|
1749
|
+
"required": true,
|
|
1750
|
+
"description": "The ID of the Assistant containing requested Thread"
|
|
1751
|
+
},
|
|
1752
|
+
{
|
|
1753
|
+
"in": "path",
|
|
1754
|
+
"name": "threadId",
|
|
1755
|
+
"schema": {
|
|
1756
|
+
"type": "string",
|
|
1757
|
+
"format": "uuid",
|
|
1758
|
+
"example": "507f191e810c19729de860ea"
|
|
1759
|
+
},
|
|
1760
|
+
"required": true,
|
|
1761
|
+
"description": "The ID of the Thread to retrieve"
|
|
1762
|
+
}
|
|
1763
|
+
],
|
|
1764
|
+
"description": "Execute prompt in synchronous non-streaming mode.",
|
|
1765
|
+
"requestBody": {
|
|
1766
|
+
"content": {
|
|
1767
|
+
"application/json": {
|
|
1768
|
+
"schema": {
|
|
1769
|
+
"$ref": "#/components/schemas/promptInput"
|
|
1770
|
+
}
|
|
1771
|
+
}
|
|
1772
|
+
}
|
|
1773
|
+
},
|
|
1774
|
+
"x-qlik-visibility": "public",
|
|
1775
|
+
"x-qlik-stability": "stable",
|
|
1776
|
+
"x-qlik-categories": [],
|
|
1777
|
+
"x-qlik-deprecated": false,
|
|
1778
|
+
"x-qlik-tier": {
|
|
1779
|
+
"tier": "2",
|
|
1780
|
+
"limit": 100
|
|
1781
|
+
}
|
|
1782
|
+
}
|
|
1783
|
+
},
|
|
1784
|
+
"/api/v1/assistants/{assistantId}/threads/{threadId}/actions/stream": {
|
|
1785
|
+
"post": {
|
|
1786
|
+
"tags": [
|
|
1787
|
+
"chat"
|
|
1788
|
+
],
|
|
1789
|
+
"summary": "Execute asynchronous prompt",
|
|
1790
|
+
"responses": {
|
|
1791
|
+
"200": {
|
|
1792
|
+
"content": {
|
|
1793
|
+
"application/json": {
|
|
1794
|
+
"schema": {
|
|
1795
|
+
"$ref": "#/components/schemas/promptOutput"
|
|
1796
|
+
}
|
|
1797
|
+
}
|
|
1798
|
+
},
|
|
1799
|
+
"headers": {
|
|
1800
|
+
"Etag": {
|
|
1801
|
+
"schema": {
|
|
1802
|
+
"type": "string"
|
|
1803
|
+
},
|
|
1804
|
+
"description": "Assistant version"
|
|
1805
|
+
},
|
|
1806
|
+
"Last-Modified": {
|
|
1807
|
+
"schema": {
|
|
1808
|
+
"type": "string"
|
|
1809
|
+
},
|
|
1810
|
+
"description": "Last modified date and time of the Assistant"
|
|
1811
|
+
}
|
|
1812
|
+
},
|
|
1813
|
+
"description": "Prompt is successfully executed."
|
|
1814
|
+
},
|
|
1815
|
+
"400": {
|
|
1816
|
+
"content": {
|
|
1817
|
+
"application/json": {
|
|
1818
|
+
"schema": {
|
|
1819
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
1820
|
+
}
|
|
1821
|
+
}
|
|
1822
|
+
},
|
|
1823
|
+
"description": "The request is in incorrect format"
|
|
1824
|
+
},
|
|
1825
|
+
"403": {
|
|
1826
|
+
"content": {
|
|
1827
|
+
"application/json": {
|
|
1828
|
+
"schema": {
|
|
1829
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
1830
|
+
}
|
|
1831
|
+
}
|
|
1832
|
+
},
|
|
1833
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
1834
|
+
},
|
|
1835
|
+
"404": {
|
|
1836
|
+
"content": {
|
|
1837
|
+
"application/json": {
|
|
1838
|
+
"schema": {
|
|
1839
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
1840
|
+
}
|
|
1841
|
+
}
|
|
1842
|
+
},
|
|
1843
|
+
"description": "Method is not allowed."
|
|
1844
|
+
},
|
|
1845
|
+
"405": {
|
|
1846
|
+
"content": {
|
|
1847
|
+
"application/json": {
|
|
1848
|
+
"schema": {
|
|
1849
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
1850
|
+
}
|
|
1851
|
+
}
|
|
1852
|
+
},
|
|
1853
|
+
"description": "Assistant is not found."
|
|
1854
|
+
},
|
|
1855
|
+
"500": {
|
|
1856
|
+
"content": {
|
|
1857
|
+
"application/json": {
|
|
1858
|
+
"schema": {
|
|
1859
|
+
"$ref": "#/components/schemas/errorResponse"
|
|
1860
|
+
}
|
|
1861
|
+
}
|
|
1862
|
+
},
|
|
1863
|
+
"description": "Prompt processing error."
|
|
1864
|
+
}
|
|
1865
|
+
},
|
|
1866
|
+
"parameters": [
|
|
1867
|
+
{
|
|
1868
|
+
"in": "path",
|
|
1869
|
+
"name": "assistantId",
|
|
1870
|
+
"schema": {
|
|
1871
|
+
"type": "string",
|
|
1872
|
+
"format": "uuid",
|
|
1873
|
+
"example": "507f191e810c19729de860ea"
|
|
1874
|
+
},
|
|
1875
|
+
"required": true,
|
|
1876
|
+
"description": "The ID of the Assistant containing requested Thread"
|
|
1877
|
+
},
|
|
1878
|
+
{
|
|
1879
|
+
"in": "path",
|
|
1880
|
+
"name": "threadId",
|
|
1881
|
+
"schema": {
|
|
1882
|
+
"type": "string",
|
|
1883
|
+
"format": "uuid",
|
|
1884
|
+
"example": "507f191e810c19729de860ea"
|
|
1885
|
+
},
|
|
1886
|
+
"required": true,
|
|
1887
|
+
"description": "The ID of the Thread to retrieve"
|
|
1888
|
+
}
|
|
1889
|
+
],
|
|
1890
|
+
"description": "Execute prompt in asynchronous streaming mode.",
|
|
1891
|
+
"requestBody": {
|
|
1892
|
+
"content": {
|
|
1893
|
+
"application/json": {
|
|
1894
|
+
"schema": {
|
|
1895
|
+
"$ref": "#/components/schemas/promptInput"
|
|
1896
|
+
}
|
|
1897
|
+
}
|
|
1898
|
+
}
|
|
1899
|
+
},
|
|
1900
|
+
"x-qlik-visibility": "public",
|
|
1901
|
+
"x-qlik-stability": "stable",
|
|
1902
|
+
"x-qlik-categories": [],
|
|
1903
|
+
"x-qlik-deprecated": false,
|
|
1904
|
+
"x-qlik-tier": {
|
|
1905
|
+
"tier": "2",
|
|
1906
|
+
"limit": 100
|
|
1907
|
+
}
|
|
1908
|
+
}
|
|
1909
|
+
},
|
|
1910
|
+
"/api/v1/assistants/{assistantId}/threads/{threadId}/interactions": {
|
|
1911
|
+
"get": {
|
|
1912
|
+
"tags": [
|
|
1913
|
+
"threads"
|
|
1914
|
+
],
|
|
1915
|
+
"summary": "List interactions",
|
|
1916
|
+
"responses": {
|
|
1917
|
+
"200": {
|
|
1918
|
+
"content": {
|
|
1919
|
+
"application/json": {
|
|
1920
|
+
"schema": {
|
|
1921
|
+
"$ref": "#/components/schemas/interactionsResult"
|
|
1922
|
+
}
|
|
1923
|
+
}
|
|
1924
|
+
},
|
|
1925
|
+
"description": "Successfully retrieved the thread interactions."
|
|
1926
|
+
},
|
|
1927
|
+
"400": {
|
|
1928
|
+
"content": {
|
|
1929
|
+
"application/json": {
|
|
1930
|
+
"schema": {
|
|
1931
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1932
|
+
"x-qlik-merge-conflict": true
|
|
1933
|
+
}
|
|
1934
|
+
}
|
|
1935
|
+
},
|
|
1936
|
+
"description": "The request is in incorrect format."
|
|
1937
|
+
},
|
|
1938
|
+
"403": {
|
|
1939
|
+
"content": {
|
|
1940
|
+
"application/json": {
|
|
1941
|
+
"schema": {
|
|
1942
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1943
|
+
"x-qlik-merge-conflict": true
|
|
1944
|
+
}
|
|
1945
|
+
}
|
|
1946
|
+
},
|
|
1947
|
+
"description": "The operation failed due to insufficient permissions."
|
|
1948
|
+
},
|
|
1949
|
+
"404": {
|
|
1950
|
+
"content": {
|
|
1951
|
+
"application/json": {
|
|
1952
|
+
"schema": {
|
|
1953
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
1954
|
+
"x-qlik-merge-conflict": true
|
|
1955
|
+
}
|
|
1956
|
+
}
|
|
1957
|
+
},
|
|
1958
|
+
"description": "The feedback was not found."
|
|
1959
|
+
}
|
|
1960
|
+
},
|
|
1961
|
+
"parameters": [
|
|
1962
|
+
{
|
|
1963
|
+
"in": "path",
|
|
1964
|
+
"name": "assistantId",
|
|
1965
|
+
"schema": {
|
|
1966
|
+
"type": "string",
|
|
1967
|
+
"format": "uuid",
|
|
1968
|
+
"example": "507f191e810c19729de860ea"
|
|
1969
|
+
},
|
|
1970
|
+
"required": true,
|
|
1971
|
+
"description": "The ID of the assistant from which to retrieve the interactions."
|
|
1972
|
+
},
|
|
1973
|
+
{
|
|
1974
|
+
"in": "path",
|
|
1975
|
+
"name": "threadId",
|
|
1976
|
+
"schema": {
|
|
1977
|
+
"type": "string",
|
|
1978
|
+
"format": "uuid",
|
|
1979
|
+
"example": "507f191e810c19729de860bb"
|
|
1980
|
+
},
|
|
1981
|
+
"required": true,
|
|
1982
|
+
"description": "The ID of the thread from which to retrieve the interactions."
|
|
1983
|
+
},
|
|
1984
|
+
{
|
|
1985
|
+
"in": "query",
|
|
1986
|
+
"name": "limit",
|
|
1987
|
+
"schema": {
|
|
1988
|
+
"type": "integer",
|
|
1989
|
+
"default": 20,
|
|
1990
|
+
"maximum": 100,
|
|
1991
|
+
"minimum": 1
|
|
1992
|
+
},
|
|
1993
|
+
"description": "The number of feedback to get."
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
"in": "query",
|
|
1997
|
+
"name": "next",
|
|
1998
|
+
"schema": {
|
|
1999
|
+
"type": "string"
|
|
2000
|
+
},
|
|
2001
|
+
"description": "Optional parameter to request the next page."
|
|
2002
|
+
},
|
|
2003
|
+
{
|
|
2004
|
+
"in": "query",
|
|
2005
|
+
"name": "prev",
|
|
2006
|
+
"schema": {
|
|
2007
|
+
"type": "string"
|
|
2008
|
+
},
|
|
2009
|
+
"description": "Optional parameter to request the previous page."
|
|
2010
|
+
},
|
|
2011
|
+
{
|
|
2012
|
+
"in": "query",
|
|
2013
|
+
"name": "sort",
|
|
2014
|
+
"schema": {
|
|
2015
|
+
"enum": [
|
|
2016
|
+
"CREATED",
|
|
2017
|
+
"-CREATED",
|
|
2018
|
+
"UPDATED",
|
|
2019
|
+
"-UPDATED"
|
|
2020
|
+
],
|
|
2021
|
+
"type": "string"
|
|
2022
|
+
},
|
|
2023
|
+
"description": "Optional resource field name to sort on, case insensitive, e.g. `created`. Can be prefixed with `-` to set descending order; defaults to ascending."
|
|
2024
|
+
}
|
|
2025
|
+
],
|
|
2026
|
+
"description": "Retrieves the list of interactions for the thread.",
|
|
2027
|
+
"x-qlik-visibility": "public",
|
|
2028
|
+
"x-qlik-stability": "stable",
|
|
2029
|
+
"x-qlik-categories": [],
|
|
2030
|
+
"x-qlik-deprecated": false,
|
|
2031
|
+
"x-qlik-tier": {
|
|
2032
|
+
"tier": "1",
|
|
2033
|
+
"limit": 1000
|
|
2034
|
+
}
|
|
2035
|
+
},
|
|
2036
|
+
"post": {
|
|
2037
|
+
"tags": [
|
|
2038
|
+
"threads"
|
|
2039
|
+
],
|
|
2040
|
+
"summary": "Create an interaction",
|
|
2041
|
+
"responses": {
|
|
2042
|
+
"201": {
|
|
2043
|
+
"content": {
|
|
2044
|
+
"application/json": {
|
|
2045
|
+
"schema": {
|
|
2046
|
+
"$ref": "#/components/schemas/Interaction"
|
|
2047
|
+
}
|
|
2048
|
+
}
|
|
2049
|
+
},
|
|
2050
|
+
"headers": {
|
|
2051
|
+
"Etag": {
|
|
2052
|
+
"schema": {
|
|
2053
|
+
"type": "string"
|
|
2054
|
+
},
|
|
2055
|
+
"description": "Thread feedback version."
|
|
2056
|
+
},
|
|
2057
|
+
"Last-Modified": {
|
|
2058
|
+
"schema": {
|
|
2059
|
+
"type": "string"
|
|
2060
|
+
},
|
|
2061
|
+
"description": "Last modified date and time of the thread interaction."
|
|
2062
|
+
}
|
|
2063
|
+
},
|
|
2064
|
+
"description": "Successfully created a new thread interaction."
|
|
2065
|
+
},
|
|
2066
|
+
"400": {
|
|
2067
|
+
"content": {
|
|
2068
|
+
"application/json": {
|
|
2069
|
+
"schema": {
|
|
2070
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2071
|
+
"x-qlik-merge-conflict": true
|
|
2072
|
+
}
|
|
2073
|
+
}
|
|
2074
|
+
},
|
|
2075
|
+
"description": "The request is in incorrect format."
|
|
2076
|
+
},
|
|
2077
|
+
"403": {
|
|
2078
|
+
"content": {
|
|
2079
|
+
"application/json": {
|
|
2080
|
+
"schema": {
|
|
2081
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2082
|
+
"x-qlik-merge-conflict": true
|
|
2083
|
+
}
|
|
2084
|
+
}
|
|
2085
|
+
},
|
|
2086
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
2087
|
+
},
|
|
2088
|
+
"404": {
|
|
2089
|
+
"content": {
|
|
2090
|
+
"application/json": {
|
|
2091
|
+
"schema": {
|
|
2092
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2093
|
+
"x-qlik-merge-conflict": true
|
|
2094
|
+
}
|
|
2095
|
+
}
|
|
2096
|
+
},
|
|
2097
|
+
"description": "The assistant or the thread was not found."
|
|
2098
|
+
}
|
|
2099
|
+
},
|
|
2100
|
+
"parameters": [
|
|
2101
|
+
{
|
|
2102
|
+
"in": "path",
|
|
2103
|
+
"name": "assistantId",
|
|
2104
|
+
"schema": {
|
|
2105
|
+
"type": "string",
|
|
2106
|
+
"format": "uuid",
|
|
2107
|
+
"example": "507f191e810c19729de860ea"
|
|
2108
|
+
},
|
|
2109
|
+
"required": true,
|
|
2110
|
+
"description": "The ID of the assistant in which to create the interaction."
|
|
2111
|
+
},
|
|
2112
|
+
{
|
|
2113
|
+
"in": "path",
|
|
2114
|
+
"name": "threadId",
|
|
2115
|
+
"schema": {
|
|
2116
|
+
"type": "string",
|
|
2117
|
+
"format": "uuid",
|
|
2118
|
+
"example": "507f191e810c19729de860ea"
|
|
2119
|
+
},
|
|
2120
|
+
"required": true,
|
|
2121
|
+
"description": "The ID of the thread in which to create the interaction."
|
|
2122
|
+
}
|
|
2123
|
+
],
|
|
2124
|
+
"description": "Creates a new interaction for the thread.",
|
|
2125
|
+
"requestBody": {
|
|
2126
|
+
"content": {
|
|
2127
|
+
"application/json": {
|
|
2128
|
+
"schema": {
|
|
2129
|
+
"$ref": "#/components/schemas/createInteraction"
|
|
2130
|
+
}
|
|
2131
|
+
}
|
|
2132
|
+
}
|
|
2133
|
+
},
|
|
2134
|
+
"x-qlik-visibility": "public",
|
|
2135
|
+
"x-qlik-stability": "stable",
|
|
2136
|
+
"x-qlik-categories": [],
|
|
2137
|
+
"x-qlik-deprecated": false,
|
|
2138
|
+
"x-qlik-tier": {
|
|
2139
|
+
"tier": "2",
|
|
2140
|
+
"limit": 100
|
|
2141
|
+
}
|
|
2142
|
+
}
|
|
2143
|
+
},
|
|
2144
|
+
"/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}": {
|
|
2145
|
+
"get": {
|
|
2146
|
+
"tags": [
|
|
2147
|
+
"threads"
|
|
2148
|
+
],
|
|
2149
|
+
"summary": "Get an interaction",
|
|
2150
|
+
"responses": {
|
|
2151
|
+
"200": {
|
|
2152
|
+
"content": {
|
|
2153
|
+
"application/json": {
|
|
2154
|
+
"schema": {
|
|
2155
|
+
"$ref": "#/components/schemas/Interaction"
|
|
2156
|
+
}
|
|
2157
|
+
}
|
|
2158
|
+
},
|
|
2159
|
+
"description": "Successfully retrieved the interaction."
|
|
2160
|
+
},
|
|
2161
|
+
"400": {
|
|
2162
|
+
"content": {
|
|
2163
|
+
"application/json": {
|
|
2164
|
+
"schema": {
|
|
2165
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2166
|
+
"x-qlik-merge-conflict": true
|
|
2167
|
+
}
|
|
2168
|
+
}
|
|
2169
|
+
},
|
|
2170
|
+
"description": "The request is in incorrect format."
|
|
2171
|
+
},
|
|
2172
|
+
"403": {
|
|
2173
|
+
"content": {
|
|
2174
|
+
"application/json": {
|
|
2175
|
+
"schema": {
|
|
2176
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2177
|
+
"x-qlik-merge-conflict": true
|
|
2178
|
+
}
|
|
2179
|
+
}
|
|
2180
|
+
},
|
|
2181
|
+
"description": "The operation failed due to insufficient permissions."
|
|
2182
|
+
},
|
|
2183
|
+
"404": {
|
|
2184
|
+
"content": {
|
|
2185
|
+
"application/json": {
|
|
2186
|
+
"schema": {
|
|
2187
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2188
|
+
"x-qlik-merge-conflict": true
|
|
2189
|
+
}
|
|
2190
|
+
}
|
|
2191
|
+
},
|
|
2192
|
+
"description": "The interaction was not found."
|
|
2193
|
+
}
|
|
2194
|
+
},
|
|
2195
|
+
"parameters": [
|
|
2196
|
+
{
|
|
2197
|
+
"in": "path",
|
|
2198
|
+
"name": "assistantId",
|
|
2199
|
+
"schema": {
|
|
2200
|
+
"type": "string",
|
|
2201
|
+
"format": "uuid",
|
|
2202
|
+
"example": "507f191e810c19729de860ea"
|
|
2203
|
+
},
|
|
2204
|
+
"required": true,
|
|
2205
|
+
"description": "The ID of the assistant in which to retrieve the interaction."
|
|
2206
|
+
},
|
|
2207
|
+
{
|
|
2208
|
+
"in": "path",
|
|
2209
|
+
"name": "interactionId",
|
|
2210
|
+
"schema": {
|
|
2211
|
+
"type": "string",
|
|
2212
|
+
"format": "uuid",
|
|
2213
|
+
"example": "507f191e810c19729de860ea"
|
|
2214
|
+
},
|
|
2215
|
+
"required": true,
|
|
2216
|
+
"description": "The ID of the interaction to retrieve."
|
|
2217
|
+
},
|
|
2218
|
+
{
|
|
2219
|
+
"in": "path",
|
|
2220
|
+
"name": "threadId",
|
|
2221
|
+
"schema": {
|
|
2222
|
+
"type": "string",
|
|
2223
|
+
"format": "uuid",
|
|
2224
|
+
"example": "507f191e810c19729de860ea"
|
|
2225
|
+
},
|
|
2226
|
+
"required": true,
|
|
2227
|
+
"description": "The ID of the thread in which to retrieve the interaction."
|
|
2228
|
+
}
|
|
2229
|
+
],
|
|
2230
|
+
"description": "Retrieves an interaction for the thread.",
|
|
2231
|
+
"x-qlik-visibility": "public",
|
|
2232
|
+
"x-qlik-stability": "stable",
|
|
2233
|
+
"x-qlik-categories": [],
|
|
2234
|
+
"x-qlik-deprecated": false,
|
|
2235
|
+
"x-qlik-tier": {
|
|
2236
|
+
"tier": "1",
|
|
2237
|
+
"limit": 1000
|
|
2238
|
+
}
|
|
2239
|
+
},
|
|
2240
|
+
"delete": {
|
|
2241
|
+
"tags": [
|
|
2242
|
+
"threads"
|
|
2243
|
+
],
|
|
2244
|
+
"summary": "Delete an interaction",
|
|
2245
|
+
"responses": {
|
|
2246
|
+
"204": {
|
|
2247
|
+
"description": "Successful operation."
|
|
2248
|
+
},
|
|
2249
|
+
"400": {
|
|
2250
|
+
"content": {
|
|
2251
|
+
"application/json": {
|
|
2252
|
+
"schema": {
|
|
2253
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2254
|
+
"x-qlik-merge-conflict": true
|
|
2255
|
+
}
|
|
2256
|
+
}
|
|
2257
|
+
},
|
|
2258
|
+
"description": "The request is in incorrect format."
|
|
2259
|
+
},
|
|
2260
|
+
"403": {
|
|
2261
|
+
"content": {
|
|
2262
|
+
"application/json": {
|
|
2263
|
+
"schema": {
|
|
2264
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2265
|
+
"x-qlik-merge-conflict": true
|
|
2266
|
+
}
|
|
2267
|
+
}
|
|
2268
|
+
},
|
|
2269
|
+
"description": "The operation failed due to insufficient permissions."
|
|
2270
|
+
},
|
|
2271
|
+
"404": {
|
|
2272
|
+
"content": {
|
|
2273
|
+
"application/json": {
|
|
2274
|
+
"schema": {
|
|
2275
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2276
|
+
"x-qlik-merge-conflict": true
|
|
2277
|
+
}
|
|
2278
|
+
}
|
|
2279
|
+
},
|
|
2280
|
+
"description": "The resource was not found."
|
|
2281
|
+
}
|
|
2282
|
+
},
|
|
2283
|
+
"parameters": [
|
|
2284
|
+
{
|
|
2285
|
+
"in": "path",
|
|
2286
|
+
"name": "assistantId",
|
|
2287
|
+
"schema": {
|
|
2288
|
+
"type": "string",
|
|
2289
|
+
"format": "uuid",
|
|
2290
|
+
"example": "507f191e810c19729de860ea"
|
|
2291
|
+
},
|
|
2292
|
+
"required": true,
|
|
2293
|
+
"description": "The ID of the assistant in which to delete the interaction."
|
|
2294
|
+
},
|
|
2295
|
+
{
|
|
2296
|
+
"in": "path",
|
|
2297
|
+
"name": "interactionId",
|
|
2298
|
+
"schema": {
|
|
2299
|
+
"type": "string",
|
|
2300
|
+
"format": "uuid",
|
|
2301
|
+
"example": "507f191e810c19729de860ea"
|
|
2302
|
+
},
|
|
2303
|
+
"required": true,
|
|
2304
|
+
"description": "The ID of the interaction to delete."
|
|
2305
|
+
},
|
|
2306
|
+
{
|
|
2307
|
+
"in": "path",
|
|
2308
|
+
"name": "threadId",
|
|
2309
|
+
"schema": {
|
|
2310
|
+
"type": "string",
|
|
2311
|
+
"format": "uuid",
|
|
2312
|
+
"example": "507f191e810c19729de860ea"
|
|
2313
|
+
},
|
|
2314
|
+
"required": true,
|
|
2315
|
+
"description": "The ID of the thread in which to delete the interaction."
|
|
2316
|
+
}
|
|
2317
|
+
],
|
|
2318
|
+
"description": "Deletes the specified interaction and all of its resources.",
|
|
2319
|
+
"x-qlik-visibility": "public",
|
|
2320
|
+
"x-qlik-stability": "stable",
|
|
2321
|
+
"x-qlik-categories": [],
|
|
2322
|
+
"x-qlik-deprecated": false,
|
|
2323
|
+
"x-qlik-tier": {
|
|
2324
|
+
"tier": "2",
|
|
2325
|
+
"limit": 100
|
|
2326
|
+
}
|
|
2327
|
+
}
|
|
2328
|
+
},
|
|
2329
|
+
"/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback": {
|
|
2330
|
+
"post": {
|
|
2331
|
+
"tags": [
|
|
2332
|
+
"threads"
|
|
2333
|
+
],
|
|
2334
|
+
"summary": "Create feedback",
|
|
2335
|
+
"responses": {
|
|
2336
|
+
"201": {
|
|
2337
|
+
"content": {
|
|
2338
|
+
"application/json": {
|
|
2339
|
+
"schema": {
|
|
2340
|
+
"$ref": "#/components/schemas/Interaction"
|
|
2341
|
+
}
|
|
2342
|
+
}
|
|
2343
|
+
},
|
|
2344
|
+
"headers": {
|
|
2345
|
+
"Etag": {
|
|
2346
|
+
"schema": {
|
|
2347
|
+
"type": "string"
|
|
2348
|
+
},
|
|
2349
|
+
"description": "Thread feedback version."
|
|
2350
|
+
},
|
|
2351
|
+
"Last-Modified": {
|
|
2352
|
+
"schema": {
|
|
2353
|
+
"type": "string"
|
|
2354
|
+
},
|
|
2355
|
+
"description": "Last modified date and time of the thread feedback."
|
|
2356
|
+
}
|
|
2357
|
+
},
|
|
2358
|
+
"description": "Successfully created a new thread feedback."
|
|
2359
|
+
},
|
|
2360
|
+
"400": {
|
|
2361
|
+
"content": {
|
|
2362
|
+
"application/json": {
|
|
2363
|
+
"schema": {
|
|
2364
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2365
|
+
"x-qlik-merge-conflict": true
|
|
2366
|
+
}
|
|
2367
|
+
}
|
|
2368
|
+
},
|
|
2369
|
+
"description": "The request is in incorrect format."
|
|
2370
|
+
},
|
|
2371
|
+
"403": {
|
|
2372
|
+
"content": {
|
|
2373
|
+
"application/json": {
|
|
2374
|
+
"schema": {
|
|
2375
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2376
|
+
"x-qlik-merge-conflict": true
|
|
2377
|
+
}
|
|
2378
|
+
}
|
|
2379
|
+
},
|
|
2380
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
2381
|
+
},
|
|
2382
|
+
"404": {
|
|
2383
|
+
"content": {
|
|
2384
|
+
"application/json": {
|
|
2385
|
+
"schema": {
|
|
2386
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2387
|
+
"x-qlik-merge-conflict": true
|
|
2388
|
+
}
|
|
2389
|
+
}
|
|
2390
|
+
},
|
|
2391
|
+
"description": "The resource was not found."
|
|
2392
|
+
}
|
|
2393
|
+
},
|
|
2394
|
+
"parameters": [
|
|
2395
|
+
{
|
|
2396
|
+
"in": "path",
|
|
2397
|
+
"name": "assistantId",
|
|
2398
|
+
"schema": {
|
|
2399
|
+
"type": "string",
|
|
2400
|
+
"format": "uuid",
|
|
2401
|
+
"example": "507f191e810c19729de860ea"
|
|
2402
|
+
},
|
|
2403
|
+
"required": true,
|
|
2404
|
+
"description": "The ID of the assistant in which to create the feedback."
|
|
2405
|
+
},
|
|
2406
|
+
{
|
|
2407
|
+
"in": "path",
|
|
2408
|
+
"name": "interactionId",
|
|
2409
|
+
"schema": {
|
|
2410
|
+
"type": "string",
|
|
2411
|
+
"format": "uuid",
|
|
2412
|
+
"example": "507f191e810c19729de860ea"
|
|
2413
|
+
},
|
|
2414
|
+
"required": true,
|
|
2415
|
+
"description": "The ID of the interaction in which to create the feedback."
|
|
2416
|
+
},
|
|
2417
|
+
{
|
|
2418
|
+
"in": "path",
|
|
2419
|
+
"name": "threadId",
|
|
2420
|
+
"schema": {
|
|
2421
|
+
"type": "string",
|
|
2422
|
+
"format": "uuid",
|
|
2423
|
+
"example": "507f191e810c19729de860ea"
|
|
2424
|
+
},
|
|
2425
|
+
"required": true,
|
|
2426
|
+
"description": "The ID of the thread in which to create the feedback."
|
|
2427
|
+
}
|
|
2428
|
+
],
|
|
2429
|
+
"description": "Creates feedback for the thread.",
|
|
2430
|
+
"requestBody": {
|
|
2431
|
+
"content": {
|
|
2432
|
+
"application/json": {
|
|
2433
|
+
"schema": {
|
|
2434
|
+
"$ref": "#/components/schemas/createFeedback"
|
|
2435
|
+
}
|
|
2436
|
+
}
|
|
2437
|
+
}
|
|
2438
|
+
},
|
|
2439
|
+
"x-qlik-visibility": "public",
|
|
2440
|
+
"x-qlik-stability": "stable",
|
|
2441
|
+
"x-qlik-categories": [],
|
|
2442
|
+
"x-qlik-deprecated": false,
|
|
2443
|
+
"x-qlik-tier": {
|
|
2444
|
+
"tier": "2",
|
|
2445
|
+
"limit": 100
|
|
2446
|
+
}
|
|
2447
|
+
}
|
|
2448
|
+
},
|
|
2449
|
+
"/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback/{feedbackId}": {
|
|
2450
|
+
"patch": {
|
|
2451
|
+
"tags": [
|
|
2452
|
+
"threads"
|
|
2453
|
+
],
|
|
2454
|
+
"summary": "Update feedback",
|
|
2455
|
+
"responses": {
|
|
2456
|
+
"204": {
|
|
2457
|
+
"headers": {
|
|
2458
|
+
"Etag": {
|
|
2459
|
+
"schema": {
|
|
2460
|
+
"type": "string"
|
|
2461
|
+
},
|
|
2462
|
+
"description": "Feedback version."
|
|
2463
|
+
},
|
|
2464
|
+
"Last-Modified": {
|
|
2465
|
+
"schema": {
|
|
2466
|
+
"type": "string"
|
|
2467
|
+
},
|
|
2468
|
+
"description": "Last modified date and time of the feedback."
|
|
2469
|
+
}
|
|
2470
|
+
},
|
|
2471
|
+
"description": "Successfully updated the feedback."
|
|
2472
|
+
},
|
|
2473
|
+
"400": {
|
|
2474
|
+
"content": {
|
|
2475
|
+
"application/json": {
|
|
2476
|
+
"schema": {
|
|
2477
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2478
|
+
"x-qlik-merge-conflict": true
|
|
2479
|
+
}
|
|
2480
|
+
}
|
|
2481
|
+
},
|
|
2482
|
+
"description": "The request is in incorrect format."
|
|
2483
|
+
},
|
|
2484
|
+
"403": {
|
|
2485
|
+
"content": {
|
|
2486
|
+
"application/json": {
|
|
2487
|
+
"schema": {
|
|
2488
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2489
|
+
"x-qlik-merge-conflict": true
|
|
2490
|
+
}
|
|
2491
|
+
}
|
|
2492
|
+
},
|
|
2493
|
+
"description": "The operation failed due to insufficient permissions."
|
|
2494
|
+
},
|
|
2495
|
+
"404": {
|
|
2496
|
+
"content": {
|
|
2497
|
+
"application/json": {
|
|
2498
|
+
"schema": {
|
|
2499
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2500
|
+
"x-qlik-merge-conflict": true
|
|
2501
|
+
}
|
|
2502
|
+
}
|
|
2503
|
+
},
|
|
2504
|
+
"description": "The resource was not found."
|
|
2505
|
+
}
|
|
2506
|
+
},
|
|
2507
|
+
"parameters": [
|
|
2508
|
+
{
|
|
2509
|
+
"in": "path",
|
|
2510
|
+
"name": "assistantId",
|
|
2511
|
+
"schema": {
|
|
2512
|
+
"type": "string",
|
|
2513
|
+
"format": "uuid",
|
|
2514
|
+
"example": "507f191e810c19729de860ea"
|
|
2515
|
+
},
|
|
2516
|
+
"required": true,
|
|
2517
|
+
"description": "The ID of the assistant containing the requested feedback."
|
|
2518
|
+
},
|
|
2519
|
+
{
|
|
2520
|
+
"in": "path",
|
|
2521
|
+
"name": "feedbackId",
|
|
2522
|
+
"schema": {
|
|
2523
|
+
"type": "string",
|
|
2524
|
+
"format": "uuid",
|
|
2525
|
+
"example": "507f191e810c19729de860ea"
|
|
2526
|
+
},
|
|
2527
|
+
"required": true,
|
|
2528
|
+
"description": "The ID of the feedback to update."
|
|
2529
|
+
},
|
|
2530
|
+
{
|
|
2531
|
+
"in": "path",
|
|
2532
|
+
"name": "interactionId",
|
|
2533
|
+
"schema": {
|
|
2534
|
+
"type": "string",
|
|
2535
|
+
"format": "uuid",
|
|
2536
|
+
"example": "507f191e810c19729de860ea"
|
|
2537
|
+
},
|
|
2538
|
+
"required": true,
|
|
2539
|
+
"description": "The ID of the interaction containing the requested Feedback."
|
|
2540
|
+
},
|
|
2541
|
+
{
|
|
2542
|
+
"in": "path",
|
|
2543
|
+
"name": "threadId",
|
|
2544
|
+
"schema": {
|
|
2545
|
+
"type": "string",
|
|
2546
|
+
"format": "uuid",
|
|
2547
|
+
"example": "507f191e810c19729de860ea"
|
|
2548
|
+
},
|
|
2549
|
+
"required": true,
|
|
2550
|
+
"description": "The ID of the thread containing the requested feedback."
|
|
2551
|
+
}
|
|
2552
|
+
],
|
|
2553
|
+
"description": "Updates feedback for the thread.",
|
|
2554
|
+
"requestBody": {
|
|
2555
|
+
"content": {
|
|
2556
|
+
"application/json": {
|
|
2557
|
+
"schema": {
|
|
2558
|
+
"$ref": "#/components/schemas/feedbackPatchArray"
|
|
2559
|
+
}
|
|
2560
|
+
}
|
|
2561
|
+
}
|
|
2562
|
+
},
|
|
2563
|
+
"x-qlik-visibility": "public",
|
|
2564
|
+
"x-qlik-stability": "stable",
|
|
2565
|
+
"x-qlik-categories": [],
|
|
2566
|
+
"x-qlik-deprecated": false,
|
|
2567
|
+
"x-qlik-tier": {
|
|
2568
|
+
"tier": "2",
|
|
2569
|
+
"limit": 100
|
|
2570
|
+
}
|
|
2571
|
+
}
|
|
2572
|
+
},
|
|
2573
|
+
"/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/reviews": {
|
|
2574
|
+
"post": {
|
|
2575
|
+
"tags": [
|
|
2576
|
+
"threads"
|
|
2577
|
+
],
|
|
2578
|
+
"summary": "Create feedback review",
|
|
2579
|
+
"responses": {
|
|
2580
|
+
"201": {
|
|
2581
|
+
"content": {
|
|
2582
|
+
"application/json": {
|
|
2583
|
+
"schema": {
|
|
2584
|
+
"$ref": "#/components/schemas/Interaction"
|
|
2585
|
+
}
|
|
2586
|
+
}
|
|
2587
|
+
},
|
|
2588
|
+
"headers": {
|
|
2589
|
+
"Etag": {
|
|
2590
|
+
"schema": {
|
|
2591
|
+
"type": "string"
|
|
2592
|
+
},
|
|
2593
|
+
"description": "Thread feedback version."
|
|
2594
|
+
},
|
|
2595
|
+
"Last-Modified": {
|
|
2596
|
+
"schema": {
|
|
2597
|
+
"type": "string"
|
|
2598
|
+
},
|
|
2599
|
+
"description": "Last modified date and time of the thread feedback."
|
|
2600
|
+
}
|
|
2601
|
+
},
|
|
2602
|
+
"description": "Successfully created a new thread feedback."
|
|
2603
|
+
},
|
|
2604
|
+
"400": {
|
|
2605
|
+
"content": {
|
|
2606
|
+
"application/json": {
|
|
2607
|
+
"schema": {
|
|
2608
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2609
|
+
"x-qlik-merge-conflict": true
|
|
2610
|
+
}
|
|
2611
|
+
}
|
|
2612
|
+
},
|
|
2613
|
+
"description": "The request is in incorrect format."
|
|
2614
|
+
},
|
|
2615
|
+
"403": {
|
|
2616
|
+
"content": {
|
|
2617
|
+
"application/json": {
|
|
2618
|
+
"schema": {
|
|
2619
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2620
|
+
"x-qlik-merge-conflict": true
|
|
2621
|
+
}
|
|
2622
|
+
}
|
|
2623
|
+
},
|
|
2624
|
+
"description": "The user does not have privileges to perform the requested action."
|
|
2625
|
+
},
|
|
2626
|
+
"404": {
|
|
2627
|
+
"content": {
|
|
2628
|
+
"application/json": {
|
|
2629
|
+
"schema": {
|
|
2630
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2631
|
+
"x-qlik-merge-conflict": true
|
|
2632
|
+
}
|
|
2633
|
+
}
|
|
2634
|
+
},
|
|
2635
|
+
"description": "A resource was not found."
|
|
2636
|
+
}
|
|
2637
|
+
},
|
|
2638
|
+
"parameters": [
|
|
2639
|
+
{
|
|
2640
|
+
"in": "path",
|
|
2641
|
+
"name": "assistantId",
|
|
2642
|
+
"schema": {
|
|
2643
|
+
"type": "string",
|
|
2644
|
+
"format": "uuid",
|
|
2645
|
+
"example": "507f191e810c19729de860ea"
|
|
2646
|
+
},
|
|
2647
|
+
"required": true,
|
|
2648
|
+
"description": "The ID of the assistant in which to create the feedback review."
|
|
2649
|
+
},
|
|
2650
|
+
{
|
|
2651
|
+
"in": "path",
|
|
2652
|
+
"name": "interactionId",
|
|
2653
|
+
"schema": {
|
|
2654
|
+
"type": "string",
|
|
2655
|
+
"format": "uuid",
|
|
2656
|
+
"example": "507f191e810c19729de860ea"
|
|
2657
|
+
},
|
|
2658
|
+
"required": true,
|
|
2659
|
+
"description": "The ID of the interaction in which to create the feedback review."
|
|
2660
|
+
},
|
|
2661
|
+
{
|
|
2662
|
+
"in": "path",
|
|
2663
|
+
"name": "threadId",
|
|
2664
|
+
"schema": {
|
|
2665
|
+
"type": "string",
|
|
2666
|
+
"format": "uuid",
|
|
2667
|
+
"example": "507f191e810c19729de860ea"
|
|
2668
|
+
},
|
|
2669
|
+
"required": true,
|
|
2670
|
+
"description": "The ID of the thread in which to create the feedback review."
|
|
2671
|
+
}
|
|
2672
|
+
],
|
|
2673
|
+
"description": "Creates feedback review for the thread.",
|
|
2674
|
+
"requestBody": {
|
|
2675
|
+
"content": {
|
|
2676
|
+
"application/json": {
|
|
2677
|
+
"schema": {
|
|
2678
|
+
"$ref": "#/components/schemas/createReview"
|
|
2679
|
+
}
|
|
2680
|
+
}
|
|
2681
|
+
}
|
|
2682
|
+
},
|
|
2683
|
+
"x-qlik-visibility": "public",
|
|
2684
|
+
"x-qlik-stability": "stable",
|
|
2685
|
+
"x-qlik-categories": [],
|
|
2686
|
+
"x-qlik-deprecated": false,
|
|
2687
|
+
"x-qlik-tier": {
|
|
2688
|
+
"tier": "2",
|
|
2689
|
+
"limit": 100
|
|
2690
|
+
}
|
|
2691
|
+
}
|
|
2692
|
+
},
|
|
2693
|
+
"/api/v1/assistants/{id}": {
|
|
2694
|
+
"get": {
|
|
2695
|
+
"tags": [
|
|
2696
|
+
"assistants"
|
|
2697
|
+
],
|
|
2698
|
+
"summary": "Get an assistant",
|
|
2699
|
+
"responses": {
|
|
2700
|
+
"200": {
|
|
2701
|
+
"content": {
|
|
2702
|
+
"application/json": {
|
|
2703
|
+
"schema": {
|
|
2704
|
+
"$ref": "#/components/schemas/Assistant"
|
|
2705
|
+
}
|
|
2706
|
+
}
|
|
2707
|
+
},
|
|
2708
|
+
"headers": {
|
|
2709
|
+
"Etag": {
|
|
2710
|
+
"schema": {
|
|
2711
|
+
"type": "string"
|
|
2712
|
+
},
|
|
2713
|
+
"description": "Assistant version."
|
|
2714
|
+
},
|
|
2715
|
+
"Last-Modified": {
|
|
2716
|
+
"schema": {
|
|
2717
|
+
"type": "string"
|
|
2718
|
+
},
|
|
2719
|
+
"description": "Last modified date and time of the assistant."
|
|
2720
|
+
}
|
|
2721
|
+
},
|
|
2722
|
+
"description": "Successfully retrieved the assistant."
|
|
2723
|
+
},
|
|
2724
|
+
"400": {
|
|
2725
|
+
"content": {
|
|
2726
|
+
"application/json": {
|
|
2727
|
+
"schema": {
|
|
2728
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2729
|
+
"x-qlik-merge-conflict": true
|
|
2730
|
+
}
|
|
2731
|
+
}
|
|
2732
|
+
},
|
|
2733
|
+
"description": "The request is in incorrect format."
|
|
2734
|
+
},
|
|
2735
|
+
"403": {
|
|
2736
|
+
"content": {
|
|
2737
|
+
"application/json": {
|
|
2738
|
+
"schema": {
|
|
2739
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2740
|
+
"x-qlik-merge-conflict": true
|
|
2741
|
+
}
|
|
2742
|
+
}
|
|
2743
|
+
},
|
|
2744
|
+
"description": "The operation failed due to insufficient permissions."
|
|
2745
|
+
},
|
|
2746
|
+
"404": {
|
|
2747
|
+
"content": {
|
|
2748
|
+
"application/json": {
|
|
2749
|
+
"schema": {
|
|
2750
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2751
|
+
"x-qlik-merge-conflict": true
|
|
2752
|
+
}
|
|
2753
|
+
}
|
|
2754
|
+
},
|
|
2755
|
+
"description": "The assistant was not found."
|
|
2756
|
+
}
|
|
2757
|
+
},
|
|
2758
|
+
"parameters": [
|
|
2759
|
+
{
|
|
2760
|
+
"in": "path",
|
|
2761
|
+
"name": "id",
|
|
2762
|
+
"schema": {
|
|
2763
|
+
"type": "string",
|
|
2764
|
+
"format": "uuid",
|
|
2765
|
+
"example": "507f191e810c19729de860ea"
|
|
2766
|
+
},
|
|
2767
|
+
"required": true,
|
|
2768
|
+
"description": "The ID of the assistant to retrieve."
|
|
2769
|
+
}
|
|
2770
|
+
],
|
|
2771
|
+
"description": "Retrieves the specified assistant.",
|
|
2772
|
+
"x-qlik-visibility": "public",
|
|
2773
|
+
"x-qlik-stability": "stable",
|
|
2774
|
+
"x-qlik-categories": [],
|
|
2775
|
+
"x-qlik-deprecated": false,
|
|
2776
|
+
"x-qlik-tier": {
|
|
2777
|
+
"tier": "1",
|
|
2778
|
+
"limit": 1000
|
|
2779
|
+
}
|
|
2780
|
+
},
|
|
2781
|
+
"patch": {
|
|
2782
|
+
"tags": [
|
|
2783
|
+
"assistants"
|
|
2784
|
+
],
|
|
2785
|
+
"summary": "Update assistant properties",
|
|
2786
|
+
"responses": {
|
|
2787
|
+
"204": {
|
|
2788
|
+
"headers": {
|
|
2789
|
+
"Etag": {
|
|
2790
|
+
"schema": {
|
|
2791
|
+
"type": "string"
|
|
2792
|
+
},
|
|
2793
|
+
"description": "Assistant version."
|
|
2794
|
+
},
|
|
2795
|
+
"Last-Modified": {
|
|
2796
|
+
"schema": {
|
|
2797
|
+
"type": "string"
|
|
2798
|
+
},
|
|
2799
|
+
"description": "Last modified date and time of the assistant."
|
|
2800
|
+
}
|
|
2801
|
+
},
|
|
2802
|
+
"description": "Assistant updated successfully."
|
|
2803
|
+
},
|
|
2804
|
+
"400": {
|
|
2805
|
+
"content": {
|
|
2806
|
+
"application/json": {
|
|
2807
|
+
"schema": {
|
|
2808
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2809
|
+
"x-qlik-merge-conflict": true
|
|
2810
|
+
}
|
|
2811
|
+
}
|
|
2812
|
+
},
|
|
2813
|
+
"description": "Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid."
|
|
2814
|
+
},
|
|
2815
|
+
"401": {
|
|
2816
|
+
"content": {
|
|
2817
|
+
"application/json": {
|
|
2818
|
+
"schema": {
|
|
2819
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2820
|
+
"x-qlik-merge-conflict": true
|
|
2821
|
+
}
|
|
2822
|
+
}
|
|
2823
|
+
},
|
|
2824
|
+
"description": "Not authorized."
|
|
2825
|
+
},
|
|
2826
|
+
"403": {
|
|
2827
|
+
"content": {
|
|
2828
|
+
"application/json": {
|
|
2829
|
+
"schema": {
|
|
2830
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2831
|
+
"x-qlik-merge-conflict": true
|
|
2832
|
+
}
|
|
2833
|
+
}
|
|
2834
|
+
},
|
|
2835
|
+
"description": "The operation failed due to insufficient permissions."
|
|
2836
|
+
},
|
|
2837
|
+
"404": {
|
|
2838
|
+
"content": {
|
|
2839
|
+
"application/json": {
|
|
2840
|
+
"schema": {
|
|
2841
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2842
|
+
"x-qlik-merge-conflict": true
|
|
2843
|
+
}
|
|
2844
|
+
}
|
|
2845
|
+
},
|
|
2846
|
+
"description": "The term to patch was not found."
|
|
2847
|
+
},
|
|
2848
|
+
"429": {
|
|
2849
|
+
"content": {
|
|
2850
|
+
"application/json": {
|
|
2851
|
+
"schema": {
|
|
2852
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2853
|
+
"x-qlik-merge-conflict": true
|
|
2854
|
+
}
|
|
2855
|
+
}
|
|
2856
|
+
},
|
|
2857
|
+
"headers": {
|
|
2858
|
+
"retry-after": {
|
|
2859
|
+
"schema": {
|
|
2860
|
+
"type": "integer",
|
|
2861
|
+
"default": 1
|
|
2862
|
+
},
|
|
2863
|
+
"description": "The amount of seconds to wait before retrying the request."
|
|
2864
|
+
}
|
|
2865
|
+
},
|
|
2866
|
+
"description": "The request has been rate-limited."
|
|
2867
|
+
}
|
|
2868
|
+
},
|
|
2869
|
+
"parameters": [
|
|
2870
|
+
{
|
|
2871
|
+
"in": "path",
|
|
2872
|
+
"name": "id",
|
|
2873
|
+
"schema": {
|
|
2874
|
+
"type": "string",
|
|
2875
|
+
"format": "uuid",
|
|
2876
|
+
"example": "507f191e810c19729de860ea"
|
|
2877
|
+
},
|
|
2878
|
+
"required": true,
|
|
2879
|
+
"description": "The assistant ID."
|
|
2880
|
+
},
|
|
2881
|
+
{
|
|
2882
|
+
"in": "header",
|
|
2883
|
+
"name": "if-match",
|
|
2884
|
+
"schema": {
|
|
2885
|
+
"type": "string",
|
|
2886
|
+
"example": "if-match: B323333"
|
|
2887
|
+
},
|
|
2888
|
+
"description": "Optional header to do conditional updates. Using the Etag value that was returned the last time the assistant was fetched."
|
|
2889
|
+
}
|
|
2890
|
+
],
|
|
2891
|
+
"description": "Updates the properties of an existing assistant with JSON Patch-formatted data.",
|
|
2892
|
+
"requestBody": {
|
|
2893
|
+
"content": {
|
|
2894
|
+
"application/json": {
|
|
2895
|
+
"schema": {
|
|
2896
|
+
"$ref": "#/components/schemas/JSONPatchArray"
|
|
2897
|
+
}
|
|
2898
|
+
}
|
|
2899
|
+
},
|
|
2900
|
+
"required": true
|
|
2901
|
+
},
|
|
2902
|
+
"x-qlik-visibility": "public",
|
|
2903
|
+
"x-qlik-stability": "stable",
|
|
2904
|
+
"x-qlik-categories": [],
|
|
2905
|
+
"x-qlik-deprecated": false,
|
|
2906
|
+
"x-qlik-tier": {
|
|
2907
|
+
"tier": "2",
|
|
2908
|
+
"limit": 100
|
|
2909
|
+
}
|
|
2910
|
+
},
|
|
2911
|
+
"delete": {
|
|
2912
|
+
"tags": [
|
|
2913
|
+
"assistants"
|
|
2914
|
+
],
|
|
2915
|
+
"summary": "Delete an assistant",
|
|
2916
|
+
"responses": {
|
|
2917
|
+
"204": {
|
|
2918
|
+
"description": "Successful operation."
|
|
2919
|
+
},
|
|
2920
|
+
"400": {
|
|
2921
|
+
"content": {
|
|
2922
|
+
"application/json": {
|
|
2923
|
+
"schema": {
|
|
2924
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2925
|
+
"x-qlik-merge-conflict": true
|
|
2926
|
+
}
|
|
2927
|
+
}
|
|
2928
|
+
},
|
|
2929
|
+
"description": "The request is in incorrect format."
|
|
2930
|
+
},
|
|
2931
|
+
"403": {
|
|
2932
|
+
"content": {
|
|
2933
|
+
"application/json": {
|
|
2934
|
+
"schema": {
|
|
2935
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2936
|
+
"x-qlik-merge-conflict": true
|
|
2937
|
+
}
|
|
2938
|
+
}
|
|
2939
|
+
},
|
|
2940
|
+
"description": "The operation failed due to insufficient permissions."
|
|
2941
|
+
},
|
|
2942
|
+
"404": {
|
|
2943
|
+
"content": {
|
|
2944
|
+
"application/json": {
|
|
2945
|
+
"schema": {
|
|
2946
|
+
"$ref": "#/components/schemas/errorResponseCopy",
|
|
2947
|
+
"x-qlik-merge-conflict": true
|
|
2948
|
+
}
|
|
2949
|
+
}
|
|
2950
|
+
},
|
|
2951
|
+
"description": "The assistant was not found."
|
|
2952
|
+
}
|
|
2953
|
+
},
|
|
2954
|
+
"parameters": [
|
|
2955
|
+
{
|
|
2956
|
+
"in": "path",
|
|
2957
|
+
"name": "id",
|
|
2958
|
+
"schema": {
|
|
2959
|
+
"type": "string",
|
|
2960
|
+
"format": "uuid",
|
|
2961
|
+
"example": "507f191e810c19729de860ea"
|
|
2962
|
+
},
|
|
2963
|
+
"required": true,
|
|
2964
|
+
"description": "The ID of the assistant to delete."
|
|
2965
|
+
}
|
|
2966
|
+
],
|
|
2967
|
+
"description": "Deletes the assistant and all of its resources.",
|
|
2968
|
+
"x-qlik-visibility": "public",
|
|
2969
|
+
"x-qlik-stability": "stable",
|
|
2970
|
+
"x-qlik-categories": [],
|
|
2971
|
+
"x-qlik-deprecated": false,
|
|
2972
|
+
"x-qlik-tier": {
|
|
2973
|
+
"tier": "2",
|
|
2974
|
+
"limit": 100
|
|
2975
|
+
}
|
|
2976
|
+
}
|
|
2977
|
+
}
|
|
2978
|
+
},
|
|
2979
|
+
"x-qlik-categories": [],
|
|
2980
|
+
"openapi": "3.0.0",
|
|
2981
|
+
"components": {
|
|
2982
|
+
"schemas": {
|
|
2983
|
+
"Assistant": {
|
|
2984
|
+
"type": "object",
|
|
2985
|
+
"required": [
|
|
2986
|
+
"id",
|
|
2987
|
+
"name",
|
|
2988
|
+
"description",
|
|
2989
|
+
"tags",
|
|
2990
|
+
"ownerId",
|
|
2991
|
+
"createdBy",
|
|
2992
|
+
"createdAt",
|
|
2993
|
+
"updatedBy",
|
|
2994
|
+
"updatedAt",
|
|
2995
|
+
"tenantId",
|
|
2996
|
+
"spaceId",
|
|
2997
|
+
"knowledgeBases",
|
|
2998
|
+
"welcomeMessage",
|
|
2999
|
+
"customProperties",
|
|
3000
|
+
"legacy"
|
|
3001
|
+
],
|
|
3002
|
+
"properties": {
|
|
3003
|
+
"id": {
|
|
3004
|
+
"type": "string",
|
|
3005
|
+
"format": "uuid",
|
|
3006
|
+
"example": "507f191e810c19729de860ea",
|
|
3007
|
+
"description": "Unique identifier of the assistant."
|
|
3008
|
+
},
|
|
3009
|
+
"name": {
|
|
3010
|
+
"type": "string",
|
|
3011
|
+
"example": "Organization-wide Assistant",
|
|
3012
|
+
"description": "The name of the assistant."
|
|
3013
|
+
},
|
|
3014
|
+
"tags": {
|
|
3015
|
+
"type": "array",
|
|
3016
|
+
"items": {
|
|
3017
|
+
"type": "string"
|
|
3018
|
+
},
|
|
3019
|
+
"example": [
|
|
3020
|
+
"Red",
|
|
3021
|
+
"Sales"
|
|
3022
|
+
],
|
|
3023
|
+
"description": "The list of tags associated with the assistant."
|
|
3024
|
+
},
|
|
3025
|
+
"title": {
|
|
3026
|
+
"type": "string",
|
|
3027
|
+
"example": "Assistant for Sales activities",
|
|
3028
|
+
"description": "The title of the assistant."
|
|
3029
|
+
},
|
|
3030
|
+
"ownerId": {
|
|
3031
|
+
"type": "string",
|
|
3032
|
+
"format": "uuid",
|
|
3033
|
+
"example": "507f191e810c19729de860ea",
|
|
3034
|
+
"description": "Unique identifier of the assistant owner."
|
|
3035
|
+
},
|
|
3036
|
+
"spaceId": {
|
|
3037
|
+
"type": "string",
|
|
3038
|
+
"format": "uuid",
|
|
3039
|
+
"example": "507f191e810c19729de860ea",
|
|
3040
|
+
"description": "Unique identifier of the space containing the assistant."
|
|
3041
|
+
},
|
|
3042
|
+
"tenantId": {
|
|
3043
|
+
"type": "string",
|
|
3044
|
+
"format": "uuid",
|
|
3045
|
+
"example": "507f191e810c19729de860ea",
|
|
3046
|
+
"description": "Unique identifier of the assistant tenant."
|
|
3047
|
+
},
|
|
3048
|
+
"createdAt": {
|
|
3049
|
+
"type": "string",
|
|
3050
|
+
"format": "date-time",
|
|
3051
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
3052
|
+
"readOnly": true,
|
|
3053
|
+
"description": "Datetime when the assistant was created."
|
|
3054
|
+
},
|
|
3055
|
+
"createdBy": {
|
|
3056
|
+
"type": "string",
|
|
3057
|
+
"format": "uuid",
|
|
3058
|
+
"example": "507f191e810c19729de860ea",
|
|
3059
|
+
"readOnly": true,
|
|
3060
|
+
"description": "Unique identifier of the user who created the assistant."
|
|
3061
|
+
},
|
|
3062
|
+
"hasAvatar": {
|
|
3063
|
+
"type": "boolean",
|
|
3064
|
+
"example": true,
|
|
3065
|
+
"description": "Indicates if the assistant has an avatar."
|
|
3066
|
+
},
|
|
3067
|
+
"updatedAt": {
|
|
3068
|
+
"type": "string",
|
|
3069
|
+
"format": "date-time",
|
|
3070
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
3071
|
+
"readOnly": true,
|
|
3072
|
+
"description": "Datetime when the assistant was updated."
|
|
3073
|
+
},
|
|
3074
|
+
"updatedBy": {
|
|
3075
|
+
"type": "string",
|
|
3076
|
+
"format": "uuid",
|
|
3077
|
+
"example": "507f191e810c19729de860ea",
|
|
3078
|
+
"readOnly": true,
|
|
3079
|
+
"description": "Unique identifier of the user who last updated the assistant."
|
|
3080
|
+
},
|
|
3081
|
+
"description": {
|
|
3082
|
+
"type": "string",
|
|
3083
|
+
"example": "This assistant is used for...",
|
|
3084
|
+
"description": "The description of the assistant."
|
|
3085
|
+
},
|
|
3086
|
+
"systemMessage": {
|
|
3087
|
+
"type": "string",
|
|
3088
|
+
"example": "You are helpful Sales assistant. Provide concise and actionable insights.",
|
|
3089
|
+
"description": "System prompt setting up conversation context.",
|
|
3090
|
+
"x-qlik-deprecated": true
|
|
3091
|
+
},
|
|
3092
|
+
"knowledgeBases": {
|
|
3093
|
+
"type": "array",
|
|
3094
|
+
"items": {
|
|
3095
|
+
"type": "string",
|
|
3096
|
+
"format": "uuid"
|
|
3097
|
+
},
|
|
3098
|
+
"example": [
|
|
3099
|
+
"507f191e810c19729de860ea"
|
|
3100
|
+
],
|
|
3101
|
+
"description": "List of knowledgebases the assistant is using."
|
|
3102
|
+
},
|
|
3103
|
+
"welcomeMessage": {
|
|
3104
|
+
"type": "string",
|
|
3105
|
+
"example": "Welcome to Sales process support Assistant.",
|
|
3106
|
+
"description": "Initial message in the chat conversation."
|
|
3107
|
+
},
|
|
3108
|
+
"customProperties": {
|
|
3109
|
+
"type": "object",
|
|
3110
|
+
"example": {
|
|
3111
|
+
"customErrors": {
|
|
3112
|
+
"outsideScopeError": "Outside of scope error",
|
|
3113
|
+
"complexQuestionError": "Complex question error",
|
|
3114
|
+
"promptInjectionError": "Prompt injection error"
|
|
3115
|
+
}
|
|
3116
|
+
},
|
|
3117
|
+
"description": "freeform JSON to allow custom customization options."
|
|
3118
|
+
},
|
|
3119
|
+
"defaultPromptType": {
|
|
3120
|
+
"enum": [
|
|
3121
|
+
"thread",
|
|
3122
|
+
"oneshot"
|
|
3123
|
+
],
|
|
3124
|
+
"type": "string",
|
|
3125
|
+
"example": "thread",
|
|
3126
|
+
"description": "Default prompt type for the assistant."
|
|
3127
|
+
},
|
|
3128
|
+
"orderedStarterIds": {
|
|
3129
|
+
"type": "array",
|
|
3130
|
+
"items": {
|
|
3131
|
+
"type": "string",
|
|
3132
|
+
"format": "uuid"
|
|
3133
|
+
},
|
|
3134
|
+
"example": [
|
|
3135
|
+
"507f191e810c19729de860ea",
|
|
3136
|
+
"787f191e810c19729de860er"
|
|
3137
|
+
],
|
|
3138
|
+
"description": "List of starter IDs in the order they will be sorted."
|
|
3139
|
+
}
|
|
3140
|
+
}
|
|
3141
|
+
},
|
|
3142
|
+
"assistantsResult": {
|
|
3143
|
+
"type": "object",
|
|
3144
|
+
"required": [
|
|
3145
|
+
"data"
|
|
3146
|
+
],
|
|
3147
|
+
"properties": {
|
|
3148
|
+
"data": {
|
|
3149
|
+
"type": "array",
|
|
3150
|
+
"items": {
|
|
3151
|
+
"$ref": "#/components/schemas/Assistant"
|
|
3152
|
+
}
|
|
3153
|
+
},
|
|
3154
|
+
"meta": {
|
|
3155
|
+
"$ref": "#/components/schemas/resultMeta"
|
|
3156
|
+
},
|
|
3157
|
+
"links": {
|
|
3158
|
+
"$ref": "#/components/schemas/pageLinks"
|
|
3159
|
+
}
|
|
3160
|
+
}
|
|
3161
|
+
},
|
|
3162
|
+
"chunk": {
|
|
3163
|
+
"type": "object",
|
|
3164
|
+
"required": [
|
|
3165
|
+
"text",
|
|
3166
|
+
"chunkMeta"
|
|
3167
|
+
],
|
|
3168
|
+
"properties": {
|
|
3169
|
+
"text": {
|
|
3170
|
+
"type": "string",
|
|
3171
|
+
"example": "LLM stands for Large Language Model",
|
|
3172
|
+
"description": "Text content of the chunk"
|
|
3173
|
+
},
|
|
3174
|
+
"chunkMeta": {
|
|
3175
|
+
"$ref": "#/components/schemas/kbChunkMeta"
|
|
3176
|
+
},
|
|
3177
|
+
"tfidfScore": {
|
|
3178
|
+
"type": "number",
|
|
3179
|
+
"example": 0.9,
|
|
3180
|
+
"description": "Score from keyword search"
|
|
3181
|
+
},
|
|
3182
|
+
"searchSource": {
|
|
3183
|
+
"type": "string",
|
|
3184
|
+
"description": "search method for the chunk, e.g. `semantic search`, `keyword search` or `semantic and keyword search`"
|
|
3185
|
+
},
|
|
3186
|
+
"semanticScore": {
|
|
3187
|
+
"type": "number",
|
|
3188
|
+
"example": 0.63,
|
|
3189
|
+
"description": "Similarity score from embedding match"
|
|
3190
|
+
}
|
|
3191
|
+
}
|
|
3192
|
+
},
|
|
3193
|
+
"ChunksRefs": {
|
|
3194
|
+
"type": "object",
|
|
3195
|
+
"example": {
|
|
3196
|
+
"chunkIds": [
|
|
3197
|
+
"c2ef42d9-7164-4fb0-bdbb-6534ae37263e",
|
|
3198
|
+
"486ada2c-f895-4961-8ba5-7995f1026d26"
|
|
3199
|
+
]
|
|
3200
|
+
},
|
|
3201
|
+
"required": [
|
|
3202
|
+
"chunkIds"
|
|
3203
|
+
],
|
|
3204
|
+
"properties": {
|
|
3205
|
+
"chunkIds": {
|
|
3206
|
+
"type": "array",
|
|
3207
|
+
"items": {
|
|
3208
|
+
"type": "string",
|
|
3209
|
+
"format": "uuid",
|
|
3210
|
+
"description": "Unique identifier of the Chunk."
|
|
3211
|
+
}
|
|
3212
|
+
}
|
|
3213
|
+
}
|
|
3214
|
+
},
|
|
3215
|
+
"createAssistant": {
|
|
3216
|
+
"type": "object",
|
|
3217
|
+
"required": [
|
|
3218
|
+
"name",
|
|
3219
|
+
"title",
|
|
3220
|
+
"description",
|
|
3221
|
+
"tags",
|
|
3222
|
+
"spaceId",
|
|
3223
|
+
"knowledgeBases",
|
|
3224
|
+
"welcomeMessage",
|
|
3225
|
+
"customProperties"
|
|
3226
|
+
],
|
|
3227
|
+
"properties": {
|
|
3228
|
+
"name": {
|
|
3229
|
+
"type": "string",
|
|
3230
|
+
"example": "Organization-wide assistant",
|
|
3231
|
+
"description": "The name of the assistant."
|
|
3232
|
+
},
|
|
3233
|
+
"tags": {
|
|
3234
|
+
"type": "array",
|
|
3235
|
+
"items": {
|
|
3236
|
+
"type": "string"
|
|
3237
|
+
},
|
|
3238
|
+
"example": [
|
|
3239
|
+
"Red",
|
|
3240
|
+
"Sales"
|
|
3241
|
+
],
|
|
3242
|
+
"description": "The list of tags for the assistant."
|
|
3243
|
+
},
|
|
3244
|
+
"title": {
|
|
3245
|
+
"type": "string",
|
|
3246
|
+
"example": "Assistant for Sales activities",
|
|
3247
|
+
"description": "The title of the assistant."
|
|
3248
|
+
},
|
|
3249
|
+
"spaceId": {
|
|
3250
|
+
"type": "string",
|
|
3251
|
+
"format": "uuid",
|
|
3252
|
+
"example": "507f191e810c19729de860ea",
|
|
3253
|
+
"description": "Unique identifier of the space to contain the assistant."
|
|
3254
|
+
},
|
|
3255
|
+
"description": {
|
|
3256
|
+
"type": "string",
|
|
3257
|
+
"example": "This assistant is used for...",
|
|
3258
|
+
"description": "The description of the assistant."
|
|
3259
|
+
},
|
|
3260
|
+
"systemMessage": {
|
|
3261
|
+
"type": "string",
|
|
3262
|
+
"example": "You are helpful Sales assistant. Provide concise and actionable insights.",
|
|
3263
|
+
"description": "System prompt setting up conversation context.",
|
|
3264
|
+
"x-qlik-deprecated": true
|
|
3265
|
+
},
|
|
3266
|
+
"knowledgeBases": {
|
|
3267
|
+
"type": "array",
|
|
3268
|
+
"items": {
|
|
3269
|
+
"type": "string",
|
|
3270
|
+
"format": "uuid"
|
|
3271
|
+
},
|
|
3272
|
+
"example": [
|
|
3273
|
+
"507f191e810c19729de860ea"
|
|
3274
|
+
],
|
|
3275
|
+
"description": "List of knowledgebases the assistant is using."
|
|
3276
|
+
},
|
|
3277
|
+
"welcomeMessage": {
|
|
3278
|
+
"type": "string",
|
|
3279
|
+
"example": "Welcome to Sales process support Assistant.",
|
|
3280
|
+
"description": "Initial message in the chat conversation."
|
|
3281
|
+
},
|
|
3282
|
+
"customProperties": {
|
|
3283
|
+
"type": "object",
|
|
3284
|
+
"example": {
|
|
3285
|
+
"customErrors": {
|
|
3286
|
+
"outsideScopeError": "Outside of scope error",
|
|
3287
|
+
"complexQuestionError": "Complex question error",
|
|
3288
|
+
"promptInjectionError": "Prompt injection error"
|
|
3289
|
+
}
|
|
3290
|
+
},
|
|
3291
|
+
"description": "freeform JSON to allow custom customization options."
|
|
3292
|
+
},
|
|
3293
|
+
"defaultPromptType": {
|
|
3294
|
+
"enum": [
|
|
3295
|
+
"thread",
|
|
3296
|
+
"oneshot"
|
|
3297
|
+
],
|
|
3298
|
+
"type": "string",
|
|
3299
|
+
"example": "thread",
|
|
3300
|
+
"description": "Default prompt type for the assistant."
|
|
3301
|
+
},
|
|
3302
|
+
"orderedStarterIds": {
|
|
3303
|
+
"type": "array",
|
|
3304
|
+
"items": {
|
|
3305
|
+
"type": "string",
|
|
3306
|
+
"format": "uuid"
|
|
3307
|
+
},
|
|
3308
|
+
"example": [
|
|
3309
|
+
"507f191e810c19729de860ea",
|
|
3310
|
+
"787f191e810c19729de860er"
|
|
3311
|
+
],
|
|
3312
|
+
"description": "List of starter IDs in the order they will be sorted."
|
|
3313
|
+
}
|
|
3314
|
+
}
|
|
3315
|
+
},
|
|
3316
|
+
"createAssistantWithAvatar": {
|
|
3317
|
+
"type": "object",
|
|
3318
|
+
"required": [
|
|
3319
|
+
"name",
|
|
3320
|
+
"title",
|
|
3321
|
+
"description",
|
|
3322
|
+
"tags",
|
|
3323
|
+
"spaceId",
|
|
3324
|
+
"knowledgeBases",
|
|
3325
|
+
"welcomeMessage",
|
|
3326
|
+
"customProperties"
|
|
3327
|
+
],
|
|
3328
|
+
"properties": {
|
|
3329
|
+
"name": {
|
|
3330
|
+
"type": "string",
|
|
3331
|
+
"example": "Organization-wide assistant",
|
|
3332
|
+
"description": "The name of the assistant."
|
|
3333
|
+
},
|
|
3334
|
+
"tags": {
|
|
3335
|
+
"type": "array",
|
|
3336
|
+
"items": {
|
|
3337
|
+
"type": "string"
|
|
3338
|
+
},
|
|
3339
|
+
"example": [
|
|
3340
|
+
"Red",
|
|
3341
|
+
"Sales"
|
|
3342
|
+
],
|
|
3343
|
+
"description": "The list of tags for the assistant."
|
|
3344
|
+
},
|
|
3345
|
+
"title": {
|
|
3346
|
+
"type": "string",
|
|
3347
|
+
"example": "Assistant for Sales activities",
|
|
3348
|
+
"description": "The title of the assistant."
|
|
3349
|
+
},
|
|
3350
|
+
"avatar": {
|
|
3351
|
+
"type": "string",
|
|
3352
|
+
"format": "file",
|
|
3353
|
+
"description": "user uploaded avatar, filetype must be png"
|
|
3354
|
+
},
|
|
3355
|
+
"spaceId": {
|
|
3356
|
+
"type": "string",
|
|
3357
|
+
"format": "uuid",
|
|
3358
|
+
"example": "507f191e810c19729de860ea",
|
|
3359
|
+
"description": "Unique identifier of the space to contain the assistant."
|
|
3360
|
+
},
|
|
3361
|
+
"description": {
|
|
3362
|
+
"type": "string",
|
|
3363
|
+
"example": "This assistant is used for...",
|
|
3364
|
+
"description": "The description of the assistant."
|
|
3365
|
+
},
|
|
3366
|
+
"systemMessage": {
|
|
3367
|
+
"type": "string",
|
|
3368
|
+
"example": "You are helpful Sales assistant. Provide concise and actionable insights.",
|
|
3369
|
+
"description": "System prompt setting up conversation context.",
|
|
3370
|
+
"x-qlik-deprecated": true
|
|
3371
|
+
},
|
|
3372
|
+
"knowledgeBases": {
|
|
3373
|
+
"type": "array",
|
|
3374
|
+
"items": {
|
|
3375
|
+
"type": "string",
|
|
3376
|
+
"format": "uuid"
|
|
3377
|
+
},
|
|
3378
|
+
"example": [
|
|
3379
|
+
"507f191e810c19729de860ea"
|
|
3380
|
+
],
|
|
3381
|
+
"description": "List of knowledgebases the assistant is using."
|
|
3382
|
+
},
|
|
3383
|
+
"welcomeMessage": {
|
|
3384
|
+
"type": "string",
|
|
3385
|
+
"example": "Welcome to Sales process support Assistant.",
|
|
3386
|
+
"description": "Initial message in the chat conversation."
|
|
3387
|
+
},
|
|
3388
|
+
"customProperties": {
|
|
3389
|
+
"type": "object",
|
|
3390
|
+
"example": {
|
|
3391
|
+
"customErrors": {
|
|
3392
|
+
"outsideScopeError": "Outside of scope error",
|
|
3393
|
+
"complexQuestionError": "Complex question error",
|
|
3394
|
+
"promptInjectionError": "Prompt injection error"
|
|
3395
|
+
}
|
|
3396
|
+
},
|
|
3397
|
+
"description": "freeform JSON to allow custom customization options."
|
|
3398
|
+
},
|
|
3399
|
+
"defaultPromptType": {
|
|
3400
|
+
"enum": [
|
|
3401
|
+
"thread",
|
|
3402
|
+
"oneshot"
|
|
3403
|
+
],
|
|
3404
|
+
"type": "string",
|
|
3405
|
+
"example": "thread",
|
|
3406
|
+
"description": "Default prompt type for the assistant."
|
|
3407
|
+
}
|
|
3408
|
+
}
|
|
3409
|
+
},
|
|
3410
|
+
"createFeedback": {
|
|
3411
|
+
"type": "object",
|
|
3412
|
+
"required": [
|
|
3413
|
+
"vote",
|
|
3414
|
+
"reason"
|
|
3415
|
+
],
|
|
3416
|
+
"properties": {
|
|
3417
|
+
"vote": {
|
|
3418
|
+
"type": "integer",
|
|
3419
|
+
"example": 1,
|
|
3420
|
+
"description": "Integer representation of feedback given (-1 = negative, 1 = positive)."
|
|
3421
|
+
},
|
|
3422
|
+
"reason": {
|
|
3423
|
+
"type": "string",
|
|
3424
|
+
"example": "inaccurate | irrelevant | repetitive | unhelpful | other",
|
|
3425
|
+
"description": "Reason for feedback."
|
|
3426
|
+
},
|
|
3427
|
+
"comment": {
|
|
3428
|
+
"type": "string",
|
|
3429
|
+
"description": "Optional comment for feedback."
|
|
3430
|
+
}
|
|
3431
|
+
}
|
|
3432
|
+
},
|
|
3433
|
+
"createInteraction": {
|
|
3434
|
+
"type": "object",
|
|
3435
|
+
"required": [
|
|
3436
|
+
"request",
|
|
3437
|
+
"response",
|
|
3438
|
+
"sources"
|
|
3439
|
+
],
|
|
3440
|
+
"properties": {
|
|
3441
|
+
"request": {
|
|
3442
|
+
"type": "string",
|
|
3443
|
+
"example": "Where was Genghis Khan buried?",
|
|
3444
|
+
"description": "Interaction request content."
|
|
3445
|
+
},
|
|
3446
|
+
"sources": {
|
|
3447
|
+
"type": "array",
|
|
3448
|
+
"items": {
|
|
3449
|
+
"$ref": "#/components/schemas/MessageSource"
|
|
3450
|
+
},
|
|
3451
|
+
"description": "List of sources used to generate AI messages (interactions)."
|
|
3452
|
+
},
|
|
3453
|
+
"rejected": {
|
|
3454
|
+
"type": "boolean",
|
|
3455
|
+
"example": true,
|
|
3456
|
+
"description": "Indicator the system marked request as suspicious."
|
|
3457
|
+
},
|
|
3458
|
+
"response": {
|
|
3459
|
+
"type": "string",
|
|
3460
|
+
"example": "Somewhere in an unmarked grave",
|
|
3461
|
+
"description": "Interaction response content."
|
|
3462
|
+
},
|
|
3463
|
+
"rejectionReason": {
|
|
3464
|
+
"$ref": "#/components/schemas/rejectionReason"
|
|
3465
|
+
}
|
|
3466
|
+
}
|
|
3467
|
+
},
|
|
3468
|
+
"createReview": {
|
|
3469
|
+
"type": "object",
|
|
3470
|
+
"required": [
|
|
3471
|
+
"reviewStatus"
|
|
3472
|
+
],
|
|
3473
|
+
"properties": {
|
|
3474
|
+
"reviewStatus": {
|
|
3475
|
+
"type": "string",
|
|
3476
|
+
"example": "reviewed | unreviewed",
|
|
3477
|
+
"description": "Review status."
|
|
3478
|
+
}
|
|
3479
|
+
}
|
|
3480
|
+
},
|
|
3481
|
+
"createStarter": {
|
|
3482
|
+
"type": "object",
|
|
3483
|
+
"required": [
|
|
3484
|
+
"question"
|
|
3485
|
+
],
|
|
3486
|
+
"properties": {
|
|
3487
|
+
"question": {
|
|
3488
|
+
"type": "string",
|
|
3489
|
+
"example": "Where was Genghis Khan buried?",
|
|
3490
|
+
"description": "Starter sample question."
|
|
3491
|
+
},
|
|
3492
|
+
"followups": {
|
|
3493
|
+
"type": "array",
|
|
3494
|
+
"items": {
|
|
3495
|
+
"$ref": "#/components/schemas/followup"
|
|
3496
|
+
},
|
|
3497
|
+
"maxItems": 5,
|
|
3498
|
+
"description": "List of followups."
|
|
3499
|
+
},
|
|
3500
|
+
"additionalContext": {
|
|
3501
|
+
"type": "string",
|
|
3502
|
+
"description": "Optional context collected from curated meant to be leveraged by LLM-based question recommendation system."
|
|
3503
|
+
},
|
|
3504
|
+
"recommendedAnswer": {
|
|
3505
|
+
"$ref": "#/components/schemas/recommendedAnswer"
|
|
3506
|
+
}
|
|
3507
|
+
}
|
|
3508
|
+
},
|
|
3509
|
+
"createThread": {
|
|
3510
|
+
"type": "object",
|
|
3511
|
+
"required": [
|
|
3512
|
+
"name"
|
|
3513
|
+
],
|
|
3514
|
+
"properties": {
|
|
3515
|
+
"name": {
|
|
3516
|
+
"type": "string",
|
|
3517
|
+
"example": "Initial conversation",
|
|
3518
|
+
"description": "The name of the thread."
|
|
3519
|
+
},
|
|
3520
|
+
"createdAt": {
|
|
3521
|
+
"type": "string",
|
|
3522
|
+
"format": "date-time",
|
|
3523
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
3524
|
+
"readOnly": true,
|
|
3525
|
+
"description": "Datetime when the thread was created."
|
|
3526
|
+
},
|
|
3527
|
+
"updatedAt": {
|
|
3528
|
+
"type": "string",
|
|
3529
|
+
"format": "date-time",
|
|
3530
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
3531
|
+
"readOnly": true,
|
|
3532
|
+
"description": "Datetime when the thread was updated."
|
|
3533
|
+
}
|
|
3534
|
+
}
|
|
3535
|
+
},
|
|
3536
|
+
"errorResponse": {
|
|
3537
|
+
"type": "object",
|
|
3538
|
+
"properties": {
|
|
3539
|
+
"errors": {
|
|
3540
|
+
"type": "array",
|
|
3541
|
+
"items": {
|
|
3542
|
+
"$ref": "#/components/schemas/errorResponseCode"
|
|
3543
|
+
}
|
|
3544
|
+
},
|
|
3545
|
+
"traceId": {
|
|
3546
|
+
"type": "string",
|
|
3547
|
+
"example": "507f191e810c19729de860ea"
|
|
3548
|
+
}
|
|
3549
|
+
}
|
|
3550
|
+
},
|
|
3551
|
+
"errorResponseCode": {
|
|
3552
|
+
"type": "object",
|
|
3553
|
+
"properties": {
|
|
3554
|
+
"code": {
|
|
3555
|
+
"type": "string",
|
|
3556
|
+
"description": "Custom error codes\n* AE-1 - Internal processing error\n* AE-2 - Incorrect request\n* AE-3 - Authentication issue\n* AE-4 - Prompt is rejected\n* AE-5 - Resource is not found\n* AE-6 - API usage rate limit is exceeded\n* AE-7 - Method is not allowed\n"
|
|
3557
|
+
},
|
|
3558
|
+
"title": {
|
|
3559
|
+
"type": "string"
|
|
3560
|
+
},
|
|
3561
|
+
"detail": {
|
|
3562
|
+
"type": "string"
|
|
3563
|
+
}
|
|
3564
|
+
}
|
|
3565
|
+
},
|
|
3566
|
+
"errorResponseCodeCopy": {
|
|
3567
|
+
"type": "object",
|
|
3568
|
+
"properties": {
|
|
3569
|
+
"code": {
|
|
3570
|
+
"type": "string"
|
|
3571
|
+
},
|
|
3572
|
+
"title": {
|
|
3573
|
+
"type": "string"
|
|
3574
|
+
},
|
|
3575
|
+
"detail": {
|
|
3576
|
+
"type": "string"
|
|
3577
|
+
}
|
|
3578
|
+
}
|
|
3579
|
+
},
|
|
3580
|
+
"errorResponseCopy": {
|
|
3581
|
+
"type": "object",
|
|
3582
|
+
"properties": {
|
|
3583
|
+
"errors": {
|
|
3584
|
+
"type": "array",
|
|
3585
|
+
"items": {
|
|
3586
|
+
"$ref": "#/components/schemas/errorResponseCodeCopy",
|
|
3587
|
+
"x-qlik-merge-conflict": true
|
|
3588
|
+
}
|
|
3589
|
+
},
|
|
3590
|
+
"traceId": {
|
|
3591
|
+
"type": "string",
|
|
3592
|
+
"example": "507f191e810c19729de860ea"
|
|
3593
|
+
}
|
|
3594
|
+
}
|
|
3595
|
+
},
|
|
3596
|
+
"Feedback": {
|
|
3597
|
+
"type": "object",
|
|
3598
|
+
"required": [
|
|
3599
|
+
"id",
|
|
3600
|
+
"vote",
|
|
3601
|
+
"createdAt",
|
|
3602
|
+
"sources",
|
|
3603
|
+
"reviewStatus",
|
|
3604
|
+
"reason",
|
|
3605
|
+
"reviewerId",
|
|
3606
|
+
"comment"
|
|
3607
|
+
],
|
|
3608
|
+
"properties": {
|
|
3609
|
+
"id": {
|
|
3610
|
+
"type": "string",
|
|
3611
|
+
"format": "uuid",
|
|
3612
|
+
"example": "507f191e810c19729de860ea",
|
|
3613
|
+
"description": "Unique feedback identifier."
|
|
3614
|
+
},
|
|
3615
|
+
"vote": {
|
|
3616
|
+
"type": "integer",
|
|
3617
|
+
"example": 1,
|
|
3618
|
+
"description": "Integer representation of feedback given (-1 = negative, 1 = positive)."
|
|
3619
|
+
},
|
|
3620
|
+
"reason": {
|
|
3621
|
+
"type": "string",
|
|
3622
|
+
"example": "inaccurate | irrelevant | repetitive | unhelpful | other",
|
|
3623
|
+
"description": "Reason for feedback."
|
|
3624
|
+
},
|
|
3625
|
+
"comment": {
|
|
3626
|
+
"type": "string",
|
|
3627
|
+
"description": "Optional comment for feedback."
|
|
3628
|
+
},
|
|
3629
|
+
"reviewedAt": {
|
|
3630
|
+
"type": "string",
|
|
3631
|
+
"format": "date-time",
|
|
3632
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
3633
|
+
"description": "Datetime when the feedback was reviewed."
|
|
3634
|
+
},
|
|
3635
|
+
"reviewerId": {
|
|
3636
|
+
"type": "string",
|
|
3637
|
+
"format": "uuid",
|
|
3638
|
+
"example": "507f191e810c19729de860ea",
|
|
3639
|
+
"description": "Unique feedback reviewer identifier."
|
|
3640
|
+
},
|
|
3641
|
+
"reviewStatus": {
|
|
3642
|
+
"type": "string",
|
|
3643
|
+
"example": "reviewed | unreviewed",
|
|
3644
|
+
"description": "Feedback review status."
|
|
3645
|
+
}
|
|
3646
|
+
}
|
|
3647
|
+
},
|
|
3648
|
+
"feedbackPatchArray": {
|
|
3649
|
+
"type": "array",
|
|
3650
|
+
"items": {
|
|
3651
|
+
"$ref": "#/components/schemas/JSONPatch"
|
|
3652
|
+
},
|
|
3653
|
+
"example": [
|
|
3654
|
+
{
|
|
3655
|
+
"op": "replace",
|
|
3656
|
+
"path": "/reason",
|
|
3657
|
+
"value": "irrelevant"
|
|
3658
|
+
}
|
|
3659
|
+
],
|
|
3660
|
+
"description": "An array of JSON Patch documents."
|
|
3661
|
+
},
|
|
3662
|
+
"feedbackSummary": {
|
|
3663
|
+
"type": "object",
|
|
3664
|
+
"required": [
|
|
3665
|
+
"likes",
|
|
3666
|
+
"dislikes",
|
|
3667
|
+
"interactions",
|
|
3668
|
+
"reviews"
|
|
3669
|
+
],
|
|
3670
|
+
"properties": {
|
|
3671
|
+
"likes": {
|
|
3672
|
+
"type": "integer",
|
|
3673
|
+
"description": "Amount of likes for a thread or an assistant."
|
|
3674
|
+
},
|
|
3675
|
+
"other": {
|
|
3676
|
+
"type": "integer",
|
|
3677
|
+
"description": "Count of answers which users disliked and gave \"other\" as reason."
|
|
3678
|
+
},
|
|
3679
|
+
"reviews": {
|
|
3680
|
+
"type": "integer",
|
|
3681
|
+
"description": "Amount of reviews for a thread or an assistant."
|
|
3682
|
+
},
|
|
3683
|
+
"dislikes": {
|
|
3684
|
+
"type": "integer",
|
|
3685
|
+
"description": "Amount of dislikes for a thread or an assistant."
|
|
3686
|
+
},
|
|
3687
|
+
"unhelpful": {
|
|
3688
|
+
"type": "integer",
|
|
3689
|
+
"description": "Count of answers which users marked as \"unhelpful\"."
|
|
3690
|
+
},
|
|
3691
|
+
"inaccurate": {
|
|
3692
|
+
"type": "integer",
|
|
3693
|
+
"description": "Count of answers which users marked as \"inaccurate\"."
|
|
3694
|
+
},
|
|
3695
|
+
"irrelevant": {
|
|
3696
|
+
"type": "integer",
|
|
3697
|
+
"description": "Count of answers which users marked as \"irrelevant\"."
|
|
3698
|
+
},
|
|
3699
|
+
"repetitive": {
|
|
3700
|
+
"type": "integer",
|
|
3701
|
+
"description": "Count of answers which users marked as \"repetitive\"."
|
|
3702
|
+
},
|
|
3703
|
+
"unanswered": {
|
|
3704
|
+
"type": "integer",
|
|
3705
|
+
"description": "Count of questions for which the assistant provided no answer."
|
|
3706
|
+
},
|
|
3707
|
+
"interactions": {
|
|
3708
|
+
"type": "integer",
|
|
3709
|
+
"description": "Amount of interactions for a thread or an assistant."
|
|
3710
|
+
}
|
|
3711
|
+
}
|
|
3712
|
+
},
|
|
3713
|
+
"followup": {
|
|
3714
|
+
"type": "object",
|
|
3715
|
+
"required": [
|
|
3716
|
+
"question",
|
|
3717
|
+
"followups",
|
|
3718
|
+
"id",
|
|
3719
|
+
"recommendedAnswer",
|
|
3720
|
+
"additionalContext"
|
|
3721
|
+
],
|
|
3722
|
+
"properties": {
|
|
3723
|
+
"id": {
|
|
3724
|
+
"type": "string",
|
|
3725
|
+
"format": "uuid",
|
|
3726
|
+
"example": "507f191e810c19729de860ea",
|
|
3727
|
+
"description": "Unique identifier of the Followup."
|
|
3728
|
+
},
|
|
3729
|
+
"question": {
|
|
3730
|
+
"type": "string",
|
|
3731
|
+
"example": "Where was Genghis Khan buried?",
|
|
3732
|
+
"description": "Starter sample question."
|
|
3733
|
+
},
|
|
3734
|
+
"additionalContext": {
|
|
3735
|
+
"type": "string",
|
|
3736
|
+
"description": "Optional context collected from curated meant to be leveraged by LLM-based question recommendation system."
|
|
3737
|
+
},
|
|
3738
|
+
"recommendedAnswer": {
|
|
3739
|
+
"$ref": "#/components/schemas/recommendedAnswer"
|
|
3740
|
+
}
|
|
3741
|
+
}
|
|
3742
|
+
},
|
|
3743
|
+
"Interaction": {
|
|
3744
|
+
"type": "object",
|
|
3745
|
+
"required": [
|
|
3746
|
+
"id",
|
|
3747
|
+
"request",
|
|
3748
|
+
"response",
|
|
3749
|
+
"createdAt",
|
|
3750
|
+
"updatedAt",
|
|
3751
|
+
"sources",
|
|
3752
|
+
"ownerId",
|
|
3753
|
+
"threadId"
|
|
3754
|
+
],
|
|
3755
|
+
"properties": {
|
|
3756
|
+
"id": {
|
|
3757
|
+
"type": "string",
|
|
3758
|
+
"format": "uuid",
|
|
3759
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303"
|
|
3760
|
+
},
|
|
3761
|
+
"ownerId": {
|
|
3762
|
+
"type": "string",
|
|
3763
|
+
"example": "65e310c43fb1cf46654e0878",
|
|
3764
|
+
"description": "Unique identifier of user which created the interaction."
|
|
3765
|
+
},
|
|
3766
|
+
"request": {
|
|
3767
|
+
"type": "string",
|
|
3768
|
+
"example": "Where was Genghis Khan buried?",
|
|
3769
|
+
"description": "Interaction request content."
|
|
3770
|
+
},
|
|
3771
|
+
"sources": {
|
|
3772
|
+
"type": "array",
|
|
3773
|
+
"items": {
|
|
3774
|
+
"$ref": "#/components/schemas/MessageSource"
|
|
3775
|
+
},
|
|
3776
|
+
"description": "List of sources used to generate AI messages (interactions)."
|
|
3777
|
+
},
|
|
3778
|
+
"feedback": {
|
|
3779
|
+
"$ref": "#/components/schemas/Feedback"
|
|
3780
|
+
},
|
|
3781
|
+
"rejected": {
|
|
3782
|
+
"type": "boolean",
|
|
3783
|
+
"example": true,
|
|
3784
|
+
"description": "Indicator the system marked request as suspicious."
|
|
3785
|
+
},
|
|
3786
|
+
"response": {
|
|
3787
|
+
"type": "string",
|
|
3788
|
+
"example": "Somewhere in an unmarked grave",
|
|
3789
|
+
"description": "Interaction response content."
|
|
3790
|
+
},
|
|
3791
|
+
"threadId": {
|
|
3792
|
+
"type": "string",
|
|
3793
|
+
"format": "uuid",
|
|
3794
|
+
"example": "125c24c4-668c-4c97-bef8-30d910169913",
|
|
3795
|
+
"description": "ID of the thread to which the interaction belongs."
|
|
3796
|
+
},
|
|
3797
|
+
"createdAt": {
|
|
3798
|
+
"type": "string",
|
|
3799
|
+
"format": "date-time",
|
|
3800
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
3801
|
+
"readOnly": true,
|
|
3802
|
+
"description": "Datetime when the interaction was created."
|
|
3803
|
+
},
|
|
3804
|
+
"updatedAt": {
|
|
3805
|
+
"type": "string",
|
|
3806
|
+
"format": "date-time",
|
|
3807
|
+
"example": "2021-10-02T14:20:55.52Z",
|
|
3808
|
+
"readOnly": true,
|
|
3809
|
+
"description": "Datetime when the interaction was updated."
|
|
3810
|
+
}
|
|
3811
|
+
}
|
|
3812
|
+
},
|
|
3813
|
+
"interactionsResult": {
|
|
3814
|
+
"type": "object",
|
|
3815
|
+
"required": [
|
|
3816
|
+
"data"
|
|
3817
|
+
],
|
|
3818
|
+
"properties": {
|
|
3819
|
+
"data": {
|
|
3820
|
+
"type": "array",
|
|
3821
|
+
"items": {
|
|
3822
|
+
"$ref": "#/components/schemas/Interaction"
|
|
3823
|
+
}
|
|
3824
|
+
},
|
|
3825
|
+
"meta": {
|
|
3826
|
+
"$ref": "#/components/schemas/resultMeta"
|
|
3827
|
+
},
|
|
3828
|
+
"links": {
|
|
3829
|
+
"$ref": "#/components/schemas/pageLinks"
|
|
3830
|
+
}
|
|
3831
|
+
}
|
|
3832
|
+
},
|
|
3833
|
+
"JSONPatch": {
|
|
3834
|
+
"type": "object",
|
|
3835
|
+
"required": [
|
|
3836
|
+
"op",
|
|
3837
|
+
"path",
|
|
3838
|
+
"value"
|
|
3839
|
+
],
|
|
3840
|
+
"properties": {
|
|
3841
|
+
"op": {
|
|
3842
|
+
"enum": [
|
|
3843
|
+
"replace",
|
|
3844
|
+
"add"
|
|
3845
|
+
],
|
|
3846
|
+
"type": "string",
|
|
3847
|
+
"description": "The operation to be performed."
|
|
3848
|
+
},
|
|
3849
|
+
"path": {
|
|
3850
|
+
"type": "string",
|
|
3851
|
+
"description": "A JSON Pointer."
|
|
3852
|
+
},
|
|
3853
|
+
"value": {
|
|
3854
|
+
"oneOf": [
|
|
3855
|
+
{
|
|
3856
|
+
"type": "string"
|
|
3857
|
+
},
|
|
3858
|
+
{
|
|
3859
|
+
"type": "number"
|
|
3860
|
+
},
|
|
3861
|
+
{
|
|
3862
|
+
"type": "boolean"
|
|
3863
|
+
}
|
|
3864
|
+
],
|
|
3865
|
+
"description": "The value to be used for this operation."
|
|
3866
|
+
}
|
|
3867
|
+
},
|
|
3868
|
+
"description": "A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902."
|
|
3869
|
+
},
|
|
3870
|
+
"JSONPatchArray": {
|
|
3871
|
+
"type": "array",
|
|
3872
|
+
"items": {
|
|
3873
|
+
"$ref": "#/components/schemas/JSONPatch"
|
|
3874
|
+
},
|
|
3875
|
+
"example": [
|
|
3876
|
+
{
|
|
3877
|
+
"op": "replace",
|
|
3878
|
+
"path": "/name",
|
|
3879
|
+
"value": "new name"
|
|
3880
|
+
},
|
|
3881
|
+
{
|
|
3882
|
+
"op": "replace",
|
|
3883
|
+
"path": "/description",
|
|
3884
|
+
"value": "new description"
|
|
3885
|
+
},
|
|
3886
|
+
{
|
|
3887
|
+
"op": "add",
|
|
3888
|
+
"path": "/defaultPromptType",
|
|
3889
|
+
"value": "thread"
|
|
3890
|
+
},
|
|
3891
|
+
{
|
|
3892
|
+
"op": "remove",
|
|
3893
|
+
"path": "/avatar"
|
|
3894
|
+
},
|
|
3895
|
+
{
|
|
3896
|
+
"op": "add",
|
|
3897
|
+
"path": "/avatar",
|
|
3898
|
+
"value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="
|
|
3899
|
+
},
|
|
3900
|
+
{
|
|
3901
|
+
"op": "replace",
|
|
3902
|
+
"path": "/avatar",
|
|
3903
|
+
"value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="
|
|
3904
|
+
}
|
|
3905
|
+
],
|
|
3906
|
+
"description": "An array of JSON Patch documents."
|
|
3907
|
+
},
|
|
3908
|
+
"kbChunkMeta": {
|
|
3909
|
+
"type": "object",
|
|
3910
|
+
"required": [
|
|
3911
|
+
"documentId",
|
|
3912
|
+
"datasourceId",
|
|
3913
|
+
"chunkId",
|
|
3914
|
+
"source",
|
|
3915
|
+
"knowledgeBaseId"
|
|
3916
|
+
],
|
|
3917
|
+
"properties": {
|
|
3918
|
+
"source": {
|
|
3919
|
+
"type": "string",
|
|
3920
|
+
"description": "source of chunk"
|
|
3921
|
+
},
|
|
3922
|
+
"chunkId": {
|
|
3923
|
+
"type": "string",
|
|
3924
|
+
"description": "chunkId"
|
|
3925
|
+
},
|
|
3926
|
+
"documentId": {
|
|
3927
|
+
"type": "string",
|
|
3928
|
+
"description": "documentId of chunk"
|
|
3929
|
+
},
|
|
3930
|
+
"datasourceId": {
|
|
3931
|
+
"type": "string",
|
|
3932
|
+
"description": "datasourceId of chunk"
|
|
3933
|
+
},
|
|
3934
|
+
"knowledgeBaseId": {
|
|
3935
|
+
"type": "string",
|
|
3936
|
+
"description": "knowledgeBaseId of chunk"
|
|
3937
|
+
}
|
|
3938
|
+
},
|
|
3939
|
+
"description": "Metadata about the chunk"
|
|
3940
|
+
},
|
|
3941
|
+
"Message": {
|
|
3942
|
+
"type": "object",
|
|
3943
|
+
"required": [
|
|
3944
|
+
"id",
|
|
3945
|
+
"role",
|
|
3946
|
+
"content",
|
|
3947
|
+
"createdAt",
|
|
3948
|
+
"sources"
|
|
3949
|
+
],
|
|
3950
|
+
"properties": {
|
|
3951
|
+
"id": {
|
|
3952
|
+
"type": "string",
|
|
3953
|
+
"format": "uuid",
|
|
3954
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303"
|
|
3955
|
+
},
|
|
3956
|
+
"role": {
|
|
3957
|
+
"type": "string",
|
|
3958
|
+
"example": "ai",
|
|
3959
|
+
"description": "human or ai role."
|
|
3960
|
+
},
|
|
3961
|
+
"content": {
|
|
3962
|
+
"type": "string",
|
|
3963
|
+
"example": "Somewhere in an unmarked grave",
|
|
3964
|
+
"description": "Message content."
|
|
3965
|
+
},
|
|
3966
|
+
"sources": {
|
|
3967
|
+
"type": "array",
|
|
3968
|
+
"items": {
|
|
3969
|
+
"$ref": "#/components/schemas/MessageSource"
|
|
3970
|
+
},
|
|
3971
|
+
"description": "List of sources used to generate AI messages (interactions)."
|
|
3972
|
+
},
|
|
3973
|
+
"createdAt": {
|
|
3974
|
+
"type": "string",
|
|
3975
|
+
"format": "date-time",
|
|
3976
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
3977
|
+
"readOnly": true,
|
|
3978
|
+
"description": "Datetime when the interaction was created."
|
|
3979
|
+
}
|
|
3980
|
+
}
|
|
3981
|
+
},
|
|
3982
|
+
"MessageSource": {
|
|
3983
|
+
"type": "object",
|
|
3984
|
+
"required": [
|
|
3985
|
+
"knowledgebaseId",
|
|
3986
|
+
"datasourceId",
|
|
3987
|
+
"documentId",
|
|
3988
|
+
"source",
|
|
3989
|
+
"chunks"
|
|
3990
|
+
],
|
|
3991
|
+
"properties": {
|
|
3992
|
+
"chunks": {
|
|
3993
|
+
"type": "array",
|
|
3994
|
+
"items": {
|
|
3995
|
+
"$ref": "#/components/schemas/MessageSourceChunk"
|
|
3996
|
+
},
|
|
3997
|
+
"description": "List of Chunks used for \"AI\" generated messages."
|
|
3998
|
+
},
|
|
3999
|
+
"source": {
|
|
4000
|
+
"type": "string",
|
|
4001
|
+
"example": "Reference.md",
|
|
4002
|
+
"description": "Path to the document used."
|
|
4003
|
+
},
|
|
4004
|
+
"documentId": {
|
|
4005
|
+
"type": "string",
|
|
4006
|
+
"format": "uuid",
|
|
4007
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303",
|
|
4008
|
+
"description": "Reference to Document used for \"AI\" generated messages."
|
|
4009
|
+
},
|
|
4010
|
+
"datasourceId": {
|
|
4011
|
+
"type": "string",
|
|
4012
|
+
"format": "uuid",
|
|
4013
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303",
|
|
4014
|
+
"description": "Reference to DataSource used for \"AI\" generated messages."
|
|
4015
|
+
},
|
|
4016
|
+
"lastIndexedAt": {
|
|
4017
|
+
"type": "string",
|
|
4018
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
4019
|
+
"description": "Datetime when the knowledgebase was last indexed."
|
|
4020
|
+
},
|
|
4021
|
+
"knowledgebaseId": {
|
|
4022
|
+
"type": "string",
|
|
4023
|
+
"format": "uuid",
|
|
4024
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303",
|
|
4025
|
+
"description": "Reference to KnowledgeBase used for \"AI\" generated messages."
|
|
4026
|
+
}
|
|
4027
|
+
}
|
|
4028
|
+
},
|
|
4029
|
+
"MessageSourceChunk": {
|
|
4030
|
+
"type": "object",
|
|
4031
|
+
"required": [
|
|
4032
|
+
"chunkId"
|
|
4033
|
+
],
|
|
4034
|
+
"properties": {
|
|
4035
|
+
"text": {
|
|
4036
|
+
"type": "string",
|
|
4037
|
+
"description": "Chunk text for \"AI\" generated message source."
|
|
4038
|
+
},
|
|
4039
|
+
"chunkId": {
|
|
4040
|
+
"type": "string",
|
|
4041
|
+
"format": "uuid",
|
|
4042
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303",
|
|
4043
|
+
"description": "Chunk unique identifier for \"AI\" generated message source."
|
|
4044
|
+
}
|
|
4045
|
+
}
|
|
4046
|
+
},
|
|
4047
|
+
"pageLink": {
|
|
4048
|
+
"type": "object",
|
|
4049
|
+
"properties": {
|
|
4050
|
+
"href": {
|
|
4051
|
+
"type": "string"
|
|
4052
|
+
}
|
|
4053
|
+
}
|
|
4054
|
+
},
|
|
4055
|
+
"pageLinks": {
|
|
4056
|
+
"type": "object",
|
|
4057
|
+
"properties": {
|
|
4058
|
+
"next": {
|
|
4059
|
+
"$ref": "#/components/schemas/pageLink"
|
|
4060
|
+
},
|
|
4061
|
+
"prev": {
|
|
4062
|
+
"$ref": "#/components/schemas/pageLink"
|
|
4063
|
+
},
|
|
4064
|
+
"self": {
|
|
4065
|
+
"$ref": "#/components/schemas/pageLink"
|
|
4066
|
+
}
|
|
4067
|
+
}
|
|
4068
|
+
},
|
|
4069
|
+
"promptInput": {
|
|
4070
|
+
"type": "object",
|
|
4071
|
+
"properties": {
|
|
4072
|
+
"input": {
|
|
4073
|
+
"type": "object",
|
|
4074
|
+
"properties": {
|
|
4075
|
+
"prompt": {
|
|
4076
|
+
"type": "string",
|
|
4077
|
+
"example": "What is a LLM?",
|
|
4078
|
+
"description": "Input prompt string for the Assistant to respond to."
|
|
4079
|
+
},
|
|
4080
|
+
"promptType": {
|
|
4081
|
+
"enum": [
|
|
4082
|
+
"thread"
|
|
4083
|
+
],
|
|
4084
|
+
"type": "string",
|
|
4085
|
+
"example": "thread",
|
|
4086
|
+
"description": "Sets the prompt type to thread."
|
|
4087
|
+
},
|
|
4088
|
+
"includeText": {
|
|
4089
|
+
"type": "boolean",
|
|
4090
|
+
"example": true,
|
|
4091
|
+
"description": "Returns text from chunks in sources output. Default value is false."
|
|
4092
|
+
}
|
|
4093
|
+
}
|
|
4094
|
+
}
|
|
4095
|
+
}
|
|
4096
|
+
},
|
|
4097
|
+
"promptOutput": {
|
|
4098
|
+
"type": "object",
|
|
4099
|
+
"properties": {
|
|
4100
|
+
"output": {
|
|
4101
|
+
"type": "string",
|
|
4102
|
+
"example": "LLM stands for Large Language Model",
|
|
4103
|
+
"description": "Assistant's response to the prompt"
|
|
4104
|
+
},
|
|
4105
|
+
"sources": {
|
|
4106
|
+
"type": "array",
|
|
4107
|
+
"items": {
|
|
4108
|
+
"$ref": "#/components/schemas/source"
|
|
4109
|
+
},
|
|
4110
|
+
"description": "List of sources used to generate AI messages"
|
|
4111
|
+
}
|
|
4112
|
+
}
|
|
4113
|
+
},
|
|
4114
|
+
"promptOutputInvoke": {
|
|
4115
|
+
"type": "object",
|
|
4116
|
+
"properties": {
|
|
4117
|
+
"output": {
|
|
4118
|
+
"type": "string",
|
|
4119
|
+
"example": "LLM stands for Large Language Model",
|
|
4120
|
+
"description": "Assistant's response to the prompt"
|
|
4121
|
+
},
|
|
4122
|
+
"sources": {
|
|
4123
|
+
"type": "array",
|
|
4124
|
+
"items": {
|
|
4125
|
+
"$ref": "#/components/schemas/source"
|
|
4126
|
+
},
|
|
4127
|
+
"description": "List of sources used to generate AI messages"
|
|
4128
|
+
},
|
|
4129
|
+
"question": {
|
|
4130
|
+
"type": "string",
|
|
4131
|
+
"example": "What was the primary goal of the Apollo program?",
|
|
4132
|
+
"description": "Question asked by the user for assistant to answer"
|
|
4133
|
+
}
|
|
4134
|
+
}
|
|
4135
|
+
},
|
|
4136
|
+
"recommendedAnswer": {
|
|
4137
|
+
"type": "object",
|
|
4138
|
+
"required": [
|
|
4139
|
+
"content",
|
|
4140
|
+
"contentType"
|
|
4141
|
+
],
|
|
4142
|
+
"properties": {
|
|
4143
|
+
"content": {
|
|
4144
|
+
"type": "string",
|
|
4145
|
+
"description": "Starter answer content."
|
|
4146
|
+
},
|
|
4147
|
+
"contentType": {
|
|
4148
|
+
"type": "string",
|
|
4149
|
+
"example": "text | markdown | html",
|
|
4150
|
+
"description": "Answer type of content."
|
|
4151
|
+
}
|
|
4152
|
+
}
|
|
4153
|
+
},
|
|
4154
|
+
"rejectionReason": {
|
|
4155
|
+
"enum": [
|
|
4156
|
+
1,
|
|
4157
|
+
2,
|
|
4158
|
+
3
|
|
4159
|
+
],
|
|
4160
|
+
"type": "integer",
|
|
4161
|
+
"example": 1,
|
|
4162
|
+
"description": "Rejection reason for a question:\n * 1 - PROMPT_INJECTION\n * 2 - OUT_OF_CONTEXT\n * 3 - TOO_COMPLEX\n"
|
|
4163
|
+
},
|
|
4164
|
+
"resultMeta": {
|
|
4165
|
+
"type": "object",
|
|
4166
|
+
"properties": {
|
|
4167
|
+
"countTotal": {
|
|
4168
|
+
"type": "integer"
|
|
4169
|
+
}
|
|
4170
|
+
}
|
|
4171
|
+
},
|
|
4172
|
+
"searchRequest": {
|
|
4173
|
+
"type": "object",
|
|
4174
|
+
"required": [
|
|
4175
|
+
"prompt"
|
|
4176
|
+
],
|
|
4177
|
+
"properties": {
|
|
4178
|
+
"topN": {
|
|
4179
|
+
"type": "integer",
|
|
4180
|
+
"example": 20,
|
|
4181
|
+
"description": "Number of chunks to return in results."
|
|
4182
|
+
},
|
|
4183
|
+
"prompt": {
|
|
4184
|
+
"type": "string",
|
|
4185
|
+
"example": "What is LLM?",
|
|
4186
|
+
"description": "Query text or question to search."
|
|
4187
|
+
},
|
|
4188
|
+
"searchMode": {
|
|
4189
|
+
"enum": [
|
|
4190
|
+
"SIMPLE",
|
|
4191
|
+
"FULL"
|
|
4192
|
+
],
|
|
4193
|
+
"type": "string",
|
|
4194
|
+
"example": "SIMPLE",
|
|
4195
|
+
"description": "Search mode to use. Allowed values: `SIMPLE` and `FULL`. Default: `SIMPLE`.\n"
|
|
4196
|
+
}
|
|
4197
|
+
}
|
|
4198
|
+
},
|
|
4199
|
+
"searchResponse": {
|
|
4200
|
+
"type": "object",
|
|
4201
|
+
"required": [
|
|
4202
|
+
"chunks"
|
|
4203
|
+
],
|
|
4204
|
+
"properties": {
|
|
4205
|
+
"chunks": {
|
|
4206
|
+
"type": "array",
|
|
4207
|
+
"items": {
|
|
4208
|
+
"$ref": "#/components/schemas/chunk"
|
|
4209
|
+
},
|
|
4210
|
+
"description": "Retrieved document chunks"
|
|
4211
|
+
}
|
|
4212
|
+
}
|
|
4213
|
+
},
|
|
4214
|
+
"source": {
|
|
4215
|
+
"type": "object",
|
|
4216
|
+
"properties": {
|
|
4217
|
+
"chunks": {
|
|
4218
|
+
"type": "array",
|
|
4219
|
+
"items": {
|
|
4220
|
+
"type": "object",
|
|
4221
|
+
"example": {
|
|
4222
|
+
"text": "LLM stands for Large Language Model",
|
|
4223
|
+
"chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303"
|
|
4224
|
+
}
|
|
4225
|
+
},
|
|
4226
|
+
"description": "List of Chunks used for \"AI\" generated messages"
|
|
4227
|
+
},
|
|
4228
|
+
"source": {
|
|
4229
|
+
"type": "string",
|
|
4230
|
+
"example": "Reference.md",
|
|
4231
|
+
"description": "path to the document used"
|
|
4232
|
+
},
|
|
4233
|
+
"documentId": {
|
|
4234
|
+
"type": "string",
|
|
4235
|
+
"format": "uuid",
|
|
4236
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303",
|
|
4237
|
+
"description": "reference to Document used for \"AI\" generated messages"
|
|
4238
|
+
},
|
|
4239
|
+
"datasourceId": {
|
|
4240
|
+
"type": "string",
|
|
4241
|
+
"format": "uuid",
|
|
4242
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303",
|
|
4243
|
+
"description": "reference to DataSource used for \"AI\" generated messages"
|
|
4244
|
+
},
|
|
4245
|
+
"knowledgebaseId": {
|
|
4246
|
+
"type": "string",
|
|
4247
|
+
"format": "uuid",
|
|
4248
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303",
|
|
4249
|
+
"description": "reference to KnowledgeBase used for \"AI\" generated messages"
|
|
4250
|
+
}
|
|
4251
|
+
}
|
|
4252
|
+
},
|
|
4253
|
+
"sourcesPlaintext": {
|
|
4254
|
+
"type": "object",
|
|
4255
|
+
"properties": {
|
|
4256
|
+
"textByChunkId": {
|
|
4257
|
+
"type": "object",
|
|
4258
|
+
"example": {
|
|
4259
|
+
"chunk1_id": "chunk1_text",
|
|
4260
|
+
"chunk2_id": "chunk2_text"
|
|
4261
|
+
},
|
|
4262
|
+
"additionalProperties": true
|
|
4263
|
+
}
|
|
4264
|
+
}
|
|
4265
|
+
},
|
|
4266
|
+
"Starter": {
|
|
4267
|
+
"type": "object",
|
|
4268
|
+
"required": [
|
|
4269
|
+
"id",
|
|
4270
|
+
"question",
|
|
4271
|
+
"createdAt",
|
|
4272
|
+
"updatedAt",
|
|
4273
|
+
"additionalContext",
|
|
4274
|
+
"recommendedAnswer"
|
|
4275
|
+
],
|
|
4276
|
+
"properties": {
|
|
4277
|
+
"id": {
|
|
4278
|
+
"type": "string",
|
|
4279
|
+
"format": "uuid",
|
|
4280
|
+
"example": "507f191e810c19729de860ea",
|
|
4281
|
+
"description": "Unique identifier of the starter."
|
|
4282
|
+
},
|
|
4283
|
+
"question": {
|
|
4284
|
+
"type": "string",
|
|
4285
|
+
"example": "Where was Genghis Khan buried?",
|
|
4286
|
+
"description": "Starter sample question."
|
|
4287
|
+
},
|
|
4288
|
+
"createdAt": {
|
|
4289
|
+
"type": "string",
|
|
4290
|
+
"format": "date-time",
|
|
4291
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
4292
|
+
"readOnly": true,
|
|
4293
|
+
"description": "Datetime when the starter was created."
|
|
4294
|
+
},
|
|
4295
|
+
"followups": {
|
|
4296
|
+
"type": "array",
|
|
4297
|
+
"items": {
|
|
4298
|
+
"$ref": "#/components/schemas/followup"
|
|
4299
|
+
},
|
|
4300
|
+
"description": "List of followups."
|
|
4301
|
+
},
|
|
4302
|
+
"updatedAt": {
|
|
4303
|
+
"type": "string",
|
|
4304
|
+
"format": "date-time",
|
|
4305
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
4306
|
+
"readOnly": true,
|
|
4307
|
+
"description": "Datetime when the starter was updated."
|
|
4308
|
+
},
|
|
4309
|
+
"additionalContext": {
|
|
4310
|
+
"type": "string",
|
|
4311
|
+
"description": "Optional context collected from curated meant to be leveraged by LLM-based question recommendation system."
|
|
4312
|
+
},
|
|
4313
|
+
"recommendedAnswer": {
|
|
4314
|
+
"$ref": "#/components/schemas/recommendedAnswer"
|
|
4315
|
+
}
|
|
4316
|
+
}
|
|
4317
|
+
},
|
|
4318
|
+
"startersResult": {
|
|
4319
|
+
"type": "object",
|
|
4320
|
+
"required": [
|
|
4321
|
+
"data"
|
|
4322
|
+
],
|
|
4323
|
+
"properties": {
|
|
4324
|
+
"data": {
|
|
4325
|
+
"type": "array",
|
|
4326
|
+
"items": {
|
|
4327
|
+
"$ref": "#/components/schemas/Starter"
|
|
4328
|
+
}
|
|
4329
|
+
},
|
|
4330
|
+
"meta": {
|
|
4331
|
+
"$ref": "#/components/schemas/resultMeta"
|
|
4332
|
+
},
|
|
4333
|
+
"links": {
|
|
4334
|
+
"$ref": "#/components/schemas/pageLinks"
|
|
4335
|
+
}
|
|
4336
|
+
}
|
|
4337
|
+
},
|
|
4338
|
+
"Thread": {
|
|
4339
|
+
"type": "object",
|
|
4340
|
+
"required": [
|
|
4341
|
+
"id",
|
|
4342
|
+
"name",
|
|
4343
|
+
"ownerId",
|
|
4344
|
+
"createdAt",
|
|
4345
|
+
"updatedAt",
|
|
4346
|
+
"hasFeedback",
|
|
4347
|
+
"favorite",
|
|
4348
|
+
"summaryStats"
|
|
4349
|
+
],
|
|
4350
|
+
"properties": {
|
|
4351
|
+
"id": {
|
|
4352
|
+
"type": "string",
|
|
4353
|
+
"format": "uuid",
|
|
4354
|
+
"example": "507f191e810c19729de860ea",
|
|
4355
|
+
"description": "Unique identifier of the thread."
|
|
4356
|
+
},
|
|
4357
|
+
"name": {
|
|
4358
|
+
"type": "string",
|
|
4359
|
+
"example": "Initial conversation",
|
|
4360
|
+
"description": "The name of the thread."
|
|
4361
|
+
},
|
|
4362
|
+
"ownerId": {
|
|
4363
|
+
"type": "string",
|
|
4364
|
+
"format": "uuid",
|
|
4365
|
+
"example": "10d347c4-f28a-4faf-93f0-48e781aaf303"
|
|
4366
|
+
},
|
|
4367
|
+
"favorite": {
|
|
4368
|
+
"type": "boolean",
|
|
4369
|
+
"default": false,
|
|
4370
|
+
"example": false,
|
|
4371
|
+
"description": "If thread is marked as favorite."
|
|
4372
|
+
},
|
|
4373
|
+
"createdAt": {
|
|
4374
|
+
"type": "string",
|
|
4375
|
+
"format": "date-time",
|
|
4376
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
4377
|
+
"readOnly": true,
|
|
4378
|
+
"description": "Datetime when the thread was created."
|
|
4379
|
+
},
|
|
4380
|
+
"deletedAt": {
|
|
4381
|
+
"type": "string",
|
|
4382
|
+
"format": "date-time",
|
|
4383
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
4384
|
+
"readOnly": true,
|
|
4385
|
+
"description": "Datetime when the thread was deleted."
|
|
4386
|
+
},
|
|
4387
|
+
"updatedAt": {
|
|
4388
|
+
"type": "string",
|
|
4389
|
+
"format": "date-time",
|
|
4390
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
4391
|
+
"readOnly": true,
|
|
4392
|
+
"description": "Datetime when the thread was updated."
|
|
4393
|
+
},
|
|
4394
|
+
"hasFeedback": {
|
|
4395
|
+
"type": "boolean",
|
|
4396
|
+
"default": false,
|
|
4397
|
+
"example": false,
|
|
4398
|
+
"description": "If feedback was provided for a thread interaction."
|
|
4399
|
+
},
|
|
4400
|
+
"summaryStats": {
|
|
4401
|
+
"$ref": "#/components/schemas/feedbackSummary"
|
|
4402
|
+
}
|
|
4403
|
+
}
|
|
4404
|
+
},
|
|
4405
|
+
"threadPatchArray": {
|
|
4406
|
+
"type": "array",
|
|
4407
|
+
"items": {
|
|
4408
|
+
"$ref": "#/components/schemas/JSONPatch"
|
|
4409
|
+
},
|
|
4410
|
+
"example": [
|
|
4411
|
+
{
|
|
4412
|
+
"op": "replace",
|
|
4413
|
+
"path": "/name",
|
|
4414
|
+
"value": "new name"
|
|
4415
|
+
}
|
|
4416
|
+
],
|
|
4417
|
+
"description": "An array of JSON Patch documents."
|
|
4418
|
+
},
|
|
4419
|
+
"threadsResult": {
|
|
4420
|
+
"type": "object",
|
|
4421
|
+
"required": [
|
|
4422
|
+
"data"
|
|
4423
|
+
],
|
|
4424
|
+
"properties": {
|
|
4425
|
+
"data": {
|
|
4426
|
+
"type": "array",
|
|
4427
|
+
"items": {
|
|
4428
|
+
"$ref": "#/components/schemas/Thread"
|
|
4429
|
+
}
|
|
4430
|
+
},
|
|
4431
|
+
"meta": {
|
|
4432
|
+
"$ref": "#/components/schemas/resultMeta"
|
|
4433
|
+
},
|
|
4434
|
+
"links": {
|
|
4435
|
+
"$ref": "#/components/schemas/pageLinks"
|
|
4436
|
+
}
|
|
4437
|
+
}
|
|
4438
|
+
},
|
|
4439
|
+
"ThreadWithMessages": {
|
|
4440
|
+
"type": "object",
|
|
4441
|
+
"required": [
|
|
4442
|
+
"id",
|
|
4443
|
+
"name",
|
|
4444
|
+
"createdAt",
|
|
4445
|
+
"updatedAt",
|
|
4446
|
+
"ownerId",
|
|
4447
|
+
"hasFeedback",
|
|
4448
|
+
"favorite",
|
|
4449
|
+
"messages",
|
|
4450
|
+
"summaryStats"
|
|
4451
|
+
],
|
|
4452
|
+
"properties": {
|
|
4453
|
+
"id": {
|
|
4454
|
+
"type": "string",
|
|
4455
|
+
"format": "uuid",
|
|
4456
|
+
"example": "507f191e810c19729de860ea",
|
|
4457
|
+
"description": "Unique identifier of the thread."
|
|
4458
|
+
},
|
|
4459
|
+
"name": {
|
|
4460
|
+
"type": "string",
|
|
4461
|
+
"example": "Initial conversation",
|
|
4462
|
+
"description": "The name of the thread."
|
|
4463
|
+
},
|
|
4464
|
+
"ownerId": {
|
|
4465
|
+
"type": "string",
|
|
4466
|
+
"format": "uuid",
|
|
4467
|
+
"example": "507f191e810c19729de860ea",
|
|
4468
|
+
"description": "Unique identifier of the thread owner."
|
|
4469
|
+
},
|
|
4470
|
+
"favorite": {
|
|
4471
|
+
"type": "boolean",
|
|
4472
|
+
"default": false,
|
|
4473
|
+
"example": false,
|
|
4474
|
+
"description": "If thread is marked as favorite."
|
|
4475
|
+
},
|
|
4476
|
+
"messages": {
|
|
4477
|
+
"type": "array",
|
|
4478
|
+
"items": {
|
|
4479
|
+
"$ref": "#/components/schemas/Message"
|
|
4480
|
+
}
|
|
4481
|
+
},
|
|
4482
|
+
"createdAt": {
|
|
4483
|
+
"type": "string",
|
|
4484
|
+
"format": "date-time",
|
|
4485
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
4486
|
+
"readOnly": true,
|
|
4487
|
+
"description": "Datetime when the thread was created."
|
|
4488
|
+
},
|
|
4489
|
+
"deletedAt": {
|
|
4490
|
+
"type": "string",
|
|
4491
|
+
"format": "date-time",
|
|
4492
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
4493
|
+
"readOnly": true,
|
|
4494
|
+
"description": "Datetime when the thread was deleted."
|
|
4495
|
+
},
|
|
4496
|
+
"updatedAt": {
|
|
4497
|
+
"type": "string",
|
|
4498
|
+
"format": "date-time",
|
|
4499
|
+
"example": "2021-10-02T14:20:50.52Z",
|
|
4500
|
+
"readOnly": true,
|
|
4501
|
+
"description": "Datetime when the thread was updated."
|
|
4502
|
+
},
|
|
4503
|
+
"hasFeedback": {
|
|
4504
|
+
"type": "boolean",
|
|
4505
|
+
"default": false,
|
|
4506
|
+
"example": false,
|
|
4507
|
+
"description": "If feedback was provided for a thread interaction."
|
|
4508
|
+
},
|
|
4509
|
+
"summaryStats": {
|
|
4510
|
+
"$ref": "#/components/schemas/feedbackSummary"
|
|
4511
|
+
}
|
|
4512
|
+
}
|
|
4513
|
+
}
|
|
4514
|
+
}
|
|
4515
|
+
},
|
|
4516
|
+
"servers": [
|
|
4517
|
+
{
|
|
4518
|
+
"url": "https://{tenant}.{region}.qlikcloud.com",
|
|
4519
|
+
"variables": {
|
|
4520
|
+
"region": {
|
|
4521
|
+
"default": "us",
|
|
4522
|
+
"description": "The region the tenant is hosted in"
|
|
4523
|
+
},
|
|
4524
|
+
"tenant": {
|
|
4525
|
+
"default": "your-tenant",
|
|
4526
|
+
"description": "Name of the tenant that will be called"
|
|
4527
|
+
}
|
|
4528
|
+
}
|
|
4529
|
+
}
|
|
4530
|
+
]
|
|
4531
|
+
}
|