@qlik/api 2.3.0 → 2.4.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 (167) hide show
  1. package/analytics/change-stores.d.ts +40 -76
  2. package/analytics/change-stores.js +9 -10
  3. package/analytics.d.ts +1 -2
  4. package/analytics.js +5 -6
  5. package/api-keys.d.ts +46 -100
  6. package/api-keys.js +3 -4
  7. package/apps.d.ts +334 -461
  8. package/apps.js +74 -6
  9. package/assistants.d.ts +172 -337
  10. package/assistants.js +3 -4
  11. package/audits.d.ts +41 -85
  12. package/audits.js +3 -4
  13. package/auth-types.d.ts +110 -1
  14. package/auth-types.js +22 -1
  15. package/auth.d.ts +1 -2
  16. package/auth.js +1 -1
  17. package/automation-connections.d.ts +44 -95
  18. package/automation-connections.js +3 -4
  19. package/automation-connectors.d.ts +10 -20
  20. package/automation-connectors.js +3 -4
  21. package/automations.d.ts +54 -112
  22. package/automations.js +3 -4
  23. package/automl-deployments.d.ts +17 -36
  24. package/automl-deployments.js +3 -4
  25. package/automl-predictions.d.ts +12 -24
  26. package/automl-predictions.js +3 -4
  27. package/banners.d.ts +8 -14
  28. package/banners.js +3 -4
  29. package/brands.d.ts +19 -39
  30. package/brands.js +3 -4
  31. package/chunks/auth-B8lJw7rm.js +31 -0
  32. package/chunks/{interceptors-DipDBQQ5.js → boot-interceptors-DqRxTczb.js} +296 -248
  33. package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
  34. package/chunks/{invoke-fetch-B7lGscuQ.js → invoke-fetch-DMAi6Fg3.js} +3 -3
  35. package/chunks/{invoke-fetch-DhdyFZ0F.js → invoke-fetch-pMN6iqup.js} +2 -3
  36. package/chunks/platform-types-CECrZkOF.d.ts +29 -0
  37. package/chunks/{public-runtime-modules-QhLPeQr5.js → public-runtime-modules-2KfyI2qM.js} +5 -5
  38. package/chunks/{qix-RCUslia8.js → qix-BdNrIA4s.js} +19 -20
  39. package/chunks/{qix-chunk-entrypoint-WAS4NVTf.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
  40. package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
  41. package/collections.d.ts +67 -144
  42. package/collections.js +3 -4
  43. package/conditions.d.ts +87 -190
  44. package/conditions.js +3 -4
  45. package/consumption.d.ts +35 -72
  46. package/consumption.js +3 -4
  47. package/core/ip-policies.d.ts +43 -93
  48. package/core/ip-policies.js +5 -6
  49. package/core.d.ts +1 -2
  50. package/core.js +5 -6
  51. package/csp-origins.d.ts +42 -85
  52. package/csp-origins.js +3 -4
  53. package/csrf-token.d.ts +6 -11
  54. package/csrf-token.js +3 -4
  55. package/data-alerts.d.ts +152 -325
  56. package/data-alerts.js +3 -4
  57. package/data-assets.d.ts +16 -31
  58. package/data-assets.js +3 -4
  59. package/data-connections.d.ts +123 -257
  60. package/data-connections.js +3 -4
  61. package/data-credentials.d.ts +36 -76
  62. package/data-credentials.js +3 -4
  63. package/data-files.d.ts +60 -121
  64. package/data-files.js +3 -4
  65. package/data-governance/data-products.d.ts +429 -0
  66. package/data-governance/data-products.js +212 -0
  67. package/data-governance.d.ts +13 -0
  68. package/data-governance.js +12 -0
  69. package/data-qualities.d.ts +11 -25
  70. package/data-qualities.js +3 -4
  71. package/data-sets.d.ts +28 -57
  72. package/data-sets.js +3 -4
  73. package/data-sources.d.ts +45 -97
  74. package/data-sources.js +3 -4
  75. package/data-stores.d.ts +53 -107
  76. package/data-stores.js +3 -4
  77. package/dcaas.d.ts +32 -67
  78. package/dcaas.js +3 -4
  79. package/di-projects.d.ts +111 -136
  80. package/di-projects.js +25 -4
  81. package/direct-access-agents.d.ts +29 -63
  82. package/direct-access-agents.js +3 -4
  83. package/encryption.d.ts +28 -59
  84. package/encryption.js +3 -4
  85. package/extensions.d.ts +35 -73
  86. package/extensions.js +3 -4
  87. package/global-types.d.ts +139 -1
  88. package/glossaries.d.ts +75 -158
  89. package/glossaries.js +3 -4
  90. package/groups.d.ts +58 -125
  91. package/groups.js +3 -4
  92. package/identity-providers.d.ts +148 -324
  93. package/identity-providers.js +3 -4
  94. package/index.d.ts +18 -4
  95. package/index.js +64 -19
  96. package/interceptors.d.ts +2 -3
  97. package/interceptors.js +104 -2
  98. package/invoke-fetch-types.d.ts +97 -1
  99. package/items.d.ts +85 -181
  100. package/items.js +3 -4
  101. package/knowledgebases.d.ts +137 -270
  102. package/knowledgebases.js +3 -4
  103. package/licenses.d.ts +71 -153
  104. package/licenses.js +3 -4
  105. package/lineage-graphs.d.ts +39 -85
  106. package/lineage-graphs.js +3 -4
  107. package/ml.d.ts +290 -621
  108. package/ml.js +3 -4
  109. package/notes.d.ts +9 -18
  110. package/notes.js +3 -4
  111. package/notifications.d.ts +14 -30
  112. package/notifications.js +3 -4
  113. package/oauth-clients.d.ts +98 -159
  114. package/oauth-clients.js +4 -5
  115. package/oauth-tokens.d.ts +16 -33
  116. package/oauth-tokens.js +3 -4
  117. package/package.json +6 -4
  118. package/qix.d.ts +46 -2
  119. package/qix.js +2 -3
  120. package/questions.d.ts +53 -110
  121. package/questions.js +3 -4
  122. package/quotas.d.ts +13 -26
  123. package/quotas.js +3 -4
  124. package/reload-tasks.d.ts +23 -46
  125. package/reload-tasks.js +3 -4
  126. package/reloads.d.ts +26 -52
  127. package/reloads.js +3 -4
  128. package/report-templates.d.ts +30 -63
  129. package/report-templates.js +3 -4
  130. package/reports.d.ts +111 -238
  131. package/reports.js +3 -4
  132. package/roles.d.ts +36 -77
  133. package/roles.js +3 -4
  134. package/sharing-tasks.d.ts +201 -427
  135. package/sharing-tasks.js +3 -4
  136. package/spaces.d.ts +71 -157
  137. package/spaces.js +3 -4
  138. package/tasks.d.ts +76 -164
  139. package/tasks.js +3 -4
  140. package/temp-contents.d.ts +17 -35
  141. package/temp-contents.js +3 -4
  142. package/tenant-settings.d.ts +298 -0
  143. package/tenant-settings.js +107 -0
  144. package/tenants.d.ts +31 -67
  145. package/tenants.js +3 -4
  146. package/themes.d.ts +27 -55
  147. package/themes.js +3 -4
  148. package/transports.d.ts +46 -106
  149. package/transports.js +3 -4
  150. package/ui-config.d.ts +8 -17
  151. package/ui-config.js +3 -4
  152. package/users.d.ts +80 -170
  153. package/users.js +3 -4
  154. package/web-integrations.d.ts +38 -83
  155. package/web-integrations.js +3 -4
  156. package/web-notifications.d.ts +14 -29
  157. package/web-notifications.js +3 -4
  158. package/webhooks.d.ts +77 -162
  159. package/webhooks.js +3 -4
  160. package/chunks/auth-BowS4SUR.js +0 -28
  161. package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
  162. package/chunks/auth-types-h43TVDpB.js +0 -24
  163. package/chunks/global-types-CEVAJebk.js +0 -1
  164. /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
  165. /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
  166. /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
  167. /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
@@ -1,16 +1,13 @@
1
- import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
- import "./chunks/invoke-fetch-C1Z0RJYU.js";
1
+ import { ApiCallOptions } from "./invoke-fetch-types.js";
2
+ import "./chunks/invoke-fetch-DFc3yzaj.js";
3
3
 
4
4
  //#region src/public/rest/knowledgebases.d.ts
5
5
  /**
6
6
  * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
7
7
  */
8
8
  type JSONPatch = {
9
- /** The operation to be performed. */
10
- op: "REPLACE";
11
- /** A JSON Pointer. */
12
- path: string;
13
- /** The value to be used for this operation. */
9
+ /** The operation to be performed. */op: "REPLACE"; /** A JSON Pointer. */
10
+ path: string; /** The value to be used for this operation. */
14
11
  value: string | number | boolean;
15
12
  };
16
13
  /**
@@ -29,27 +26,17 @@ type JSONPatch = {
29
26
  */
30
27
  type JSONPatchArray = JSONPatch[];
31
28
  type Chunk = {
32
- /** Metadata about the chunk */
33
- chunkMeta: KbChunkMeta;
34
- /** search method for the chunk, e.g. `semantic search`, `keyword search` or `semantic and keyword search` */
35
- searchSource?: string;
36
- /** Similarity score from embedding match */
37
- semanticScore?: number;
38
- /** Text content of the chunk */
39
- text: string;
40
- /** Score from keyword search */
29
+ /** Metadata about the chunk */chunkMeta: KbChunkMeta; /** search method for the chunk, e.g. `semantic search`, `keyword search` or `semantic and keyword search` */
30
+ searchSource?: string; /** Similarity score from embedding match */
31
+ semanticScore?: number; /** Text content of the chunk */
32
+ text: string; /** Score from keyword search */
41
33
  tfidfScore?: number;
42
34
  };
43
35
  type Chunking = {
44
- /** Allows to keep or remove separators used */
45
- keepSeparator: boolean;
46
- /** Chunk overlap, should be less than size */
47
- overlap: number;
48
- /** List of separators to chunk by */
49
- separators: string[];
50
- /** Size of chunks */
51
- size: number;
52
- /** Chunking strategy */
36
+ /** Allows to keep or remove separators used */keepSeparator: boolean; /** Chunk overlap, should be less than size */
37
+ overlap: number; /** List of separators to chunk by */
38
+ separators: string[]; /** Size of chunks */
39
+ size: number; /** Chunking strategy */
53
40
  type: string;
54
41
  };
55
42
  type ContentSummary = {
@@ -62,26 +49,17 @@ type ContentSummary = {
62
49
  * Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.
63
50
  */
64
51
  type CreateDataSource = {
65
- /** Configuration for webcrawling */
66
- crawlerConfig?: DataSourceCrawlConfig;
67
- /** Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided. */
68
- fileConfig?: DataSourceFileConfig;
69
- /** Name of the datasource */
52
+ /** Configuration for webcrawling */crawlerConfig?: DataSourceCrawlConfig; /** Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided. */
53
+ fileConfig?: DataSourceFileConfig; /** Name of the datasource */
70
54
  name: string;
71
55
  type: "file" | "web" | "database";
72
56
  };
73
57
  type CreateKnowledgeBase = {
74
- /** User opt in to advanced parsing and chunking pipeline. Default is false, which will run legacy parsing and chunking. */
75
- advancedIndexing?: boolean;
76
- /** Description of the knowledgebase */
77
- description?: string;
78
- /** Name of the knowledgebase */
79
- name: string;
80
- /** Number of selected errors to store in the case of any failed datasources. Optional value with a default of 10. */
81
- selectedErrorsCount?: number;
82
- /** Unique identifier of the space to contain the knowledgebase */
83
- spaceId: string;
84
- /** List of tags for knowledgebase */
58
+ /** User opt in to advanced parsing and chunking pipeline. Default is false, which will run legacy parsing and chunking. */advancedIndexing?: boolean; /** Description of the knowledgebase */
59
+ description?: string; /** Name of the knowledgebase */
60
+ name: string; /** Number of selected errors to store in the case of any failed datasources. Optional value with a default of 10. */
61
+ selectedErrorsCount?: number; /** Unique identifier of the space to contain the knowledgebase */
62
+ spaceId: string; /** List of tags for knowledgebase */
85
63
  tags?: string[];
86
64
  };
87
65
  /**
@@ -89,18 +67,12 @@ type CreateKnowledgeBase = {
89
67
  */
90
68
  type DataSource = {
91
69
  chunking?: Chunking;
92
- contentSummary: ContentSummary;
93
- /** Configuration for webcrawling */
94
- crawlerConfig?: DataSourceCrawlConfig;
95
- /** Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided. */
96
- fileConfig?: DataSourceFileConfig;
97
- /** Unique identifier of the datasource */
98
- id: string;
99
- /** Name of the datasource */
100
- name?: string;
101
- /** The number of times that a datasource was referenced as a source in an answer */
102
- sourceCount?: number;
103
- /** The unique identifier of the space containing the datasource */
70
+ contentSummary: ContentSummary; /** Configuration for webcrawling */
71
+ crawlerConfig?: DataSourceCrawlConfig; /** Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided. */
72
+ fileConfig?: DataSourceFileConfig; /** Unique identifier of the datasource */
73
+ id: string; /** Name of the datasource */
74
+ name?: string; /** The number of times that a datasource was referenced as a source in an answer */
75
+ sourceCount?: number; /** The unique identifier of the space containing the datasource */
104
76
  spaceId?: string;
105
77
  syncInfo?: DataSourceSyncStatus;
106
78
  type: "file" | "web" | "database";
@@ -109,87 +81,60 @@ type DataSource = {
109
81
  * Configuration for webcrawling
110
82
  */
111
83
  type DataSourceCrawlConfig = {
112
- /** Pattern matching links to crawl */
113
- crawlPatterns?: DataSourceCrawlPattern[];
114
- /** Pattern matching links to index */
115
- indexPatterns?: DataSourceCrawlPattern[];
116
- /** Scope for th webcrawler */
117
- scope: DataSourceCrawlScope;
118
- /** Seed URL that crawling will start on. */
84
+ /** Pattern matching links to crawl */crawlPatterns?: DataSourceCrawlPattern[]; /** Pattern matching links to index */
85
+ indexPatterns?: DataSourceCrawlPattern[]; /** Scope for th webcrawler */
86
+ scope: DataSourceCrawlScope; /** Seed URL that crawling will start on. */
119
87
  url: string;
120
88
  };
121
89
  /**
122
90
  * Include or exclude pattern
123
91
  */
124
92
  type DataSourceCrawlPattern = {
125
- /** Regex patterna to filter links on */
126
- pattern: string;
127
- /** include or exclude */
93
+ /** Regex patterna to filter links on */pattern: string; /** include or exclude */
128
94
  type: "include" | "exclude";
129
95
  };
130
96
  /**
131
97
  * Scope for th webcrawler
132
98
  */
133
99
  type DataSourceCrawlScope = {
134
- /** The number of levels of links the crawler will traverse */
135
- depth: number;
136
- /** if set to true crawler will try to download and index other supported content like pdf:s from links */
137
- downloadFiles?: boolean;
138
- /** Maximum number of links per page that will be extracted */
139
- maxLinks?: number;
140
- /** Optional parameter. Max size of downloaded files in bytes */
141
- maxSize?: number;
142
- /** The scope that the crawler will crawl. */
100
+ /** The number of levels of links the crawler will traverse */depth: number; /** if set to true crawler will try to download and index other supported content like pdf:s from links */
101
+ downloadFiles?: boolean; /** Maximum number of links per page that will be extracted */
102
+ maxLinks?: number; /** Optional parameter. Max size of downloaded files in bytes */
103
+ maxSize?: number; /** The scope that the crawler will crawl. */
143
104
  scope: "all" | "domain" | "subdomain";
144
105
  };
145
106
  /**
146
107
  * Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.
147
108
  */
148
109
  type DataSourceFileConfig = {
149
- /** connection id to be used to retrieve the raw data */
150
- connectionId: string;
151
- /** Pattern matching links to crawl */
110
+ /** connection id to be used to retrieve the raw data */connectionId: string; /** Pattern matching links to crawl */
152
111
  crawlPatterns?: DataSourceCrawlPattern[];
153
- files?: string[];
154
- /** Root folder for traversing. */
155
- folder?: string;
156
- /** Scope for the file crawler. */
157
- scope?: DataSourceFileCrawlScope;
158
- /** userId of the owner of the datasource fileConfig */
112
+ files?: string[]; /** Root folder for traversing. */
113
+ folder?: string; /** Scope for the file crawler. */
114
+ scope?: DataSourceFileCrawlScope; /** userId of the owner of the datasource fileConfig */
159
115
  userId: string;
160
116
  };
161
117
  /**
162
118
  * Scope for the file crawler.
163
119
  */
164
120
  type DataSourceFileCrawlScope = {
165
- /** The number of levels of sub folders that should be considered */
166
- depth: number;
167
- /** list of file extensions to be considered */
168
- extensions?: string[];
169
- /** Maximum number of files per folder that should be considered */
170
- maxFilesPerFolder?: number;
171
- /** Total number of files that should be considered */
172
- maxFilesTotal?: number;
173
- /** Optional parameter. Max size of downloaded files in bytes */
174
- maxSize?: number;
175
- /** only files modified after this time should be indexed. If set older files will be removed from index. */
121
+ /** The number of levels of sub folders that should be considered */depth: number; /** list of file extensions to be considered */
122
+ extensions?: string[]; /** Maximum number of files per folder that should be considered */
123
+ maxFilesPerFolder?: number; /** Total number of files that should be considered */
124
+ maxFilesTotal?: number; /** Optional parameter. Max size of downloaded files in bytes */
125
+ maxSize?: number; /** only files modified after this time should be indexed. If set older files will be removed from index. */
176
126
  modifiedAfter?: string;
177
127
  };
178
128
  /**
179
129
  * Response when a datasource sync is started, contains the sync Id
180
130
  */
181
131
  type DataSourceSync = {
182
- /** Unique identifier of the sync */
183
- id: string;
132
+ /** Unique identifier of the sync */id: string;
184
133
  };
185
134
  type DataSourceSyncStatus = {
186
- /** Datetime when the sync task was completed */
187
- readonly completedAt: string;
188
- /** sync Id */
189
- lastSyncId?: string;
190
- /** Datetime when the sync task was started */
191
- readonly startedAt: string;
192
- /** Sync status */
135
+ /** Datetime when the sync task was completed */readonly completedAt: string; /** sync Id */
136
+ lastSyncId?: string; /** Datetime when the sync task was started */
137
+ readonly startedAt: string; /** Sync status */
193
138
  readonly status: "neverIndexed" | "progress" | "completed" | "completedWithError" | "toAdd" | "toDelete";
194
139
  };
195
140
  /**
@@ -207,24 +152,17 @@ type DocStats = {
207
152
  readonly updated: number;
208
153
  };
209
154
  type DownloadFile = {
210
- /** file path to the file to downlaod. */
211
- path: string;
155
+ /** file path to the file to downlaod. */path: string;
212
156
  };
213
157
  /**
214
158
  * Download information for the file.
215
159
  */
216
160
  type DownloadFileResponse = {
217
- /** Size of downloaded file. */
218
- fileSize: number;
219
- /** Date for last time the file was modified. */
220
- lastUpdatedAt: string;
221
- /** The mimetype of the file. */
222
- mimeType: string;
223
- /** The requested file name. */
224
- name: string;
225
- /** Space id the file belongs in. */
226
- spaceId: string;
227
- /** URL to download the file. */
161
+ /** Size of downloaded file. */fileSize: number; /** Date for last time the file was modified. */
162
+ lastUpdatedAt: string; /** The mimetype of the file. */
163
+ mimeType: string; /** The requested file name. */
164
+ name: string; /** Space id the file belongs in. */
165
+ spaceId: string; /** URL to download the file. */
228
166
  url: string;
229
167
  };
230
168
  type Duration = {
@@ -239,11 +177,6 @@ type ErrorResponse = {
239
177
  traceId?: string;
240
178
  };
241
179
  type ErrorResponseCode = {
242
- code?: string;
243
- detail?: string;
244
- title?: string;
245
- };
246
- type ErrorResponseCodeCopy = {
247
180
  /** Custom error codes
248
181
  * * AE-1 - Internal processing error
249
182
  * * AE-2 - Incorrect request
@@ -256,6 +189,11 @@ type ErrorResponseCodeCopy = {
256
189
  detail?: string;
257
190
  title?: string;
258
191
  };
192
+ type ErrorResponseCodeCopy = {
193
+ code?: string;
194
+ detail?: string;
195
+ title?: string;
196
+ };
259
197
  type ErrorResponseCopy = {
260
198
  errors?: ErrorResponseCodeCopy[];
261
199
  traceId?: string;
@@ -264,49 +202,30 @@ type ErrorResponseCopy = {
264
202
  * Metadata about the chunk
265
203
  */
266
204
  type KbChunkMeta = {
267
- /** chunkId */
268
- chunkId: string;
269
- /** datasourceId of chunk */
270
- datasourceId: string;
271
- /** documentId of chunk */
272
- documentId: string;
273
- /** knowledgeBaseId of chunk */
274
- knowledgeBaseId: string;
275
- /** source of chunk */
205
+ /** chunkId */chunkId: string; /** datasourceId of chunk */
206
+ datasourceId: string; /** documentId of chunk */
207
+ documentId: string; /** knowledgeBaseId of chunk */
208
+ knowledgeBaseId: string; /** source of chunk */
276
209
  source: string;
277
210
  };
278
211
  type KnowledgeBase = KnowledgeBaseLight & {
279
212
  datasources?: DataSource[];
280
213
  };
281
214
  type KnowledgeBaseLight = {
282
- /** User opt in to advanced parsing and chunking pipeline. Default is false, which will run legacy parsing and chunking. */
283
- advancedIndexing?: boolean;
284
- contentSummary: ContentSummary;
285
- /** Datetime when the knowledgebase was created */
286
- readonly createdAt: string;
287
- /** Unique identifier of the user who created the knowledgebase */
288
- readonly createdBy: string;
289
- /** Description of the knowledgebase */
290
- description: string;
291
- /** Unique identifier of the knowledgebase */
292
- id: string;
293
- /** Datetime when the knowledgebase was last indexed */
294
- readonly lastIndexedAt?: string;
295
- /** Name of the knowledgebase */
296
- name: string;
297
- /** The unique identifier of the knowledgebase owner */
298
- ownerId: string;
299
- /** Number of selected errors to store in the case of any failed datasources. */
300
- selectedErrorsCount?: number;
301
- /** The unique identifier of the space containing the knowledgebase */
302
- spaceId: string;
303
- /** List of tags associated with the knowledgebase. */
304
- tags: string[];
305
- /** Unique identifier of the tenant */
306
- tenantId?: string;
307
- /** Datetime when the knowledgebase was updated */
308
- readonly updatedAt: string;
309
- /** The unique identifier of the user who last updated the knowledgebase */
215
+ /** User opt in to advanced parsing and chunking pipeline. Default is false, which will run legacy parsing and chunking. */advancedIndexing?: boolean;
216
+ contentSummary: ContentSummary; /** Datetime when the knowledgebase was created */
217
+ readonly createdAt: string; /** Unique identifier of the user who created the knowledgebase */
218
+ readonly createdBy: string; /** Description of the knowledgebase */
219
+ description: string; /** Unique identifier of the knowledgebase */
220
+ id: string; /** Datetime when the knowledgebase was last indexed */
221
+ readonly lastIndexedAt?: string; /** Name of the knowledgebase */
222
+ name: string; /** The unique identifier of the knowledgebase owner */
223
+ ownerId: string; /** Number of selected errors to store in the case of any failed datasources. */
224
+ selectedErrorsCount?: number; /** The unique identifier of the space containing the knowledgebase */
225
+ spaceId: string; /** List of tags associated with the knowledgebase. */
226
+ tags: string[]; /** Unique identifier of the tenant */
227
+ tenantId?: string; /** Datetime when the knowledgebase was updated */
228
+ readonly updatedAt: string; /** The unique identifier of the user who last updated the knowledgebase */
310
229
  readonly updatedBy: string;
311
230
  };
312
231
  type KnowledgeBasesResult = {
@@ -332,41 +251,28 @@ type Schedule = {
332
251
  * An event specification relative to the calendar, similar to a traditional cron specification.
333
252
  */
334
253
  type ScheduleCalendar = {
335
- /** Description of the intention of this schedule */
336
- comment: string;
337
- /** DayOfMonth range to match (1-31). Default matches all days */
338
- dayOfMonth: ScheduleRange[];
339
- /** DayOfWeek range to match (0-6; 0 is Sunday). Default matches all days of the week */
340
- dayOfWeek: ScheduleRange[];
341
- /** Hour range to match (0-23). Default matches 0 */
342
- hour: ScheduleRange[];
343
- /** Minute range to match (0-59). Default matches 0 */
344
- minute: ScheduleRange[];
345
- /** Month range to match (1-12). Default matches all months */
346
- month: ScheduleRange[];
347
- /** Second range to match (0-59). Default matches 0 */
348
- second: ScheduleRange[];
349
- /** Year range to match. Default matches all years */
254
+ /** Description of the intention of this schedule */comment: string; /** DayOfMonth range to match (1-31). Default matches all days */
255
+ dayOfMonth: ScheduleRange[]; /** DayOfWeek range to match (0-6; 0 is Sunday). Default matches all days of the week */
256
+ dayOfWeek: ScheduleRange[]; /** Hour range to match (0-23). Default matches 0 */
257
+ hour: ScheduleRange[]; /** Minute range to match (0-59). Default matches 0 */
258
+ minute: ScheduleRange[]; /** Month range to match (1-12). Default matches all months */
259
+ month: ScheduleRange[]; /** Second range to match (0-59). Default matches 0 */
260
+ second: ScheduleRange[]; /** Year range to match. Default matches all years */
350
261
  year: ScheduleRange[];
351
262
  };
352
263
  /**
353
264
  * For example, an `every` of 1 hour with `offset` of zero would match every hour, on the hour. The same `every` but an `offset` of 19 minutes would match every `xx:19:00`.
354
265
  */
355
266
  type ScheduleInterval = {
356
- /** The period to repeat the interval */
357
- every: string;
358
- /** A fixed offset added to the intervals period. Optional, defaults to 0 */
267
+ /** The period to repeat the interval */every: string; /** A fixed offset added to the intervals period. Optional, defaults to 0 */
359
268
  offset?: string;
360
269
  };
361
270
  /**
362
271
  * ScheduleRange represents a set of integer values, used to match fields of a calendar time in scheduleCalendar. If end < start, then end is interpreted as equal to start
363
272
  */
364
273
  type ScheduleRange = {
365
- /** End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start */
366
- end?: number;
367
- /** Start of the range (inclusive) */
368
- start: number;
369
- /** Step to be take between each value. Optional, defaulted to 1 */
274
+ /** End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start */end?: number; /** Start of the range (inclusive) */
275
+ start: number; /** Step to be take between each value. Optional, defaulted to 1 */
370
276
  step?: number;
371
277
  };
372
278
  type ScheduleWithManifest = {
@@ -379,64 +285,38 @@ type ScheduleWithManifest = {
379
285
  tenantId: string;
380
286
  };
381
287
  type SearchRequest = {
382
- /** Query text or question to search. */
383
- prompt: string;
384
- /** Search mode to use. Allowed values: `SIMPLE` and `FULL`. Default: `SIMPLE`. */
385
- searchMode?: "SIMPLE" | "FULL";
386
- /** Number of chunks to return in results. */
288
+ /** Query text or question to search. */prompt: string; /** Search mode to use. Allowed values: `SIMPLE` and `FULL`. Default: `SIMPLE`. */
289
+ searchMode?: "SIMPLE" | "FULL"; /** Number of chunks to return in results. */
387
290
  topN?: number;
388
291
  };
389
292
  type SearchResponse = {
390
- /** Retrieved document chunks */
391
- chunks: Chunk[];
293
+ /** Retrieved document chunks */chunks: Chunk[];
392
294
  };
393
295
  type SyncHistory = {
394
- /** Datetime when the sync task was completed */
395
- readonly completedAt?: string;
396
- /** Connection id that the datasource used */
397
- connectionId: string;
398
- /** datasource id */
399
- datasourceId: string;
400
- /** Summary of documents processed */
401
- docStats: DocStats;
402
- /** sync id */
403
- id: string;
404
- /** populated with up to the first selectedErrorsCount errors if there were any during sync */
405
- selectedErrors?: string[];
406
- /** Datetime when the sync task was started */
407
- readonly startedAt: string;
408
- /** Sync status */
409
- readonly status: "neverIndexed" | "progress" | "completed" | "completedWithError";
410
- /** Datasource trigger type, was it manually or automatically synced */
296
+ /** Datetime when the sync task was completed */readonly completedAt?: string; /** Connection id that the datasource used */
297
+ connectionId: string; /** datasource id */
298
+ datasourceId: string; /** Summary of documents processed */
299
+ docStats: DocStats; /** sync id */
300
+ id: string; /** populated with up to the first selectedErrorsCount errors if there were any during sync */
301
+ selectedErrors?: string[]; /** Datetime when the sync task was started */
302
+ readonly startedAt: string; /** Sync status */
303
+ readonly status: "neverIndexed" | "progress" | "completed" | "completedWithError"; /** Datasource trigger type, was it manually or automatically synced */
411
304
  triggerType: string;
412
305
  };
413
306
  type SyncHistoryDetails = {
414
- /** acion performed */
415
- readonly action: "add" | "delete" | "update";
416
- /** chunk size */
417
- readonly chunkSize?: number;
418
- /** number of chunks */
307
+ /** acion performed */readonly action: "add" | "delete" | "update"; /** chunk size */
308
+ readonly chunkSize?: number; /** number of chunks */
419
309
  readonly chunks?: number;
420
- duration?: Duration;
421
- /** error if one happened during sync */
422
- error?: string;
423
- /** page count */
424
- readonly explicitPages: number;
425
- /** Datetime when the file processing finished */
426
- readonly fileCompletedAt?: string;
427
- /** Datetime when the file was last modified */
428
- readonly fileLastModified?: string;
429
- /** file size */
430
- readonly fileSize?: number;
431
- /** Datetime when the file processing started */
432
- readonly fileStartedAt?: string;
433
- /** document Id */
434
- id: string;
435
- /** Source of the document */
436
- readonly source: string;
437
- /** sync Id */
438
- syncId: string;
439
- /** Datetime when the sync task was executed */
310
+ duration?: Duration; /** error if one happened during sync */
311
+ error?: string; /** page count */
312
+ readonly explicitPages: number; /** Datetime when the file processing finished */
313
+ readonly fileCompletedAt?: string; /** Datetime when the file was last modified */
314
+ readonly fileLastModified?: string; /** file size */
315
+ readonly fileSize?: number; /** Datetime when the file processing started */
316
+ readonly fileStartedAt?: string; /** document Id */
317
+ id: string; /** Source of the document */
318
+ readonly source: string; /** sync Id */
319
+ syncId: string; /** Datetime when the sync task was executed */
440
320
  readonly syncedAt: string;
441
321
  };
442
322
  type SyncHistoryResult = {
@@ -453,14 +333,10 @@ type SyncHistoryResult = {
453
333
  declare function getKnowledgebases(query: {
454
334
  /** @deprecated
455
335
  * Optional parameter to request total count for query */
456
- countTotal?: boolean;
457
- /** The number of knowledgebases to get. */
458
- limit?: number;
459
- /** Optional parameter to request the next page. */
460
- next?: string;
461
- /** Optional parameter to request the previous page. */
462
- prev?: string;
463
- /** Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending. */
336
+ countTotal?: boolean; /** The number of knowledgebases to get. */
337
+ limit?: number; /** Optional parameter to request the next page. */
338
+ next?: string; /** Optional parameter to request the previous page. */
339
+ prev?: string; /** Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending. */
464
340
  sort?: "NAME" | "-NAME" | "DESCRIPTION" | "-DESCRIPTION" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
465
341
  }, options?: ApiCallOptions): Promise<GetKnowledgebasesHttpResponse>;
466
342
  type GetKnowledgebasesHttpResponse = {
@@ -471,7 +347,7 @@ type GetKnowledgebasesHttpResponse = {
471
347
  next?: (options?: ApiCallOptions) => Promise<GetKnowledgebasesHttpResponse>;
472
348
  };
473
349
  type GetKnowledgebasesHttpError = {
474
- data: ErrorResponse;
350
+ data: ErrorResponseCopy;
475
351
  headers: Headers;
476
352
  status: 400 | 403;
477
353
  };
@@ -488,7 +364,7 @@ type CreateKnowledgebaseHttpResponse = {
488
364
  status: 201;
489
365
  };
490
366
  type CreateKnowledgebaseHttpError = {
491
- data: ErrorResponse;
367
+ data: ErrorResponseCopy;
492
368
  headers: Headers;
493
369
  status: 400 | 403;
494
370
  };
@@ -505,7 +381,7 @@ type DeleteKnowledgebaseHttpResponse = {
505
381
  status: 204;
506
382
  };
507
383
  type DeleteKnowledgebaseHttpError = {
508
- data: ErrorResponse;
384
+ data: ErrorResponseCopy;
509
385
  headers: Headers;
510
386
  status: 400 | 403 | 404;
511
387
  };
@@ -522,7 +398,7 @@ type GetKnowledgebaseHttpResponse = {
522
398
  status: 200;
523
399
  };
524
400
  type GetKnowledgebaseHttpError = {
525
- data: ErrorResponse;
401
+ data: ErrorResponseCopy;
526
402
  headers: Headers;
527
403
  status: 400 | 403 | 404;
528
404
  };
@@ -540,7 +416,7 @@ type PatchKnowledgebaseHttpResponse = {
540
416
  status: 204;
541
417
  };
542
418
  type PatchKnowledgebaseHttpError = {
543
- data: ErrorResponse;
419
+ data: ErrorResponseCopy;
544
420
  headers: Headers;
545
421
  status: 400 | 401 | 403 | 404 | 429;
546
422
  };
@@ -558,7 +434,7 @@ type SearchKnowledgebaseHttpResponse = {
558
434
  status: 200;
559
435
  };
560
436
  type SearchKnowledgebaseHttpError = {
561
- data: ErrorResponseCopy;
437
+ data: ErrorResponse;
562
438
  headers: Headers;
563
439
  status: 400 | 403 | 404 | 405 | 500;
564
440
  };
@@ -576,7 +452,7 @@ type CreateKnowledgebaseDatasourceHttpResponse = {
576
452
  status: 201;
577
453
  };
578
454
  type CreateKnowledgebaseDatasourceHttpError = {
579
- data: ErrorResponse;
455
+ data: ErrorResponseCopy;
580
456
  headers: Headers;
581
457
  status: 400 | 403 | 404;
582
458
  };
@@ -594,7 +470,7 @@ type DeleteKnowledgebaseDatasourceHttpResponse = {
594
470
  status: 204;
595
471
  };
596
472
  type DeleteKnowledgebaseDatasourceHttpError = {
597
- data: ErrorResponse;
473
+ data: ErrorResponseCopy;
598
474
  headers: Headers;
599
475
  status: 400 | 403 | 404;
600
476
  };
@@ -613,7 +489,7 @@ type UpdateKnowledgebaseDatasourceHttpResponse = {
613
489
  status: 200;
614
490
  };
615
491
  type UpdateKnowledgebaseDatasourceHttpError = {
616
- data: ErrorResponse;
492
+ data: ErrorResponseCopy;
617
493
  headers: Headers;
618
494
  status: 400 | 403 | 404;
619
495
  };
@@ -631,7 +507,7 @@ type CancelKnowledgebaseDatasourceHttpResponse = {
631
507
  status: 200;
632
508
  };
633
509
  type CancelKnowledgebaseDatasourceHttpError = {
634
- data: ErrorResponse;
510
+ data: ErrorResponseCopy;
635
511
  headers: Headers;
636
512
  status: 400 | 403 | 404;
637
513
  };
@@ -650,7 +526,7 @@ type DownloadKnowledgebaseDatasourceHttpResponse = {
650
526
  status: 200;
651
527
  };
652
528
  type DownloadKnowledgebaseDatasourceHttpError = {
653
- data: ErrorResponse;
529
+ data: ErrorResponseCopy;
654
530
  headers: Headers;
655
531
  status: 400 | 403 | 404;
656
532
  };
@@ -663,8 +539,7 @@ type DownloadKnowledgebaseDatasourceHttpError = {
663
539
  * @throws SyncKnowledgebaseDatasourceHttpError
664
540
  */
665
541
  declare function syncKnowledgebaseDatasource(id: string, datasourceId: string, query: {
666
- /** Optional parameter to migrate indexed files to docdetails collection */
667
- migrate?: boolean;
542
+ /** Optional parameter to migrate indexed files to docdetails collection */migrate?: boolean;
668
543
  }, options?: ApiCallOptions): Promise<SyncKnowledgebaseDatasourceHttpResponse>;
669
544
  type SyncKnowledgebaseDatasourceHttpResponse = {
670
545
  data: DataSourceSync;
@@ -672,7 +547,7 @@ type SyncKnowledgebaseDatasourceHttpResponse = {
672
547
  status: 202;
673
548
  };
674
549
  type SyncKnowledgebaseDatasourceHttpError = {
675
- data: ErrorResponse;
550
+ data: ErrorResponseCopy;
676
551
  headers: Headers;
677
552
  status: 400 | 403 | 404;
678
553
  };
@@ -685,13 +560,9 @@ type SyncKnowledgebaseDatasourceHttpError = {
685
560
  * @throws GetKnowledgebaseDatasourceHistoriesHttpError
686
561
  */
687
562
  declare function getKnowledgebaseDatasourceHistories(id: string, datasourceId: string, query: {
688
- /** The number of knowledgebases to get. */
689
- limit?: number;
690
- /** Optional parameter to request the next page. */
691
- next?: string;
692
- /** Optional parameter to request the previous page. */
693
- prev?: string;
694
- /** Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending. */
563
+ /** The number of knowledgebases to get. */limit?: number; /** Optional parameter to request the next page. */
564
+ next?: string; /** Optional parameter to request the previous page. */
565
+ prev?: string; /** Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending. */
695
566
  sort?: "COMPLETED" | "-COMPLETED";
696
567
  }, options?: ApiCallOptions): Promise<GetKnowledgebaseDatasourceHistoriesHttpResponse>;
697
568
  type GetKnowledgebaseDatasourceHistoriesHttpResponse = {
@@ -702,7 +573,7 @@ type GetKnowledgebaseDatasourceHistoriesHttpResponse = {
702
573
  next?: (options?: ApiCallOptions) => Promise<GetKnowledgebaseDatasourceHistoriesHttpResponse>;
703
574
  };
704
575
  type GetKnowledgebaseDatasourceHistoriesHttpError = {
705
- data: ErrorResponse;
576
+ data: ErrorResponseCopy;
706
577
  headers: Headers;
707
578
  status: 400 | 403 | 404;
708
579
  };
@@ -723,7 +594,7 @@ type GetKnowledgebaseDatasourceHistoryHttpResponse = {
723
594
  status: 200;
724
595
  };
725
596
  type GetKnowledgebaseDatasourceHistoryHttpError = {
726
- data: ErrorResponse;
597
+ data: ErrorResponseCopy;
727
598
  headers: Headers;
728
599
  status: 400 | 403 | 404;
729
600
  };
@@ -741,7 +612,7 @@ type DeleteKnowledgebaseDatasourceScheduleHttpResponse = {
741
612
  status: 204;
742
613
  };
743
614
  type DeleteKnowledgebaseDatasourceScheduleHttpError = {
744
- data: ErrorResponse;
615
+ data: ErrorResponseCopy;
745
616
  headers: Headers;
746
617
  status: 400 | 403 | 404;
747
618
  };
@@ -759,7 +630,7 @@ type GetKnowledgebaseDatasourceScheduleHttpResponse = {
759
630
  status: 200;
760
631
  };
761
632
  type GetKnowledgebaseDatasourceScheduleHttpError = {
762
- data: ErrorResponse;
633
+ data: ErrorResponseCopy;
763
634
  headers: Headers;
764
635
  status: 400 | 403 | 404;
765
636
  };
@@ -778,7 +649,7 @@ type CreateKnowledgebaseDatasourceScheduleHttpResponse = {
778
649
  status: 200 | 201;
779
650
  };
780
651
  type CreateKnowledgebaseDatasourceScheduleHttpError = {
781
- data: ErrorResponse;
652
+ data: ErrorResponseCopy;
782
653
  headers: Headers;
783
654
  status: 400 | 403 | 404;
784
655
  };
@@ -790,13 +661,9 @@ type CreateKnowledgebaseDatasourceScheduleHttpError = {
790
661
  * @throws GetKnowledgebaseHistoriesHttpError
791
662
  */
792
663
  declare function getKnowledgebaseHistories(id: string, query: {
793
- /** The number of sync histories to get. */
794
- limit?: number;
795
- /** Optional parameter to request the next page. */
796
- next?: string;
797
- /** Optional parameter to request the previous page. */
798
- prev?: string;
799
- /** Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending. */
664
+ /** The number of sync histories to get. */limit?: number; /** Optional parameter to request the next page. */
665
+ next?: string; /** Optional parameter to request the previous page. */
666
+ prev?: string; /** Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending. */
800
667
  sort?: "COMPLETED" | "-COMPLETED";
801
668
  }, options?: ApiCallOptions): Promise<GetKnowledgebaseHistoriesHttpResponse>;
802
669
  type GetKnowledgebaseHistoriesHttpResponse = {
@@ -807,7 +674,7 @@ type GetKnowledgebaseHistoriesHttpResponse = {
807
674
  next?: (options?: ApiCallOptions) => Promise<GetKnowledgebaseHistoriesHttpResponse>;
808
675
  };
809
676
  type GetKnowledgebaseHistoriesHttpError = {
810
- data: ErrorResponse;
677
+ data: ErrorResponseCopy;
811
678
  headers: Headers;
812
679
  status: 400 | 403 | 404;
813
680
  };