@qlik/api 2.2.0 → 2.3.0

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.
Files changed (231) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +6 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,1366 +0,0 @@
1
- import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/assistants.d.ts
4
- type Assistant = {
5
- /** Datetime when the assistant was created. */
6
- readonly createdAt: string;
7
- /** Unique identifier of the user who created the assistant. */
8
- readonly createdBy: string;
9
- /** freeform JSON to allow custom customization options. */
10
- customProperties: unknown;
11
- /** Default prompt type for the assistant. */
12
- defaultPromptType?: "thread" | "oneshot";
13
- /** The description of the assistant. */
14
- description: string;
15
- /** Indicates if the assistant has an avatar. */
16
- hasAvatar?: boolean;
17
- /** Unique identifier of the assistant. */
18
- id: string;
19
- /** List of knowledgebases the assistant is using. */
20
- knowledgeBases: string[];
21
- /** The name of the assistant. */
22
- name: string;
23
- /** List of starter IDs in the order they will be sorted. */
24
- orderedStarterIds?: string[];
25
- /** Unique identifier of the assistant owner. */
26
- ownerId: string;
27
- /** Unique identifier of the space containing the assistant. */
28
- spaceId: string;
29
- /** @deprecated
30
- * System prompt setting up conversation context. */
31
- systemMessage?: string;
32
- /** The list of tags associated with the assistant. */
33
- tags: string[];
34
- /** Unique identifier of the assistant tenant. */
35
- tenantId: string;
36
- /** The title of the assistant. */
37
- title?: string;
38
- /** Datetime when the assistant was updated. */
39
- readonly updatedAt: string;
40
- /** Unique identifier of the user who last updated the assistant. */
41
- readonly updatedBy: string;
42
- /** Initial message in the chat conversation. */
43
- welcomeMessage: string;
44
- };
45
- /**
46
- * @example
47
- * {
48
- * chunkIds: [
49
- * "c2ef42d9-7164-4fb0-bdbb-6534ae37263e",
50
- * "486ada2c-f895-4961-8ba5-7995f1026d26"
51
- * ]
52
- * }
53
- */
54
- type ChunksRefs = {
55
- chunkIds: string[];
56
- };
57
- type Feedback = {
58
- /** Optional comment for feedback. */
59
- comment: string;
60
- /** Unique feedback identifier. */
61
- id: string;
62
- /** Reason for feedback. */
63
- reason: string;
64
- /** Feedback review status. */
65
- reviewStatus: string;
66
- /** Datetime when the feedback was reviewed. */
67
- reviewedAt?: string;
68
- /** Unique feedback reviewer identifier. */
69
- reviewerId: string;
70
- /** Integer representation of feedback given (-1 = negative, 1 = positive). */
71
- vote: number;
72
- };
73
- type Interaction = {
74
- /** Datetime when the interaction was created. */
75
- readonly createdAt: string;
76
- feedback?: Feedback;
77
- id: string;
78
- /** Unique identifier of user which created the interaction. */
79
- ownerId: string;
80
- /** Indicator the system marked request as suspicious. */
81
- rejected?: boolean;
82
- /** Interaction request content. */
83
- request: string;
84
- /** Interaction response content. */
85
- response: string;
86
- /** List of sources used to generate AI messages (interactions). */
87
- sources: MessageSource[];
88
- /** ID of the thread to which the interaction belongs. */
89
- threadId: string;
90
- /** Datetime when the interaction was updated. */
91
- readonly updatedAt: string;
92
- };
93
- /**
94
- * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
95
- */
96
- type JSONPatch = {
97
- /** The operation to be performed. */
98
- op: "replace" | "add";
99
- /** A JSON Pointer. */
100
- path: string;
101
- /** The value to be used for this operation. */
102
- value: string | number | boolean;
103
- };
104
- /**
105
- * An array of JSON Patch documents.
106
- * @example
107
- * [
108
- * {
109
- * op: "replace",
110
- * path: "/name",
111
- * value: "new name"
112
- * },
113
- * {
114
- * op: "replace",
115
- * path: "/description",
116
- * value: "new description"
117
- * },
118
- * {
119
- * op: "add",
120
- * path: "/defaultPromptType",
121
- * value: "thread"
122
- * },
123
- * {
124
- * path: "/avatar"
125
- * },
126
- * {
127
- * op: "add",
128
- * path: "/avatar",
129
- * value: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="
130
- * },
131
- * {
132
- * op: "replace",
133
- * path: "/avatar",
134
- * value: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="
135
- * }
136
- * ]
137
- */
138
- type JSONPatchArray = JSONPatch[];
139
- type Message = {
140
- /** Message content. */
141
- content: string;
142
- /** Datetime when the interaction was created. */
143
- readonly createdAt: string;
144
- id: string;
145
- /** human or ai role. */
146
- role: string;
147
- /** List of sources used to generate AI messages (interactions). */
148
- sources: MessageSource[];
149
- };
150
- type MessageSource = {
151
- /** List of Chunks used for "AI" generated messages. */
152
- chunks: MessageSourceChunk[];
153
- /** Reference to DataSource used for "AI" generated messages. */
154
- datasourceId: string;
155
- /** Reference to Document used for "AI" generated messages. */
156
- documentId: string;
157
- /** Reference to KnowledgeBase used for "AI" generated messages. */
158
- knowledgebaseId: string;
159
- /** Datetime when the knowledgebase was last indexed. */
160
- lastIndexedAt?: string;
161
- /** Path to the document used. */
162
- source: string;
163
- };
164
- type MessageSourceChunk = {
165
- /** Chunk unique identifier for "AI" generated message source. */
166
- chunkId: string;
167
- /** Chunk text for "AI" generated message source. */
168
- text?: string;
169
- };
170
- type Starter = {
171
- /** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */
172
- additionalContext: string;
173
- /** Datetime when the starter was created. */
174
- readonly createdAt: string;
175
- /** List of followups. */
176
- followups?: Followup[];
177
- /** Unique identifier of the starter. */
178
- id: string;
179
- /** Starter sample question. */
180
- question: string;
181
- recommendedAnswer: RecommendedAnswer;
182
- /** Datetime when the starter was updated. */
183
- readonly updatedAt: string;
184
- };
185
- type Thread = {
186
- /** Datetime when the thread was created. */
187
- readonly createdAt: string;
188
- /** Datetime when the thread was deleted. */
189
- readonly deletedAt?: string;
190
- /** If thread is marked as favorite. */
191
- favorite: boolean;
192
- /** If feedback was provided for a thread interaction. */
193
- hasFeedback: boolean;
194
- /** Unique identifier of the thread. */
195
- id: string;
196
- /** The name of the thread. */
197
- name: string;
198
- ownerId: string;
199
- summaryStats: FeedbackSummary;
200
- /** Datetime when the thread was updated. */
201
- readonly updatedAt: string;
202
- };
203
- type ThreadWithMessages = {
204
- /** Datetime when the thread was created. */
205
- readonly createdAt: string;
206
- /** Datetime when the thread was deleted. */
207
- readonly deletedAt?: string;
208
- /** If thread is marked as favorite. */
209
- favorite: boolean;
210
- /** If feedback was provided for a thread interaction. */
211
- hasFeedback: boolean;
212
- /** Unique identifier of the thread. */
213
- id: string;
214
- messages: Message[];
215
- /** The name of the thread. */
216
- name: string;
217
- /** Unique identifier of the thread owner. */
218
- ownerId: string;
219
- summaryStats: FeedbackSummary;
220
- /** Datetime when the thread was updated. */
221
- readonly updatedAt: string;
222
- };
223
- type AssistantsResult = {
224
- data: Assistant[];
225
- links?: PageLinks;
226
- meta?: ResultMeta;
227
- };
228
- type Chunk = {
229
- /** Metadata about the chunk */
230
- chunkMeta: KbChunkMeta;
231
- /** search method for the chunk, e.g. `semantic search`, `keyword search` or `semantic and keyword search` */
232
- searchSource?: string;
233
- /** Similarity score from embedding match */
234
- semanticScore?: number;
235
- /** Text content of the chunk */
236
- text: string;
237
- /** Score from keyword search */
238
- tfidfScore?: number;
239
- };
240
- type CreateAssistant = {
241
- /** freeform JSON to allow custom customization options. */
242
- customProperties: unknown;
243
- /** Default prompt type for the assistant. */
244
- defaultPromptType?: "thread" | "oneshot";
245
- /** The description of the assistant. */
246
- description: string;
247
- /** List of knowledgebases the assistant is using. */
248
- knowledgeBases: string[];
249
- /** The name of the assistant. */
250
- name: string;
251
- /** List of starter IDs in the order they will be sorted. */
252
- orderedStarterIds?: string[];
253
- /** Unique identifier of the space to contain the assistant. */
254
- spaceId: string;
255
- /** @deprecated
256
- * System prompt setting up conversation context. */
257
- systemMessage?: string;
258
- /** The list of tags for the assistant. */
259
- tags: string[];
260
- /** The title of the assistant. */
261
- title: string;
262
- /** Initial message in the chat conversation. */
263
- welcomeMessage: string;
264
- };
265
- type CreateAssistantWithAvatar = {
266
- /** user uploaded avatar, filetype must be png */
267
- avatar?: string;
268
- /** freeform JSON to allow custom customization options. */
269
- customProperties: unknown;
270
- /** Default prompt type for the assistant. */
271
- defaultPromptType?: "thread" | "oneshot";
272
- /** The description of the assistant. */
273
- description: string;
274
- /** List of knowledgebases the assistant is using. */
275
- knowledgeBases: string[];
276
- /** The name of the assistant. */
277
- name: string;
278
- /** Unique identifier of the space to contain the assistant. */
279
- spaceId: string;
280
- /** @deprecated
281
- * System prompt setting up conversation context. */
282
- systemMessage?: string;
283
- /** The list of tags for the assistant. */
284
- tags: string[];
285
- /** The title of the assistant. */
286
- title: string;
287
- /** Initial message in the chat conversation. */
288
- welcomeMessage: string;
289
- };
290
- type CreateFeedback = {
291
- /** Optional comment for feedback. */
292
- comment?: string;
293
- /** Reason for feedback. */
294
- reason: string;
295
- /** Integer representation of feedback given (-1 = negative, 1 = positive). */
296
- vote: number;
297
- };
298
- type CreateInteraction = {
299
- /** Indicator the system marked request as suspicious. */
300
- rejected?: boolean;
301
- /** Rejection reason for a question:
302
- * * 1 - PROMPT_INJECTION
303
- * * 2 - OUT_OF_CONTEXT
304
- * * 3 - TOO_COMPLEX */
305
- rejectionReason?: RejectionReason;
306
- /** Interaction request content. */
307
- request: string;
308
- /** Interaction response content. */
309
- response: string;
310
- /** List of sources used to generate AI messages (interactions). */
311
- sources: MessageSource[];
312
- };
313
- type CreateReview = {
314
- /** Review status. */
315
- reviewStatus: string;
316
- };
317
- type CreateStarter = {
318
- /** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */
319
- additionalContext?: string;
320
- /** List of followups. */
321
- followups?: Followup[];
322
- /** Starter sample question. */
323
- question: string;
324
- recommendedAnswer?: RecommendedAnswer;
325
- };
326
- type CreateThread = {
327
- /** Datetime when the thread was created. */
328
- readonly createdAt?: string;
329
- /** The name of the thread. */
330
- name: string;
331
- /** Datetime when the thread was updated. */
332
- readonly updatedAt?: string;
333
- };
334
- type ErrorResponse = {
335
- errors?: ErrorResponseCode[];
336
- traceId?: string;
337
- };
338
- type ErrorResponseCode = {
339
- /** Custom error codes
340
- * * AE-1 - Internal processing error
341
- * * AE-2 - Incorrect request
342
- * * AE-3 - Authentication issue
343
- * * AE-4 - Prompt is rejected
344
- * * AE-5 - Resource is not found
345
- * * AE-6 - API usage rate limit is exceeded
346
- * * AE-7 - Method is not allowed */
347
- code?: string;
348
- detail?: string;
349
- title?: string;
350
- };
351
- type ErrorResponseCodeCopy = {
352
- code?: string;
353
- detail?: string;
354
- title?: string;
355
- };
356
- type ErrorResponseCopy = {
357
- errors?: ErrorResponseCodeCopy[];
358
- traceId?: string;
359
- };
360
- /**
361
- * An array of JSON Patch documents.
362
- * @example
363
- * [
364
- * {
365
- * op: "replace",
366
- * path: "/reason",
367
- * value: "irrelevant"
368
- * }
369
- * ]
370
- */
371
- type FeedbackPatchArray = JSONPatch[];
372
- type FeedbackSummary = {
373
- /** Amount of dislikes for a thread or an assistant. */
374
- dislikes: number;
375
- /** Count of answers which users marked as "inaccurate". */
376
- inaccurate?: number;
377
- /** Amount of interactions for a thread or an assistant. */
378
- interactions: number;
379
- /** Count of answers which users marked as "irrelevant". */
380
- irrelevant?: number;
381
- /** Amount of likes for a thread or an assistant. */
382
- likes: number;
383
- /** Count of answers which users disliked and gave "other" as reason. */
384
- other?: number;
385
- /** Count of answers which users marked as "repetitive". */
386
- repetitive?: number;
387
- /** Amount of reviews for a thread or an assistant. */
388
- reviews: number;
389
- /** Count of questions for which the assistant provided no answer. */
390
- unanswered?: number;
391
- /** Count of answers which users marked as "unhelpful". */
392
- unhelpful?: number;
393
- };
394
- type Followup = {
395
- /** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */
396
- additionalContext: string;
397
- /** Unique identifier of the Followup. */
398
- id: string;
399
- /** Starter sample question. */
400
- question: string;
401
- recommendedAnswer: RecommendedAnswer;
402
- };
403
- type InteractionsResult = {
404
- data: Interaction[];
405
- links?: PageLinks;
406
- meta?: ResultMeta;
407
- };
408
- /**
409
- * Metadata about the chunk
410
- */
411
- type KbChunkMeta = {
412
- /** chunkId */
413
- chunkId: string;
414
- /** datasourceId of chunk */
415
- datasourceId: string;
416
- /** documentId of chunk */
417
- documentId: string;
418
- /** knowledgeBaseId of chunk */
419
- knowledgeBaseId: string;
420
- /** source of chunk */
421
- source: string;
422
- };
423
- type PageLink = {
424
- href?: string;
425
- };
426
- type PageLinks = {
427
- next?: PageLink;
428
- prev?: PageLink;
429
- self?: PageLink;
430
- };
431
- type PromptInput = {
432
- input?: {
433
- /** Returns text from chunks in sources output. Default value is false. */
434
- includeText?: boolean;
435
- /** Input prompt string for the Assistant to respond to. */
436
- prompt?: string;
437
- /** Sets the prompt type to thread. */
438
- promptType?: "thread";
439
- };
440
- };
441
- type PromptOutput = {
442
- /** Assistant's response to the prompt */
443
- output?: string;
444
- /** List of sources used to generate AI messages */
445
- sources?: Source[];
446
- };
447
- type PromptOutputInvoke = {
448
- /** Assistant's response to the prompt */
449
- output?: string;
450
- /** Question asked by the user for assistant to answer */
451
- question?: string;
452
- /** List of sources used to generate AI messages */
453
- sources?: Source[];
454
- };
455
- type RecommendedAnswer = {
456
- /** Starter answer content. */
457
- content: string;
458
- /** Answer type of content. */
459
- contentType: string;
460
- };
461
- /**
462
- * Rejection reason for a question:
463
- * * 1 - PROMPT_INJECTION
464
- * * 2 - OUT_OF_CONTEXT
465
- * * 3 - TOO_COMPLEX
466
- * @example
467
- * 1
468
- */
469
- type RejectionReason = 1 | 2 | 3;
470
- type ResultMeta = {
471
- countTotal?: number;
472
- };
473
- type SearchRequest = {
474
- /** Query text or question to search. */
475
- prompt: string;
476
- /** Search mode to use. Allowed values: `SIMPLE` and `FULL`. Default: `SIMPLE`. */
477
- searchMode?: "SIMPLE" | "FULL";
478
- /** Number of chunks to return in results. */
479
- topN?: number;
480
- };
481
- type SearchResponse = {
482
- /** Retrieved document chunks */
483
- chunks: Chunk[];
484
- };
485
- type Source = {
486
- /** List of Chunks used for "AI" generated messages */
487
- chunks?: unknown[];
488
- /** reference to DataSource used for "AI" generated messages */
489
- datasourceId?: string;
490
- /** reference to Document used for "AI" generated messages */
491
- documentId?: string;
492
- /** reference to KnowledgeBase used for "AI" generated messages */
493
- knowledgebaseId?: string;
494
- /** path to the document used */
495
- source?: string;
496
- };
497
- type SourcesPlaintext = {
498
- textByChunkId?: unknown;
499
- };
500
- type StartersResult = {
501
- data: Starter[];
502
- links?: PageLinks;
503
- meta?: ResultMeta;
504
- };
505
- /**
506
- * An array of JSON Patch documents.
507
- * @example
508
- * [
509
- * {
510
- * op: "replace",
511
- * path: "/name",
512
- * value: "new name"
513
- * }
514
- * ]
515
- */
516
- type ThreadPatchArray = JSONPatch[];
517
- type ThreadsResult = {
518
- data: Thread[];
519
- links?: PageLinks;
520
- meta?: ResultMeta;
521
- };
522
- /**
523
- * Retrieves the list of assistants. The result can be filtered, sorted, and paginated.
524
- *
525
- * @param query an object with query parameters
526
- * @throws GetAssistantsHttpError
527
- */
528
- declare function getAssistants(query: {
529
- /** @deprecated
530
- * Optional parameter to request total count for query. */
531
- countTotal?: boolean;
532
- /** The number of assistants to get. */
533
- limit?: number;
534
- /** Optional parameter to request the next page. */
535
- next?: string;
536
- /** Optional parameter to request the previous page. */
537
- prev?: string;
538
- /** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
539
- sort?: "NAME" | "-NAME" | "DESCRIPTION" | "-DESCRIPTION" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
540
- }, options?: ApiCallOptions): Promise<GetAssistantsHttpResponse>;
541
- type GetAssistantsHttpResponse = {
542
- data: AssistantsResult;
543
- headers: Headers;
544
- status: 200;
545
- prev?: (options?: ApiCallOptions) => Promise<GetAssistantsHttpResponse>;
546
- next?: (options?: ApiCallOptions) => Promise<GetAssistantsHttpResponse>;
547
- };
548
- type GetAssistantsHttpError = {
549
- data: ErrorResponseCopy;
550
- headers: Headers;
551
- status: 400 | 403;
552
- };
553
- /**
554
- * Creates a new assistant.
555
- *
556
- * @param body an object with the body content
557
- * @throws CreateAssistantHttpError
558
- */
559
- declare function createAssistant(body: CreateAssistant, options?: ApiCallOptions): Promise<CreateAssistantHttpResponse>;
560
- type CreateAssistantHttpResponse = {
561
- data: Assistant;
562
- headers: Headers;
563
- status: 201;
564
- };
565
- type CreateAssistantHttpError = {
566
- data: ErrorResponseCopy;
567
- headers: Headers;
568
- status: 400 | 403;
569
- };
570
- /**
571
- * 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.
572
- *
573
- * @param assistantId The ID for the Assistant of interest
574
- * @param body an object with the body content
575
- * @throws SearchAssistantHttpError
576
- */
577
- declare function searchAssistant(assistantId: string, body: SearchRequest, options?: ApiCallOptions): Promise<SearchAssistantHttpResponse>;
578
- type SearchAssistantHttpResponse = {
579
- data: SearchResponse;
580
- headers: Headers;
581
- status: 200;
582
- };
583
- type SearchAssistantHttpError = {
584
- data: ErrorResponse;
585
- headers: Headers;
586
- status: 400 | 403 | 404 | 405 | 500;
587
- };
588
- /**
589
- * Retrieves feedback summary for the assistant.
590
- *
591
- * @param assistantId The ID of the assistant from which to retrieve feedback summary.
592
- * @throws GetAssistantFeedbackHttpError
593
- */
594
- declare function getAssistantFeedback(assistantId: string, options?: ApiCallOptions): Promise<GetAssistantFeedbackHttpResponse>;
595
- type GetAssistantFeedbackHttpResponse = {
596
- data: FeedbackSummary;
597
- headers: Headers;
598
- status: 200;
599
- };
600
- type GetAssistantFeedbackHttpError = {
601
- data: ErrorResponseCopy;
602
- headers: Headers;
603
- status: 400 | 403 | 404;
604
- };
605
- /**
606
- * Perform a bulk search for the plaintext of source chunks for the assistant.
607
- *
608
- * @param assistantId The ID of the assistant in which to search for source chunks.
609
- * @param body an object with the body content
610
- * @throws GetAssistantSourcesHttpError
611
- */
612
- declare function getAssistantSources(assistantId: string, body: ChunksRefs, options?: ApiCallOptions): Promise<GetAssistantSourcesHttpResponse>;
613
- type GetAssistantSourcesHttpResponse = {
614
- data: SourcesPlaintext;
615
- headers: Headers;
616
- status: 202;
617
- };
618
- type GetAssistantSourcesHttpError = {
619
- data: ErrorResponseCopy;
620
- headers: Headers;
621
- status: 400 | 403 | 404;
622
- };
623
- /**
624
- * Retrieves the list of starters for the assistant.
625
- *
626
- * @param assistantId The ID of the assistant from which to retrieve starters.
627
- * @param query an object with query parameters
628
- * @throws GetAssistantStartersHttpError
629
- */
630
- declare function getAssistantStarters(assistantId: string, query: {
631
- /** The number of starters to get. */
632
- limit?: number;
633
- /** Optional parameter to request the next page. */
634
- next?: string;
635
- /** Optional parameter to request the previous page. */
636
- prev?: string;
637
- /** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
638
- sort?: "QUESTION" | "-QUESTION" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
639
- }, options?: ApiCallOptions): Promise<GetAssistantStartersHttpResponse>;
640
- type GetAssistantStartersHttpResponse = {
641
- data: StartersResult;
642
- headers: Headers;
643
- status: 200;
644
- prev?: (options?: ApiCallOptions) => Promise<GetAssistantStartersHttpResponse>;
645
- next?: (options?: ApiCallOptions) => Promise<GetAssistantStartersHttpResponse>;
646
- };
647
- type GetAssistantStartersHttpError = {
648
- data: ErrorResponseCopy;
649
- headers: Headers;
650
- status: 400 | 403 | 404;
651
- };
652
- /**
653
- * Creates a new starter for the assistant.
654
- *
655
- * @param assistantId The ID of the assistant in which to create the starter.
656
- * @param body an object with the body content
657
- * @throws CreateAssistantStarterHttpError
658
- */
659
- declare function createAssistantStarter(assistantId: string, body: CreateStarter, options?: ApiCallOptions): Promise<CreateAssistantStarterHttpResponse>;
660
- type CreateAssistantStarterHttpResponse = {
661
- data: Starter;
662
- headers: Headers;
663
- status: 201;
664
- };
665
- type CreateAssistantStarterHttpError = {
666
- data: ErrorResponseCopy;
667
- headers: Headers;
668
- status: 400 | 403 | 404;
669
- };
670
- /**
671
- * Deletes the starter and all of its resources.
672
- *
673
- * @param assistantId The ID of the assistant containing the requested starter.
674
- * @param starterId The ID of the starter to delete.
675
- * @throws DeleteAssistantStarterHttpError
676
- */
677
- declare function deleteAssistantStarter(assistantId: string, starterId: string, options?: ApiCallOptions): Promise<DeleteAssistantStarterHttpResponse>;
678
- type DeleteAssistantStarterHttpResponse = {
679
- data: void;
680
- headers: Headers;
681
- status: 204;
682
- };
683
- type DeleteAssistantStarterHttpError = {
684
- data: ErrorResponseCopy;
685
- headers: Headers;
686
- status: 400 | 403 | 404;
687
- };
688
- /**
689
- * Retrieves the specified starter.
690
- *
691
- * @param assistantId The ID of the assistant containing the requested starter.
692
- * @param starterId The ID of the starter to retrieve.
693
- * @throws GetAssistantStarterHttpError
694
- */
695
- declare function getAssistantStarter(assistantId: string, starterId: string, options?: ApiCallOptions): Promise<GetAssistantStarterHttpResponse>;
696
- type GetAssistantStarterHttpResponse = {
697
- data: Starter;
698
- headers: Headers;
699
- status: 200;
700
- };
701
- type GetAssistantStarterHttpError = {
702
- data: ErrorResponseCopy;
703
- headers: Headers;
704
- status: 400 | 403 | 404;
705
- };
706
- /**
707
- * Updates the specified starter.
708
- *
709
- * @param assistantId The ID of the assistant containing the requested starter.
710
- * @param starterId The ID of the starter to retrieve.
711
- * @param body an object with the body content
712
- * @throws UpdateAssistantStarterHttpError
713
- */
714
- declare function updateAssistantStarter(assistantId: string, starterId: string, body: Starter, options?: ApiCallOptions): Promise<UpdateAssistantStarterHttpResponse>;
715
- type UpdateAssistantStarterHttpResponse = {
716
- data: Starter;
717
- headers: Headers;
718
- status: 200;
719
- };
720
- type UpdateAssistantStarterHttpError = {
721
- data: ErrorResponseCopy;
722
- headers: Headers;
723
- status: 400 | 403 | 404;
724
- };
725
- /**
726
- * Deletes the specified Followup.
727
- *
728
- * @param assistantId The ID of the assistant containing the requested Followup.
729
- * @param starterId The ID of the starter containing the requested Followup.
730
- * @param followupId The ID of the Followup to delete.
731
- * @throws DeleteAssistantStarterFollowupHttpError
732
- */
733
- declare function deleteAssistantStarterFollowup(assistantId: string, starterId: string, followupId: string, options?: ApiCallOptions): Promise<DeleteAssistantStarterFollowupHttpResponse>;
734
- type DeleteAssistantStarterFollowupHttpResponse = {
735
- data: void;
736
- headers: Headers;
737
- status: 204;
738
- };
739
- type DeleteAssistantStarterFollowupHttpError = {
740
- data: ErrorResponseCopy;
741
- headers: Headers;
742
- status: 400 | 403 | 404;
743
- };
744
- /**
745
- * Updates the specified Followup.
746
- *
747
- * @param assistantId The ID of the assistant containing the requested Followup.
748
- * @param starterId The ID of the starter containing the requested Followup.
749
- * @param followupId The ID of the Followup to update.
750
- * @param body an object with the body content
751
- * @throws UpdateAssistantStarterFollowupHttpError
752
- */
753
- declare function updateAssistantStarterFollowup(assistantId: string, starterId: string, followupId: string, body: Followup, options?: ApiCallOptions): Promise<UpdateAssistantStarterFollowupHttpResponse>;
754
- type UpdateAssistantStarterFollowupHttpResponse = {
755
- data: Starter;
756
- headers: Headers;
757
- status: 200;
758
- };
759
- type UpdateAssistantStarterFollowupHttpError = {
760
- data: ErrorResponseCopy;
761
- headers: Headers;
762
- status: 400 | 403 | 404;
763
- };
764
- /**
765
- * Retrieves the list of threads for the assistant.
766
- *
767
- * @param assistantId The ID of the assistant from which to retrieve threads.
768
- * @param query an object with query parameters
769
- * @throws GetAssistantThreadsHttpError
770
- */
771
- declare function getAssistantThreads(assistantId: string, query: {
772
- /** Optional parameter to filter threads. */
773
- filter?: string;
774
- /** The number of assistants to get. */
775
- limit?: number;
776
- /** Optional parameter to request the next page. */
777
- next?: string;
778
- /** Optional parameter to request the previous page. */
779
- prev?: string;
780
- /** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
781
- sort?: "NAME" | "-NAME" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
782
- }, options?: ApiCallOptions): Promise<GetAssistantThreadsHttpResponse>;
783
- type GetAssistantThreadsHttpResponse = {
784
- data: ThreadsResult;
785
- headers: Headers;
786
- status: 200;
787
- prev?: (options?: ApiCallOptions) => Promise<GetAssistantThreadsHttpResponse>;
788
- next?: (options?: ApiCallOptions) => Promise<GetAssistantThreadsHttpResponse>;
789
- };
790
- type GetAssistantThreadsHttpError = {
791
- data: ErrorResponseCopy;
792
- headers: Headers;
793
- status: 400 | 403 | 404;
794
- };
795
- /**
796
- * Creates a new thread for the assistant.
797
- *
798
- * @param assistantId The ID of the assistant in which to create the thread.
799
- * @param body an object with the body content
800
- * @throws CreateAssistantThreadHttpError
801
- */
802
- declare function createAssistantThread(assistantId: string, body: CreateThread, options?: ApiCallOptions): Promise<CreateAssistantThreadHttpResponse>;
803
- type CreateAssistantThreadHttpResponse = {
804
- data: Thread;
805
- headers: Headers;
806
- status: 201;
807
- };
808
- type CreateAssistantThreadHttpError = {
809
- data: ErrorResponseCopy;
810
- headers: Headers;
811
- status: 400 | 403 | 404;
812
- };
813
- /**
814
- * Execute prompt in synchronous non-streaming mode.
815
- *
816
- * @param assistantId The ID of the Assistant containing requested Thread
817
- * @param threadId The ID of the Thread to retrieve
818
- * @param body an object with the body content
819
- * @throws InvokeAssistantThreadHttpError
820
- */
821
- declare function invokeAssistantThread(assistantId: string, threadId: string, body: PromptInput, options?: ApiCallOptions): Promise<InvokeAssistantThreadHttpResponse>;
822
- type InvokeAssistantThreadHttpResponse = {
823
- data: PromptOutputInvoke;
824
- headers: Headers;
825
- status: 200;
826
- };
827
- type InvokeAssistantThreadHttpError = {
828
- data: ErrorResponse;
829
- headers: Headers;
830
- status: 400 | 403 | 404 | 500;
831
- };
832
- /**
833
- * Execute prompt in asynchronous streaming mode.
834
- *
835
- * @param assistantId The ID of the Assistant containing requested Thread
836
- * @param threadId The ID of the Thread to retrieve
837
- * @param body an object with the body content
838
- * @throws StreamAssistantThreadHttpError
839
- */
840
- declare function streamAssistantThread(assistantId: string, threadId: string, body: PromptInput, options?: ApiCallOptions): Promise<StreamAssistantThreadHttpResponse>;
841
- type StreamAssistantThreadHttpResponse = {
842
- data: PromptOutput;
843
- headers: Headers;
844
- status: 200;
845
- };
846
- type StreamAssistantThreadHttpError = {
847
- data: ErrorResponse;
848
- headers: Headers;
849
- status: 400 | 403 | 404 | 405 | 500;
850
- };
851
- /**
852
- * Retrieves the list of interactions for the thread.
853
- *
854
- * @param assistantId The ID of the assistant from which to retrieve the interactions.
855
- * @param threadId The ID of the thread from which to retrieve the interactions.
856
- * @param query an object with query parameters
857
- * @throws GetAssistantThreadInteractionsHttpError
858
- */
859
- declare function getAssistantThreadInteractions(assistantId: string, threadId: string, query: {
860
- /** The number of feedback to get. */
861
- limit?: number;
862
- /** Optional parameter to request the next page. */
863
- next?: string;
864
- /** Optional parameter to request the previous page. */
865
- prev?: string;
866
- /** Optional resource field name to sort on, case insensitive, e.g. `created`. Can be prefixed with `-` to set descending order; defaults to ascending. */
867
- sort?: "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
868
- }, options?: ApiCallOptions): Promise<GetAssistantThreadInteractionsHttpResponse>;
869
- type GetAssistantThreadInteractionsHttpResponse = {
870
- data: InteractionsResult;
871
- headers: Headers;
872
- status: 200;
873
- prev?: (options?: ApiCallOptions) => Promise<GetAssistantThreadInteractionsHttpResponse>;
874
- next?: (options?: ApiCallOptions) => Promise<GetAssistantThreadInteractionsHttpResponse>;
875
- };
876
- type GetAssistantThreadInteractionsHttpError = {
877
- data: ErrorResponseCopy;
878
- headers: Headers;
879
- status: 400 | 403 | 404;
880
- };
881
- /**
882
- * Creates a new interaction for the thread.
883
- *
884
- * @param assistantId The ID of the assistant in which to create the interaction.
885
- * @param threadId The ID of the thread in which to create the interaction.
886
- * @param body an object with the body content
887
- * @throws CreateAssistantThreadInteractionHttpError
888
- */
889
- declare function createAssistantThreadInteraction(assistantId: string, threadId: string, body: CreateInteraction, options?: ApiCallOptions): Promise<CreateAssistantThreadInteractionHttpResponse>;
890
- type CreateAssistantThreadInteractionHttpResponse = {
891
- data: Interaction;
892
- headers: Headers;
893
- status: 201;
894
- };
895
- type CreateAssistantThreadInteractionHttpError = {
896
- data: ErrorResponseCopy;
897
- headers: Headers;
898
- status: 400 | 403 | 404;
899
- };
900
- /**
901
- * Deletes the specified interaction and all of its resources.
902
- *
903
- * @param assistantId The ID of the assistant in which to delete the interaction.
904
- * @param threadId The ID of the thread in which to delete the interaction.
905
- * @param interactionId The ID of the interaction to delete.
906
- * @throws DeleteAssistantThreadInteractionHttpError
907
- */
908
- declare function deleteAssistantThreadInteraction(assistantId: string, threadId: string, interactionId: string, options?: ApiCallOptions): Promise<DeleteAssistantThreadInteractionHttpResponse>;
909
- type DeleteAssistantThreadInteractionHttpResponse = {
910
- data: void;
911
- headers: Headers;
912
- status: 204;
913
- };
914
- type DeleteAssistantThreadInteractionHttpError = {
915
- data: ErrorResponseCopy;
916
- headers: Headers;
917
- status: 400 | 403 | 404;
918
- };
919
- /**
920
- * Retrieves an interaction for the thread.
921
- *
922
- * @param assistantId The ID of the assistant in which to retrieve the interaction.
923
- * @param threadId The ID of the thread in which to retrieve the interaction.
924
- * @param interactionId The ID of the interaction to retrieve.
925
- * @throws GetAssistantThreadInteractionHttpError
926
- */
927
- declare function getAssistantThreadInteraction(assistantId: string, threadId: string, interactionId: string, options?: ApiCallOptions): Promise<GetAssistantThreadInteractionHttpResponse>;
928
- type GetAssistantThreadInteractionHttpResponse = {
929
- data: Interaction;
930
- headers: Headers;
931
- status: 200;
932
- };
933
- type GetAssistantThreadInteractionHttpError = {
934
- data: ErrorResponseCopy;
935
- headers: Headers;
936
- status: 400 | 403 | 404;
937
- };
938
- /**
939
- * Creates feedback for the thread.
940
- *
941
- * @param assistantId The ID of the assistant in which to create the feedback.
942
- * @param threadId The ID of the thread in which to create the feedback.
943
- * @param interactionId The ID of the interaction in which to create the feedback.
944
- * @param body an object with the body content
945
- * @throws CreateAssistantThreadInteractionFeedbackHttpError
946
- */
947
- declare function createAssistantThreadInteractionFeedback(assistantId: string, threadId: string, interactionId: string, body: CreateFeedback, options?: ApiCallOptions): Promise<CreateAssistantThreadInteractionFeedbackHttpResponse>;
948
- type CreateAssistantThreadInteractionFeedbackHttpResponse = {
949
- data: Interaction;
950
- headers: Headers;
951
- status: 201;
952
- };
953
- type CreateAssistantThreadInteractionFeedbackHttpError = {
954
- data: ErrorResponseCopy;
955
- headers: Headers;
956
- status: 400 | 403 | 404;
957
- };
958
- /**
959
- * Updates feedback for the thread.
960
- *
961
- * @param assistantId The ID of the assistant containing the requested feedback.
962
- * @param threadId The ID of the thread containing the requested feedback.
963
- * @param interactionId The ID of the interaction containing the requested Feedback.
964
- * @param feedbackId The ID of the feedback to update.
965
- * @param body an object with the body content
966
- * @throws PatchAssistantThreadInteractionFeedbackHttpError
967
- */
968
- declare function patchAssistantThreadInteractionFeedback(assistantId: string, threadId: string, interactionId: string, feedbackId: string, body: FeedbackPatchArray, options?: ApiCallOptions): Promise<PatchAssistantThreadInteractionFeedbackHttpResponse>;
969
- type PatchAssistantThreadInteractionFeedbackHttpResponse = {
970
- data: void;
971
- headers: Headers;
972
- status: 204;
973
- };
974
- type PatchAssistantThreadInteractionFeedbackHttpError = {
975
- data: ErrorResponseCopy;
976
- headers: Headers;
977
- status: 400 | 403 | 404;
978
- };
979
- /**
980
- * Creates feedback review for the thread.
981
- *
982
- * @param assistantId The ID of the assistant in which to create the feedback review.
983
- * @param threadId The ID of the thread in which to create the feedback review.
984
- * @param interactionId The ID of the interaction in which to create the feedback review.
985
- * @param body an object with the body content
986
- * @throws CreateAssistantThreadInteractionReviewHttpError
987
- */
988
- declare function createAssistantThreadInteractionReview(assistantId: string, threadId: string, interactionId: string, body: CreateReview, options?: ApiCallOptions): Promise<CreateAssistantThreadInteractionReviewHttpResponse>;
989
- type CreateAssistantThreadInteractionReviewHttpResponse = {
990
- data: Interaction;
991
- headers: Headers;
992
- status: 201;
993
- };
994
- type CreateAssistantThreadInteractionReviewHttpError = {
995
- data: ErrorResponseCopy;
996
- headers: Headers;
997
- status: 400 | 403 | 404;
998
- };
999
- /**
1000
- * Deletes the specified thread and all of its resources.
1001
- *
1002
- * @param assistantid The ID of the assistant containing the requested thread.
1003
- * @param threadid The ID of the thread to retrieve.
1004
- * @throws DeleteAssistantThreadHttpError
1005
- */
1006
- declare function deleteAssistantThread(assistantid: string, threadid: string, options?: ApiCallOptions): Promise<DeleteAssistantThreadHttpResponse>;
1007
- type DeleteAssistantThreadHttpResponse = {
1008
- data: void;
1009
- headers: Headers;
1010
- status: 204;
1011
- };
1012
- type DeleteAssistantThreadHttpError = {
1013
- data: ErrorResponseCopy;
1014
- headers: Headers;
1015
- status: 400 | 403 | 404;
1016
- };
1017
- /**
1018
- * Retrieves a thread for the assistant.
1019
- *
1020
- * @param assistantid The ID of the assistant containing the requested thread.
1021
- * @param threadid The ID of the thread to retrieve.
1022
- * @throws GetAssistantThreadHttpError
1023
- */
1024
- declare function getAssistantThread(assistantid: string, threadid: string, options?: ApiCallOptions): Promise<GetAssistantThreadHttpResponse>;
1025
- type GetAssistantThreadHttpResponse = {
1026
- data: ThreadWithMessages;
1027
- headers: Headers;
1028
- status: 200;
1029
- };
1030
- type GetAssistantThreadHttpError = {
1031
- data: ErrorResponseCopy;
1032
- headers: Headers;
1033
- status: 400 | 403 | 404;
1034
- };
1035
- /**
1036
- * Updates the properties of an existing thread with JSON Patch-formatted data.
1037
- *
1038
- * @param assistantid The ID of the assistant containing the requested thread.
1039
- * @param threadid The ID of the thread to retrieve.
1040
- * @param body an object with the body content
1041
- * @throws PatchAssistantThreadHttpError
1042
- */
1043
- declare function patchAssistantThread(assistantid: string, threadid: string, body: ThreadPatchArray, options?: ApiCallOptions): Promise<PatchAssistantThreadHttpResponse>;
1044
- type PatchAssistantThreadHttpResponse = {
1045
- data: void;
1046
- headers: Headers;
1047
- status: 204;
1048
- };
1049
- type PatchAssistantThreadHttpError = {
1050
- data: ErrorResponseCopy;
1051
- headers: Headers;
1052
- status: 400 | 401 | 403 | 404 | 429;
1053
- };
1054
- /**
1055
- * Deletes the assistant and all of its resources.
1056
- *
1057
- * @param id The ID of the assistant to delete.
1058
- * @throws DeleteAssistantHttpError
1059
- */
1060
- declare function deleteAssistant(id: string, options?: ApiCallOptions): Promise<DeleteAssistantHttpResponse>;
1061
- type DeleteAssistantHttpResponse = {
1062
- data: void;
1063
- headers: Headers;
1064
- status: 204;
1065
- };
1066
- type DeleteAssistantHttpError = {
1067
- data: ErrorResponseCopy;
1068
- headers: Headers;
1069
- status: 400 | 403 | 404;
1070
- };
1071
- /**
1072
- * Retrieves the specified assistant.
1073
- *
1074
- * @param id The ID of the assistant to retrieve.
1075
- * @throws GetAssistantHttpError
1076
- */
1077
- declare function getAssistant(id: string, options?: ApiCallOptions): Promise<GetAssistantHttpResponse>;
1078
- type GetAssistantHttpResponse = {
1079
- data: Assistant;
1080
- headers: Headers;
1081
- status: 200;
1082
- };
1083
- type GetAssistantHttpError = {
1084
- data: ErrorResponseCopy;
1085
- headers: Headers;
1086
- status: 400 | 403 | 404;
1087
- };
1088
- /**
1089
- * Updates the properties of an existing assistant with JSON Patch-formatted data.
1090
- *
1091
- * @param id The assistant ID.
1092
- * @param body an object with the body content
1093
- * @throws PatchAssistantHttpError
1094
- */
1095
- declare function patchAssistant(id: string, body: JSONPatchArray, options?: ApiCallOptions): Promise<PatchAssistantHttpResponse>;
1096
- type PatchAssistantHttpResponse = {
1097
- data: void;
1098
- headers: Headers;
1099
- status: 204;
1100
- };
1101
- type PatchAssistantHttpError = {
1102
- data: ErrorResponseCopy;
1103
- headers: Headers;
1104
- status: 400 | 401 | 403 | 404 | 429;
1105
- };
1106
- /**
1107
- * Clears the cache for assistants api requests.
1108
- */
1109
- declare function clearCache(): void;
1110
- type AssistantsAPI = {
1111
- /**
1112
- * Retrieves the list of assistants. The result can be filtered, sorted, and paginated.
1113
- *
1114
- * @param query an object with query parameters
1115
- * @throws GetAssistantsHttpError
1116
- */
1117
- getAssistants: typeof getAssistants;
1118
- /**
1119
- * Creates a new assistant.
1120
- *
1121
- * @param body an object with the body content
1122
- * @throws CreateAssistantHttpError
1123
- */
1124
- createAssistant: typeof createAssistant;
1125
- /**
1126
- * 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.
1127
- *
1128
- * @param assistantId The ID for the Assistant of interest
1129
- * @param body an object with the body content
1130
- * @throws SearchAssistantHttpError
1131
- */
1132
- searchAssistant: typeof searchAssistant;
1133
- /**
1134
- * Retrieves feedback summary for the assistant.
1135
- *
1136
- * @param assistantId The ID of the assistant from which to retrieve feedback summary.
1137
- * @throws GetAssistantFeedbackHttpError
1138
- */
1139
- getAssistantFeedback: typeof getAssistantFeedback;
1140
- /**
1141
- * Perform a bulk search for the plaintext of source chunks for the assistant.
1142
- *
1143
- * @param assistantId The ID of the assistant in which to search for source chunks.
1144
- * @param body an object with the body content
1145
- * @throws GetAssistantSourcesHttpError
1146
- */
1147
- getAssistantSources: typeof getAssistantSources;
1148
- /**
1149
- * Retrieves the list of starters for the assistant.
1150
- *
1151
- * @param assistantId The ID of the assistant from which to retrieve starters.
1152
- * @param query an object with query parameters
1153
- * @throws GetAssistantStartersHttpError
1154
- */
1155
- getAssistantStarters: typeof getAssistantStarters;
1156
- /**
1157
- * Creates a new starter for the assistant.
1158
- *
1159
- * @param assistantId The ID of the assistant in which to create the starter.
1160
- * @param body an object with the body content
1161
- * @throws CreateAssistantStarterHttpError
1162
- */
1163
- createAssistantStarter: typeof createAssistantStarter;
1164
- /**
1165
- * Deletes the starter and all of its resources.
1166
- *
1167
- * @param assistantId The ID of the assistant containing the requested starter.
1168
- * @param starterId The ID of the starter to delete.
1169
- * @throws DeleteAssistantStarterHttpError
1170
- */
1171
- deleteAssistantStarter: typeof deleteAssistantStarter;
1172
- /**
1173
- * Retrieves the specified starter.
1174
- *
1175
- * @param assistantId The ID of the assistant containing the requested starter.
1176
- * @param starterId The ID of the starter to retrieve.
1177
- * @throws GetAssistantStarterHttpError
1178
- */
1179
- getAssistantStarter: typeof getAssistantStarter;
1180
- /**
1181
- * Updates the specified starter.
1182
- *
1183
- * @param assistantId The ID of the assistant containing the requested starter.
1184
- * @param starterId The ID of the starter to retrieve.
1185
- * @param body an object with the body content
1186
- * @throws UpdateAssistantStarterHttpError
1187
- */
1188
- updateAssistantStarter: typeof updateAssistantStarter;
1189
- /**
1190
- * Deletes the specified Followup.
1191
- *
1192
- * @param assistantId The ID of the assistant containing the requested Followup.
1193
- * @param starterId The ID of the starter containing the requested Followup.
1194
- * @param followupId The ID of the Followup to delete.
1195
- * @throws DeleteAssistantStarterFollowupHttpError
1196
- */
1197
- deleteAssistantStarterFollowup: typeof deleteAssistantStarterFollowup;
1198
- /**
1199
- * Updates the specified Followup.
1200
- *
1201
- * @param assistantId The ID of the assistant containing the requested Followup.
1202
- * @param starterId The ID of the starter containing the requested Followup.
1203
- * @param followupId The ID of the Followup to update.
1204
- * @param body an object with the body content
1205
- * @throws UpdateAssistantStarterFollowupHttpError
1206
- */
1207
- updateAssistantStarterFollowup: typeof updateAssistantStarterFollowup;
1208
- /**
1209
- * Retrieves the list of threads for the assistant.
1210
- *
1211
- * @param assistantId The ID of the assistant from which to retrieve threads.
1212
- * @param query an object with query parameters
1213
- * @throws GetAssistantThreadsHttpError
1214
- */
1215
- getAssistantThreads: typeof getAssistantThreads;
1216
- /**
1217
- * Creates a new thread for the assistant.
1218
- *
1219
- * @param assistantId The ID of the assistant in which to create the thread.
1220
- * @param body an object with the body content
1221
- * @throws CreateAssistantThreadHttpError
1222
- */
1223
- createAssistantThread: typeof createAssistantThread;
1224
- /**
1225
- * Execute prompt in synchronous non-streaming mode.
1226
- *
1227
- * @param assistantId The ID of the Assistant containing requested Thread
1228
- * @param threadId The ID of the Thread to retrieve
1229
- * @param body an object with the body content
1230
- * @throws InvokeAssistantThreadHttpError
1231
- */
1232
- invokeAssistantThread: typeof invokeAssistantThread;
1233
- /**
1234
- * Execute prompt in asynchronous streaming mode.
1235
- *
1236
- * @param assistantId The ID of the Assistant containing requested Thread
1237
- * @param threadId The ID of the Thread to retrieve
1238
- * @param body an object with the body content
1239
- * @throws StreamAssistantThreadHttpError
1240
- */
1241
- streamAssistantThread: typeof streamAssistantThread;
1242
- /**
1243
- * Retrieves the list of interactions for the thread.
1244
- *
1245
- * @param assistantId The ID of the assistant from which to retrieve the interactions.
1246
- * @param threadId The ID of the thread from which to retrieve the interactions.
1247
- * @param query an object with query parameters
1248
- * @throws GetAssistantThreadInteractionsHttpError
1249
- */
1250
- getAssistantThreadInteractions: typeof getAssistantThreadInteractions;
1251
- /**
1252
- * Creates a new interaction for the thread.
1253
- *
1254
- * @param assistantId The ID of the assistant in which to create the interaction.
1255
- * @param threadId The ID of the thread in which to create the interaction.
1256
- * @param body an object with the body content
1257
- * @throws CreateAssistantThreadInteractionHttpError
1258
- */
1259
- createAssistantThreadInteraction: typeof createAssistantThreadInteraction;
1260
- /**
1261
- * Deletes the specified interaction and all of its resources.
1262
- *
1263
- * @param assistantId The ID of the assistant in which to delete the interaction.
1264
- * @param threadId The ID of the thread in which to delete the interaction.
1265
- * @param interactionId The ID of the interaction to delete.
1266
- * @throws DeleteAssistantThreadInteractionHttpError
1267
- */
1268
- deleteAssistantThreadInteraction: typeof deleteAssistantThreadInteraction;
1269
- /**
1270
- * Retrieves an interaction for the thread.
1271
- *
1272
- * @param assistantId The ID of the assistant in which to retrieve the interaction.
1273
- * @param threadId The ID of the thread in which to retrieve the interaction.
1274
- * @param interactionId The ID of the interaction to retrieve.
1275
- * @throws GetAssistantThreadInteractionHttpError
1276
- */
1277
- getAssistantThreadInteraction: typeof getAssistantThreadInteraction;
1278
- /**
1279
- * Creates feedback for the thread.
1280
- *
1281
- * @param assistantId The ID of the assistant in which to create the feedback.
1282
- * @param threadId The ID of the thread in which to create the feedback.
1283
- * @param interactionId The ID of the interaction in which to create the feedback.
1284
- * @param body an object with the body content
1285
- * @throws CreateAssistantThreadInteractionFeedbackHttpError
1286
- */
1287
- createAssistantThreadInteractionFeedback: typeof createAssistantThreadInteractionFeedback;
1288
- /**
1289
- * Updates feedback for the thread.
1290
- *
1291
- * @param assistantId The ID of the assistant containing the requested feedback.
1292
- * @param threadId The ID of the thread containing the requested feedback.
1293
- * @param interactionId The ID of the interaction containing the requested Feedback.
1294
- * @param feedbackId The ID of the feedback to update.
1295
- * @param body an object with the body content
1296
- * @throws PatchAssistantThreadInteractionFeedbackHttpError
1297
- */
1298
- patchAssistantThreadInteractionFeedback: typeof patchAssistantThreadInteractionFeedback;
1299
- /**
1300
- * Creates feedback review for the thread.
1301
- *
1302
- * @param assistantId The ID of the assistant in which to create the feedback review.
1303
- * @param threadId The ID of the thread in which to create the feedback review.
1304
- * @param interactionId The ID of the interaction in which to create the feedback review.
1305
- * @param body an object with the body content
1306
- * @throws CreateAssistantThreadInteractionReviewHttpError
1307
- */
1308
- createAssistantThreadInteractionReview: typeof createAssistantThreadInteractionReview;
1309
- /**
1310
- * Deletes the specified thread and all of its resources.
1311
- *
1312
- * @param assistantid The ID of the assistant containing the requested thread.
1313
- * @param threadid The ID of the thread to retrieve.
1314
- * @throws DeleteAssistantThreadHttpError
1315
- */
1316
- deleteAssistantThread: typeof deleteAssistantThread;
1317
- /**
1318
- * Retrieves a thread for the assistant.
1319
- *
1320
- * @param assistantid The ID of the assistant containing the requested thread.
1321
- * @param threadid The ID of the thread to retrieve.
1322
- * @throws GetAssistantThreadHttpError
1323
- */
1324
- getAssistantThread: typeof getAssistantThread;
1325
- /**
1326
- * Updates the properties of an existing thread with JSON Patch-formatted data.
1327
- *
1328
- * @param assistantid The ID of the assistant containing the requested thread.
1329
- * @param threadid The ID of the thread to retrieve.
1330
- * @param body an object with the body content
1331
- * @throws PatchAssistantThreadHttpError
1332
- */
1333
- patchAssistantThread: typeof patchAssistantThread;
1334
- /**
1335
- * Deletes the assistant and all of its resources.
1336
- *
1337
- * @param id The ID of the assistant to delete.
1338
- * @throws DeleteAssistantHttpError
1339
- */
1340
- deleteAssistant: typeof deleteAssistant;
1341
- /**
1342
- * Retrieves the specified assistant.
1343
- *
1344
- * @param id The ID of the assistant to retrieve.
1345
- * @throws GetAssistantHttpError
1346
- */
1347
- getAssistant: typeof getAssistant;
1348
- /**
1349
- * Updates the properties of an existing assistant with JSON Patch-formatted data.
1350
- *
1351
- * @param id The assistant ID.
1352
- * @param body an object with the body content
1353
- * @throws PatchAssistantHttpError
1354
- */
1355
- patchAssistant: typeof patchAssistant;
1356
- /**
1357
- * Clears the cache for assistants api requests.
1358
- */
1359
- clearCache: typeof clearCache;
1360
- };
1361
- /**
1362
- * Functions for the assistants api
1363
- */
1364
- declare const assistantsExport: AssistantsAPI;
1365
- //#endregion
1366
- export { GetAssistantThreadHttpError as $, createAssistant as $t, DeleteAssistantStarterHttpResponse as A, RecommendedAnswer as At, FeedbackPatchArray as B, StartersResult as Bt, CreateStarter as C, patchAssistantThreadInteractionFeedback as Cn, PatchAssistantThreadHttpError as Ct, DeleteAssistantStarterFollowupHttpError as D, updateAssistantStarterFollowup as Dn, PromptInput as Dt, DeleteAssistantHttpResponse as E, updateAssistantStarter as En, PatchAssistantThreadInteractionFeedbackHttpResponse as Et, ErrorResponse as F, SearchRequest as Ft, GetAssistantHttpError as G, ThreadWithMessages as Gt, Followup as H, StreamAssistantThreadHttpResponse as Ht, ErrorResponseCode as I, SearchResponse as It, GetAssistantSourcesHttpResponse as J, UpdateAssistantStarterFollowupHttpResponse as Jt, GetAssistantHttpResponse as K, ThreadsResult as Kt, ErrorResponseCodeCopy as L, Source as Lt, DeleteAssistantThreadHttpResponse as M, ResultMeta as Mt, DeleteAssistantThreadInteractionHttpError as N, SearchAssistantHttpError as Nt, DeleteAssistantStarterFollowupHttpResponse as O, PromptOutput as Ot, DeleteAssistantThreadInteractionHttpResponse as P, SearchAssistantHttpResponse as Pt, GetAssistantStartersHttpResponse as Q, clearCache as Qt, ErrorResponseCopy as R, SourcesPlaintext as Rt, CreateReview as S, patchAssistantThread as Sn, PatchAssistantHttpResponse as St, DeleteAssistantHttpError as T, streamAssistantThread as Tn, PatchAssistantThreadInteractionFeedbackHttpError as Tt, GetAssistantFeedbackHttpError as U, Thread as Ut, FeedbackSummary as V, StreamAssistantThreadHttpError as Vt, GetAssistantFeedbackHttpResponse as W, ThreadPatchArray as Wt, GetAssistantStarterHttpResponse as X, UpdateAssistantStarterHttpResponse as Xt, GetAssistantStarterHttpError as Y, UpdateAssistantStarterHttpError as Yt, GetAssistantStartersHttpError as Z, assistantsExport as Zt, CreateAssistantThreadInteractionReviewHttpError as _, getAssistantThreadInteractions as _n, MessageSource as _t, ChunksRefs as a, deleteAssistant as an, GetAssistantThreadsHttpError as at, CreateFeedback as b, invokeAssistantThread as bn, PageLinks as bt, CreateAssistantHttpResponse as c, deleteAssistantThread as cn, GetAssistantsHttpResponse as ct, CreateAssistantThreadHttpError as d, getAssistantFeedback as dn, InvokeAssistantThreadHttpError as dt, createAssistantStarter as en, GetAssistantThreadHttpResponse as et, CreateAssistantThreadHttpResponse as f, getAssistantSources as fn, InvokeAssistantThreadHttpResponse as ft, CreateAssistantThreadInteractionHttpResponse as g, getAssistantThreadInteraction as gn, Message as gt, CreateAssistantThreadInteractionHttpError as h, getAssistantThread as hn, KbChunkMeta as ht, Chunk as i, createAssistantThreadInteractionReview as in, GetAssistantThreadInteractionsHttpResponse as it, DeleteAssistantThreadHttpError as j, RejectionReason as jt, DeleteAssistantStarterHttpError as k, PromptOutputInvoke as kt, CreateAssistantStarterHttpError as l, deleteAssistantThreadInteraction as ln, Interaction as lt, CreateAssistantThreadInteractionFeedbackHttpResponse as m, getAssistantStarters as mn, JSONPatchArray as mt, AssistantsAPI as n, createAssistantThreadInteraction as nn, GetAssistantThreadInteractionHttpResponse as nt, CreateAssistant as o, deleteAssistantStarter as on, GetAssistantThreadsHttpResponse as ot, CreateAssistantThreadInteractionFeedbackHttpError as p, getAssistantStarter as pn, JSONPatch as pt, GetAssistantSourcesHttpError as q, UpdateAssistantStarterFollowupHttpError as qt, AssistantsResult as r, createAssistantThreadInteractionFeedback as rn, GetAssistantThreadInteractionsHttpError as rt, CreateAssistantHttpError as s, deleteAssistantStarterFollowup as sn, GetAssistantsHttpError as st, Assistant as t, createAssistantThread as tn, GetAssistantThreadInteractionHttpError as tt, CreateAssistantStarterHttpResponse as u, getAssistant as un, InteractionsResult as ut, CreateAssistantThreadInteractionReviewHttpResponse as v, getAssistantThreads as vn, MessageSourceChunk as vt, CreateThread as w, searchAssistant as wn, PatchAssistantThreadHttpResponse as wt, CreateInteraction as x, patchAssistant as xn, PatchAssistantHttpError as xt, CreateAssistantWithAvatar as y, getAssistants as yn, PageLink as yt, Feedback as z, Starter as zt };