@qlik/api 2.2.0 → 2.3.1

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