@wildix/wim-knowledge-base-client 0.0.48 → 0.0.50

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 (54) hide show
  1. package/dist-cjs/KnowledgeBase.js +16 -8
  2. package/dist-cjs/commands/{QueryKnowledgeBaseCommand.js → GenerateSearchAnswerCommand.js} +7 -7
  3. package/dist-cjs/commands/{SearchHistoryCommand.js → GetDataSourceSyncStatusCommand.js} +7 -7
  4. package/dist-cjs/commands/{GetSyncLogsCommand.js → GetDocumentChunksCommand.js} +7 -7
  5. package/dist-cjs/commands/{GetSyncStatusCommand.js → GetDocumentMarkdownCommand.js} +7 -7
  6. package/dist-cjs/commands/GetDocumentWithContentAndChunksCommand.js +21 -0
  7. package/dist-cjs/commands/ListDataSourceStatisticsCommand.js +21 -0
  8. package/dist-cjs/commands/ListDataSourceSynchronizationLogsCommand.js +21 -0
  9. package/dist-cjs/commands/ListSearchQueriesHistoryCommand.js +21 -0
  10. package/dist-cjs/commands/index.js +8 -4
  11. package/dist-cjs/models/models_0.js +15 -22
  12. package/dist-cjs/protocols/Aws_restJson1.js +229 -140
  13. package/dist-es/KnowledgeBase.js +16 -8
  14. package/dist-es/commands/GenerateSearchAnswerCommand.js +17 -0
  15. package/dist-es/commands/GetDataSourceSyncStatusCommand.js +17 -0
  16. package/dist-es/commands/GetDocumentChunksCommand.js +17 -0
  17. package/dist-es/commands/GetDocumentMarkdownCommand.js +17 -0
  18. package/dist-es/commands/GetDocumentWithContentAndChunksCommand.js +17 -0
  19. package/dist-es/commands/ListDataSourceStatisticsCommand.js +17 -0
  20. package/dist-es/commands/ListDataSourceSynchronizationLogsCommand.js +17 -0
  21. package/dist-es/commands/ListSearchQueriesHistoryCommand.js +17 -0
  22. package/dist-es/commands/index.js +8 -4
  23. package/dist-es/models/models_0.js +14 -21
  24. package/dist-es/protocols/Aws_restJson1.js +204 -123
  25. package/dist-types/KnowledgeBase.d.ts +54 -26
  26. package/dist-types/KnowledgeBaseClient.d.ts +10 -6
  27. package/dist-types/commands/ConfigureDataSourceCommand.d.ts +1 -36
  28. package/dist-types/commands/CreateDataSourceCommand.d.ts +2 -22
  29. package/dist-types/commands/GenerateSearchAnswerCommand.d.ts +105 -0
  30. package/dist-types/commands/GetDataSourceCommand.d.ts +1 -21
  31. package/dist-types/commands/GetDataSourceSyncStatusCommand.d.ts +88 -0
  32. package/dist-types/commands/GetDocumentChunksCommand.d.ts +94 -0
  33. package/dist-types/commands/GetDocumentCommand.d.ts +0 -2
  34. package/dist-types/commands/GetDocumentMarkdownCommand.d.ts +86 -0
  35. package/dist-types/commands/GetDocumentWithContentAndChunksCommand.d.ts +113 -0
  36. package/dist-types/commands/ListDataSourceStatisticsCommand.d.ts +86 -0
  37. package/dist-types/commands/ListDataSourceSynchronizationLogsCommand.d.ts +96 -0
  38. package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -21
  39. package/dist-types/commands/ListSearchQueriesHistoryCommand.d.ts +97 -0
  40. package/dist-types/commands/SearchKnowledgeBaseCommand.d.ts +8 -9
  41. package/dist-types/commands/StartSyncDataSourceCommand.d.ts +1 -1
  42. package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -21
  43. package/dist-types/commands/index.d.ts +8 -4
  44. package/dist-types/models/models_0.d.ts +269 -334
  45. package/dist-types/protocols/Aws_restJson1.d.ts +64 -28
  46. package/package.json +1 -1
  47. package/dist-es/commands/GetSyncLogsCommand.js +0 -17
  48. package/dist-es/commands/GetSyncStatusCommand.js +0 -17
  49. package/dist-es/commands/QueryKnowledgeBaseCommand.js +0 -17
  50. package/dist-es/commands/SearchHistoryCommand.js +0 -17
  51. package/dist-types/commands/GetSyncLogsCommand.d.ts +0 -96
  52. package/dist-types/commands/GetSyncStatusCommand.d.ts +0 -94
  53. package/dist-types/commands/QueryKnowledgeBaseCommand.d.ts +0 -103
  54. package/dist-types/commands/SearchHistoryCommand.d.ts +0 -98
@@ -205,72 +205,10 @@ export interface GDriveConfig {
205
205
  */
206
206
  folders: GDriveFoldersConfig;
207
207
  }
208
- /**
209
- * @public
210
- * @enum
211
- */
212
- export declare const ProxyMethod: {
213
- readonly GET: "GET";
214
- readonly POST: "POST";
215
- };
216
- /**
217
- * @public
218
- */
219
- export type ProxyMethod = typeof ProxyMethod[keyof typeof ProxyMethod];
220
- /**
221
- * @public
222
- */
223
- export interface ProxyConfig {
224
- /**
225
- * The complete URL endpoint of your proxy data source server. Must be a valid HTTP(S) URL. Example: https://api.datasource.com/v1/data or http://proxy.example.com:8080/documents
226
- * @public
227
- */
228
- url: string;
229
- /**
230
- * HTTP method for calling the proxy endpoint. 'GET' retrieves data via query parameters, 'POST' sends data in the request body. Defaults to 'POST' if not specified
231
- * @public
232
- */
233
- method?: ProxyMethod | undefined;
234
- /**
235
- * Optional authentication token for the proxy server. Can be an API key (format: Bearer token, API key, etc.) or JWT token. Used in Authorization header if provided
236
- * @public
237
- */
238
- token?: string | undefined;
239
- /**
240
- * Optional username for basic authentication to the proxy server. Use with password for HTTP Basic Auth
241
- * @public
242
- */
243
- username?: string | undefined;
244
- /**
245
- * Optional password for basic authentication to the proxy server. Use with username for HTTP Basic Auth
246
- * @public
247
- */
248
- password?: string | undefined;
249
- /**
250
- * Optional list of custom HTTP headers to include in requests to the proxy server. Format: ['Header-Name: value', 'Authorization: Bearer token']. Each item is sent as-is
251
- * @public
252
- */
253
- headers?: (string)[] | undefined;
254
- /**
255
- * Optional request body or query parameters to send to the proxy server. For POST requests, sent as JSON body; for GET requests, appended as query parameters
256
- * @public
257
- */
258
- body?: __DocumentType | undefined;
259
- /**
260
- * Request timeout in milliseconds. Controls how long to wait for proxy server response before timing out. Valid range: 500-600000 ms. Defaults to 5000 ms (5 seconds)
261
- * @public
262
- */
263
- timeoutMs?: number | undefined;
264
- /**
265
- * Optional list of JSONPath expressions to map proxy response fields to document properties. Format: ['$.source_field -> $.target_field']. Used to transform proxy responses into expected document structure
266
- * @public
267
- */
268
- responseMapping?: (string)[] | undefined;
269
- }
270
208
  /**
271
209
  * @public
272
210
  */
273
- export type DataSourceConfig = DataSourceConfig.ConfluenceMember | DataSourceConfig.FilesMember | DataSourceConfig.GdriveMember | DataSourceConfig.ProxyMember | DataSourceConfig.$UnknownMember;
211
+ export type DataSourceConfig = DataSourceConfig.ConfluenceMember | DataSourceConfig.FilesMember | DataSourceConfig.GdriveMember | DataSourceConfig.$UnknownMember;
274
212
  /**
275
213
  * @public
276
214
  */
@@ -279,28 +217,18 @@ export declare namespace DataSourceConfig {
279
217
  confluence: ConfluenceConfig;
280
218
  gdrive?: never;
281
219
  files?: never;
282
- proxy?: never;
283
220
  $unknown?: never;
284
221
  }
285
222
  interface GdriveMember {
286
223
  confluence?: never;
287
224
  gdrive: GDriveConfig;
288
225
  files?: never;
289
- proxy?: never;
290
226
  $unknown?: never;
291
227
  }
292
228
  interface FilesMember {
293
229
  confluence?: never;
294
230
  gdrive?: never;
295
231
  files: __DocumentType;
296
- proxy?: never;
297
- $unknown?: never;
298
- }
299
- interface ProxyMember {
300
- confluence?: never;
301
- gdrive?: never;
302
- files?: never;
303
- proxy: ProxyConfig;
304
232
  $unknown?: never;
305
233
  }
306
234
  /**
@@ -310,14 +238,12 @@ export declare namespace DataSourceConfig {
310
238
  confluence?: never;
311
239
  gdrive?: never;
312
240
  files?: never;
313
- proxy?: never;
314
241
  $unknown: [string, any];
315
242
  }
316
243
  interface Visitor<T> {
317
244
  confluence: (value: ConfluenceConfig) => T;
318
245
  gdrive: (value: GDriveConfig) => T;
319
246
  files: (value: __DocumentType) => T;
320
- proxy: (value: ProxyConfig) => T;
321
247
  _: (name: string, value: any) => T;
322
248
  }
323
249
  const visit: <T>(value: DataSourceConfig, visitor: Visitor<T>) => T;
@@ -342,7 +268,7 @@ export type ScheduleConfiguration = typeof ScheduleConfiguration[keyof typeof Sc
342
268
  */
343
269
  export interface ConfigureDataSourceInput {
344
270
  /**
345
- * Configuration specific to the data source type. Union containing ConfluenceConfig, GDriveConfig, ProxyConfig, or empty Document for file-based sources. Configuration structure varies based on the data source type
271
+ * Configuration specific to the data source type. Union containing ConfluenceConfig, GDriveConfig, or empty Document for file-based sources. Configuration structure varies based on the data source type
346
272
  * @public
347
273
  */
348
274
  config: DataSourceConfig;
@@ -362,33 +288,6 @@ export interface ConfigureDataSourceInput {
362
288
  */
363
289
  dataSourceId: string;
364
290
  }
365
- /**
366
- * @public
367
- * @enum
368
- */
369
- export declare const SyncDataSourceMode: {
370
- readonly FULL: "full";
371
- readonly INCREMENTAL: "incremental";
372
- readonly UNKNOWN: "unknown";
373
- };
374
- /**
375
- * @public
376
- */
377
- export type SyncDataSourceMode = typeof SyncDataSourceMode[keyof typeof SyncDataSourceMode];
378
- /**
379
- * @public
380
- * @enum
381
- */
382
- export declare const SyncDataSourceStatus: {
383
- readonly FAILED: "failed";
384
- readonly IDLE: "idle";
385
- readonly RUNNING: "running";
386
- readonly SUCCESS: "success";
387
- };
388
- /**
389
- * @public
390
- */
391
- export type SyncDataSourceStatus = typeof SyncDataSourceStatus[keyof typeof SyncDataSourceStatus];
392
291
  /**
393
292
  * @public
394
293
  * @enum
@@ -397,7 +296,6 @@ export declare const DataSourceType: {
397
296
  readonly CONFLUENCE: "confluence";
398
297
  readonly FILES: "files";
399
298
  readonly GDRIVE: "gdrive";
400
- readonly PROXY: "proxy";
401
299
  };
402
300
  /**
403
301
  * @public
@@ -423,7 +321,7 @@ export interface DataSourceItem {
423
321
  */
424
322
  type: DataSourceType;
425
323
  /**
426
- * Configuration specific to the data source type. Union containing ConfluenceConfig, GDriveConfig, ProxyConfig, or empty Document for file-based sources. Configuration structure varies based on the data source type
324
+ * Configuration specific to the data source type. Union containing ConfluenceConfig, GDriveConfig, or empty Document for file-based sources. Configuration structure varies based on the data source type
427
325
  * @public
428
326
  */
429
327
  config: DataSourceConfig;
@@ -442,11 +340,6 @@ export interface DataSourceItem {
442
340
  * @public
443
341
  */
444
342
  companyId: string;
445
- /**
446
- * Total number of documents currently indexed in this data source
447
- * @public
448
- */
449
- documentsCount: number;
450
343
  /**
451
344
  * Timestamp when the data source was created (ISO 8601 format). Example: 2025-01-01T00:00:00Z
452
345
  * @public
@@ -457,26 +350,6 @@ export interface DataSourceItem {
457
350
  * @public
458
351
  */
459
352
  updatedAt: string;
460
- /**
461
- * Current synchronization status. Possible values: 'idle' (not syncing), 'running' (sync in progress), 'success' (last sync succeeded), 'failed' (last sync encountered errors)
462
- * @public
463
- */
464
- syncStatus: SyncDataSourceStatus;
465
- /**
466
- * Timestamp of the last successful synchronization (ISO 8601 format). Only present if at least one sync has completed. Example: 2021-01-01T00:00:00Z
467
- * @public
468
- */
469
- lastSyncedAt?: string | undefined;
470
- /**
471
- * Mode of the last synchronization attempt: 'full' (complete re-sync), 'incremental' (sync only new/modified data), or 'unknown' (mode unknown for new data sources)
472
- * @public
473
- */
474
- lastSyncMode?: SyncDataSourceMode | undefined;
475
- /**
476
- * Detailed error message from the last failed synchronization, if applicable. Only present when syncStatus is 'failed'
477
- * @public
478
- */
479
- lastSyncErrorMessage?: string | undefined;
480
353
  }
481
354
  /**
482
355
  * @public
@@ -1074,66 +947,84 @@ export type DownloadDocumentType = typeof DownloadDocumentType[keyof typeof Down
1074
947
  /**
1075
948
  * @public
1076
949
  */
1077
- export interface GetDataSourceInput {
950
+ export interface SearchKnowledgeBaseResult {
1078
951
  /**
1079
- * The unique identifier of the tenant when a service token is used.
952
+ * Unique identifier of the document
1080
953
  * @public
1081
954
  */
1082
- companyId?: string | undefined;
955
+ documentId: string;
956
+ documentTitle: string;
957
+ documentUrl: string;
1083
958
  /**
1084
959
  * Unique identifier of the data source
1085
960
  * @public
1086
961
  */
1087
962
  dataSourceId: string;
963
+ dataSourceType: DataSourceType;
964
+ content: string;
965
+ /**
966
+ * The total score of the result, calculated from the semantic search score and the full-text search score.
967
+ * @public
968
+ */
969
+ score: number;
970
+ /**
971
+ * The hierarchy of the document. The hierarchy is a list of document IDs that are the parents of the current document. The hierarchy is used to build the document hierarchy in the search results.
972
+ * @public
973
+ */
974
+ documentHierarchy?: (string)[] | undefined;
1088
975
  }
1089
976
  /**
1090
977
  * @public
1091
978
  */
1092
- export interface GetDataSourceOutput {
1093
- dataSource: DataSourceItem;
1094
- }
1095
- /**
1096
- * @public
1097
- */
1098
- export interface GetDocumentInput {
979
+ export interface GenerateSearchAnswerInput {
1099
980
  /**
1100
981
  * The unique identifier of the tenant when a service token is used.
1101
982
  * @public
1102
983
  */
1103
984
  companyId?: string | undefined;
1104
985
  /**
1105
- * Unique identifier of the data source
986
+ * The question or query to be answered using the knowledge base. The LLM will search the knowledge base and generate an answer based on found results. Example: 'What is the product knowledge base?'
1106
987
  * @public
1107
988
  */
1108
- dataSourceId: string;
989
+ searchQuery: string;
1109
990
  /**
1110
- * Unique identifier of the document
991
+ * The search results to be used to generate the answer. The LLM will use the search results to generate an answer based on the found results.
1111
992
  * @public
1112
993
  */
1113
- documentId: string;
994
+ searchResults: (SearchKnowledgeBaseResult)[];
1114
995
  /**
1115
- * When true, includes the full document content in the response. Set to false to retrieve only document metadata, which is faster for large documents. Defaults to false if not specified
996
+ * The specific provider and model identifier. Examples: 'openai/gpt-4o' or 'openai/gpt-4o-mini' for OpenAI, 'mistral/mistral-small-2506' for Mistral. Check provider documentation for available models
1116
997
  * @public
1117
998
  */
1118
- withContent?: boolean | undefined;
999
+ model?: string | undefined;
1119
1000
  /**
1120
- * When true, includes the list of text chunks that the document was split into for embedding and search. Useful for understanding how the document was processed. Defaults to false if not specified
1001
+ * Controls answer randomness and creativity (0.0-1.0). Low values (0.0-0.3) produce consistent, deterministic answers. High values (0.7-1.0) produce more diverse and creative responses. Defaults to 0.3 for factual consistency
1121
1002
  * @public
1122
1003
  */
1123
- withChunks?: boolean | undefined;
1004
+ temperature?: number | undefined;
1005
+ /**
1006
+ * Maximum number of tokens in the generated answer (1-10000). Higher values allow longer, more detailed answers. Lower values force concise responses. Defaults to 1000 tokens. Note: higher values increase latency and cost
1007
+ * @public
1008
+ */
1009
+ maxOutputTokens?: number | undefined;
1010
+ /**
1011
+ * Optional system prompt to customize LLM behavior and context. Sets instructions for how the LLM should answer questions. Example: 'You are a helpful technical support assistant. Answer only based on the provided knowledge base. If information is not found, say "I don't have this information in the knowledge base."'
1012
+ * @public
1013
+ */
1014
+ systemPrompt?: string | undefined;
1124
1015
  }
1125
1016
  /**
1126
1017
  * @public
1127
1018
  */
1128
- export interface GetDocumentOutput {
1129
- document: DocumentItem;
1130
- content?: string | undefined;
1131
- chunks?: (ChunkItem)[] | undefined;
1019
+ export interface GenerateSearchAnswerOutput {
1020
+ answer: string;
1021
+ metadata: __DocumentType;
1022
+ sources: __DocumentType;
1132
1023
  }
1133
1024
  /**
1134
1025
  * @public
1135
1026
  */
1136
- export interface GetDocumentDownloadUrlInput {
1027
+ export interface GetDataSourceInput {
1137
1028
  /**
1138
1029
  * The unique identifier of the tenant when a service token is used.
1139
1030
  * @public
@@ -1144,27 +1035,67 @@ export interface GetDocumentDownloadUrlInput {
1144
1035
  * @public
1145
1036
  */
1146
1037
  dataSourceId: string;
1038
+ }
1039
+ /**
1040
+ * @public
1041
+ */
1042
+ export interface GetDataSourceOutput {
1043
+ dataSource: DataSourceItem;
1044
+ }
1045
+ /**
1046
+ * @public
1047
+ */
1048
+ export interface GetDataSourceSyncStatusInput {
1147
1049
  /**
1148
- * Unique identifier of the document
1050
+ * The unique identifier of the tenant when a service token is used.
1149
1051
  * @public
1150
1052
  */
1151
- documentId: string;
1053
+ companyId?: string | undefined;
1152
1054
  /**
1153
- * Format of the document to download. 'original' returns the file in its original format (pdf, docx, etc.), 'markdown' returns a markdown-converted version. Defaults to 'markdown' if not specified
1055
+ * Unique identifier of the data source
1154
1056
  * @public
1155
1057
  */
1156
- documentType?: DownloadDocumentType | undefined;
1058
+ dataSourceId: string;
1157
1059
  }
1158
1060
  /**
1159
1061
  * @public
1062
+ * @enum
1160
1063
  */
1161
- export interface GetDocumentDownloadUrlOutput {
1162
- downloadUrl: string;
1064
+ export declare const SyncDataSourceMode: {
1065
+ readonly FULL: "full";
1066
+ readonly INCREMENTAL: "incremental";
1067
+ };
1068
+ /**
1069
+ * @public
1070
+ */
1071
+ export type SyncDataSourceMode = typeof SyncDataSourceMode[keyof typeof SyncDataSourceMode];
1072
+ /**
1073
+ * @public
1074
+ * @enum
1075
+ */
1076
+ export declare const SyncDataSourceStatus: {
1077
+ readonly FAILED: "failed";
1078
+ readonly IDLE: "idle";
1079
+ readonly RUNNING: "running";
1080
+ readonly SUCCESS: "success";
1081
+ };
1082
+ /**
1083
+ * @public
1084
+ */
1085
+ export type SyncDataSourceStatus = typeof SyncDataSourceStatus[keyof typeof SyncDataSourceStatus];
1086
+ /**
1087
+ * @public
1088
+ */
1089
+ export interface GetDataSourceSyncStatusOutput {
1090
+ syncStatus: SyncDataSourceStatus;
1091
+ lastSyncedAt: string;
1092
+ lastSyncMode: SyncDataSourceMode;
1093
+ lastSyncErrorMessage: string;
1163
1094
  }
1164
1095
  /**
1165
1096
  * @public
1166
1097
  */
1167
- export interface GetDocumentUploadUrlInput {
1098
+ export interface GetDocumentInput {
1168
1099
  /**
1169
1100
  * The unique identifier of the tenant when a service token is used.
1170
1101
  * @public
@@ -1180,98 +1111,80 @@ export interface GetDocumentUploadUrlInput {
1180
1111
  * @public
1181
1112
  */
1182
1113
  documentId: string;
1114
+ /**
1115
+ * When true, includes the list of text chunks that the document was split into for embedding and search. Useful for understanding how the document was processed. Defaults to false if not specified
1116
+ * @public
1117
+ */
1118
+ withChunks?: boolean | undefined;
1183
1119
  }
1184
1120
  /**
1185
1121
  * @public
1186
1122
  */
1187
- export interface GetDocumentUploadUrlOutput {
1188
- uploadUrl: string;
1123
+ export interface GetDocumentOutput {
1124
+ document: DocumentItem;
1125
+ chunks?: (ChunkItem)[] | undefined;
1189
1126
  }
1190
1127
  /**
1191
1128
  * @public
1192
1129
  */
1193
- export interface GetKnowledgeBaseInput {
1130
+ export interface GetDocumentChunksInput {
1194
1131
  /**
1195
1132
  * The unique identifier of the tenant when a service token is used.
1196
1133
  * @public
1197
1134
  */
1198
1135
  companyId?: string | undefined;
1199
1136
  /**
1200
- * Unique identifier of the knowledge base
1137
+ * Unique identifier of the data source
1201
1138
  * @public
1202
1139
  */
1203
- knowledgeBaseId: string;
1140
+ dataSourceId: string;
1141
+ /**
1142
+ * Unique identifier of the document
1143
+ * @public
1144
+ */
1145
+ documentId: string;
1204
1146
  }
1205
1147
  /**
1206
1148
  * @public
1207
1149
  */
1208
- export interface GetKnowledgeBaseOutput {
1209
- knowledgeBase: KnowledgeBaseItem;
1150
+ export interface GetDocumentChunksOutput {
1151
+ chunks: (ChunkItem)[];
1210
1152
  }
1211
- /**
1212
- * @public
1213
- * @enum
1214
- */
1215
- export declare const SyncLogLevel: {
1216
- readonly DEBUG: "debug";
1217
- readonly ERROR: "error";
1218
- readonly INFO: "info";
1219
- readonly WARN: "warn";
1220
- };
1221
- /**
1222
- * @public
1223
- */
1224
- export type SyncLogLevel = typeof SyncLogLevel[keyof typeof SyncLogLevel];
1225
1153
  /**
1226
1154
  * @public
1227
1155
  */
1228
- export interface GetSyncLogsInput {
1156
+ export interface GetDocumentDownloadUrlInput {
1229
1157
  /**
1230
1158
  * The unique identifier of the tenant when a service token is used.
1231
1159
  * @public
1232
1160
  */
1233
1161
  companyId?: string | undefined;
1234
- limit?: number | undefined;
1235
- offset?: number | undefined;
1236
- /**
1237
- * Sort order of the results. If there is a '-' prefix, the results will be sorted in descending order. Otherwise, the results will be sorted in ascending order. Example: '-createdAt' will sort the results by createdAt in descending order. 'createdAt' will sort the results by createdAt in ascending order.
1238
- * @public
1239
- */
1240
- sort?: string | undefined;
1241
1162
  /**
1242
1163
  * Unique identifier of the data source
1243
1164
  * @public
1244
1165
  */
1245
1166
  dataSourceId: string;
1246
1167
  /**
1247
- * The log level to filter the sync logs by. Possible values: 'debug', 'info', 'warn', 'error'.
1168
+ * Unique identifier of the document
1248
1169
  * @public
1249
1170
  */
1250
- logLevel?: SyncLogLevel | undefined;
1171
+ documentId: string;
1251
1172
  /**
1252
- * The search query string for filtering the history results.
1173
+ * Format of the document to download. 'original' returns the file in its original format (pdf, docx, etc.), 'markdown' returns a markdown-converted version. Defaults to 'markdown' if not specified
1253
1174
  * @public
1254
1175
  */
1255
- search?: string | undefined;
1256
- }
1257
- /**
1258
- * @public
1259
- */
1260
- export interface SyncLogItem {
1261
- timestamp: string;
1262
- level: SyncLogLevel;
1263
- message: string;
1176
+ documentType?: DownloadDocumentType | undefined;
1264
1177
  }
1265
1178
  /**
1266
1179
  * @public
1267
1180
  */
1268
- export interface GetSyncLogsOutput {
1269
- logs: (SyncLogItem)[];
1181
+ export interface GetDocumentDownloadUrlOutput {
1182
+ downloadUrl: string;
1270
1183
  }
1271
1184
  /**
1272
1185
  * @public
1273
1186
  */
1274
- export interface GetSyncStatusInput {
1187
+ export interface GetDocumentMarkdownInput {
1275
1188
  /**
1276
1189
  * The unique identifier of the tenant when a service token is used.
1277
1190
  * @public
@@ -1282,83 +1195,97 @@ export interface GetSyncStatusInput {
1282
1195
  * @public
1283
1196
  */
1284
1197
  dataSourceId: string;
1198
+ /**
1199
+ * Unique identifier of the document
1200
+ * @public
1201
+ */
1202
+ documentId: string;
1285
1203
  }
1286
1204
  /**
1287
1205
  * @public
1288
1206
  */
1289
- export interface GetSyncStatusOutput {
1290
- /**
1291
- * Current status of the data source synchronization. Possible values: 'idle' (not syncing), 'running' (sync in progress), 'success' (last sync completed successfully), 'failed' (last sync encountered errors)
1292
- * @public
1293
- */
1294
- syncStatus: SyncDataSourceStatus;
1207
+ export interface GetDocumentMarkdownOutput {
1208
+ markdown: string;
1209
+ }
1210
+ /**
1211
+ * @public
1212
+ */
1213
+ export interface GetDocumentUploadUrlInput {
1295
1214
  /**
1296
- * Synchronization progress as a percentage (0-100). Only populated when syncStatus is 'running'. Example: 55 means 55% complete
1215
+ * The unique identifier of the tenant when a service token is used.
1297
1216
  * @public
1298
1217
  */
1299
- progress?: number | undefined;
1218
+ companyId?: string | undefined;
1300
1219
  /**
1301
- * Detailed error message from the last failed synchronization, if applicable. Only present when syncStatus is 'failed'
1220
+ * Unique identifier of the data source
1302
1221
  * @public
1303
1222
  */
1304
- syncErrorMessage?: string | undefined;
1223
+ dataSourceId: string;
1305
1224
  /**
1306
- * List of recent synchronization log entries providing detailed information about the sync process, including debug, info, warning, and error messages
1225
+ * Unique identifier of the document
1307
1226
  * @public
1308
1227
  */
1309
- lastSyncLogs?: (SyncLogItem)[] | undefined;
1228
+ documentId: string;
1310
1229
  }
1311
1230
  /**
1312
1231
  * @public
1313
1232
  */
1314
- export interface ListDataSourcesInput {
1233
+ export interface GetDocumentUploadUrlOutput {
1234
+ uploadUrl: string;
1235
+ }
1236
+ /**
1237
+ * @public
1238
+ */
1239
+ export interface GetDocumentWithContentAndChunksInput {
1315
1240
  /**
1316
1241
  * The unique identifier of the tenant when a service token is used.
1317
1242
  * @public
1318
1243
  */
1319
1244
  companyId?: string | undefined;
1245
+ /**
1246
+ * Unique identifier of the data source
1247
+ * @public
1248
+ */
1249
+ dataSourceId: string;
1250
+ /**
1251
+ * Unique identifier of the document
1252
+ * @public
1253
+ */
1254
+ documentId: string;
1320
1255
  }
1321
1256
  /**
1322
1257
  * @public
1323
1258
  */
1324
- export interface ListDataSourcesOutput {
1325
- dataSources: (DataSourceItem)[];
1259
+ export interface GetDocumentWithContentAndChunksOutput {
1260
+ document: DocumentItem;
1261
+ content?: string | undefined;
1262
+ chunks: (ChunkItem)[];
1326
1263
  }
1327
1264
  /**
1328
1265
  * @public
1329
1266
  */
1330
- export interface ListDocumentsInput {
1267
+ export interface GetKnowledgeBaseInput {
1331
1268
  /**
1332
1269
  * The unique identifier of the tenant when a service token is used.
1333
1270
  * @public
1334
1271
  */
1335
1272
  companyId?: string | undefined;
1336
1273
  /**
1337
- * Unique identifier of the data source
1338
- * @public
1339
- */
1340
- dataSourceId: string;
1341
- /**
1342
- * Maximum number of documents to return in a single page. Enables pagination for retrieving large document sets efficiently. Valid range: 1-500. Defaults to 50 if not specified
1343
- * @public
1344
- */
1345
- limit?: number | undefined;
1346
- /**
1347
- * Number of documents to skip from the beginning for pagination. Use with limit to retrieve specific document pages. Example: 0 for first page, 50 for second page with limit=50. Defaults to 0 if not specified
1274
+ * Unique identifier of the knowledge base
1348
1275
  * @public
1349
1276
  */
1350
- offset?: number | undefined;
1277
+ knowledgeBaseId: string;
1351
1278
  }
1352
1279
  /**
1353
1280
  * @public
1354
1281
  */
1355
- export interface ListDocumentsOutput {
1356
- documents: (DocumentItem)[];
1282
+ export interface GetKnowledgeBaseOutput {
1283
+ knowledgeBase: KnowledgeBaseItem;
1357
1284
  }
1358
1285
  /**
1359
1286
  * @public
1360
1287
  */
1361
- export interface ListKnowledgeBasesInput {
1288
+ export interface ListDataSourcesInput {
1362
1289
  /**
1363
1290
  * The unique identifier of the tenant when a service token is used.
1364
1291
  * @public
@@ -1368,137 +1295,138 @@ export interface ListKnowledgeBasesInput {
1368
1295
  /**
1369
1296
  * @public
1370
1297
  */
1371
- export interface ListKnowledgeBasesOutput {
1372
- knowledgeBases: (KnowledgeBaseItem)[];
1298
+ export interface ListDataSourcesOutput {
1299
+ dataSources: (DataSourceItem)[];
1373
1300
  }
1374
1301
  /**
1375
1302
  * @public
1376
1303
  */
1377
- export interface LlmConfig {
1378
- /**
1379
- * The specific provider and model identifier. Examples: 'openai/gpt-4o' or 'openai/gpt-4o-mini' for OpenAI, 'mistral/mistral-small-2506' for Mistral. Check provider documentation for available models
1380
- * @public
1381
- */
1382
- model?: string | undefined;
1383
- /**
1384
- * Controls answer randomness and creativity (0.0-1.0). Low values (0.0-0.3) produce consistent, deterministic answers. High values (0.7-1.0) produce more diverse and creative responses. Defaults to 0.3 for factual consistency
1385
- * @public
1386
- */
1387
- temperature?: number | undefined;
1304
+ export interface ListDataSourceStatisticsInput {
1388
1305
  /**
1389
- * Maximum number of tokens in the generated answer (1-10000). Higher values allow longer, more detailed answers. Lower values force concise responses. Defaults to 1000 tokens. Note: higher values increase latency and cost
1306
+ * The unique identifier of the tenant when a service token is used.
1390
1307
  * @public
1391
1308
  */
1392
- maxOutputTokens?: number | undefined;
1309
+ companyId?: string | undefined;
1393
1310
  /**
1394
- * Optional system prompt to customize LLM behavior and context. Sets instructions for how the LLM should answer questions. Example: 'You are a helpful technical support assistant. Answer only based on the provided knowledge base. If information is not found, say "I don't have this information in the knowledge base."'
1311
+ * Unique identifier of the data source
1395
1312
  * @public
1396
1313
  */
1397
- systemPrompt?: string | undefined;
1314
+ dataSourceId: string;
1315
+ }
1316
+ /**
1317
+ * @public
1318
+ */
1319
+ export interface ListDataSourceStatisticsOutput {
1320
+ documentsCount: number;
1321
+ chunksCount: number;
1398
1322
  }
1399
1323
  /**
1400
1324
  * @public
1401
1325
  * @enum
1402
1326
  */
1403
- export declare const SearchStrategy: {
1404
- readonly BM25: "bm25";
1405
- readonly HYBRID: "hybrid";
1406
- readonly VECTOR: "vector";
1327
+ export declare const SyncLogLevel: {
1328
+ readonly DEBUG: "debug";
1329
+ readonly ERROR: "error";
1330
+ readonly INFO: "info";
1331
+ readonly WARN: "warn";
1407
1332
  };
1408
1333
  /**
1409
1334
  * @public
1410
1335
  */
1411
- export type SearchStrategy = typeof SearchStrategy[keyof typeof SearchStrategy];
1336
+ export type SyncLogLevel = typeof SyncLogLevel[keyof typeof SyncLogLevel];
1412
1337
  /**
1413
1338
  * @public
1414
1339
  */
1415
- export interface SearchConfig {
1340
+ export interface ListDataSourceSynchronizationLogsInput {
1416
1341
  /**
1417
- * Maximum number of search results to return. Controls the size of the result set. Valid range: 1-50. Defaults to 10 if not specified. Higher values return more results but may include less relevant matches
1342
+ * The unique identifier of the tenant when a service token is used.
1418
1343
  * @public
1419
1344
  */
1420
- topK?: number | undefined;
1345
+ companyId?: string | undefined;
1346
+ limit?: number | undefined;
1347
+ offset?: number | undefined;
1421
1348
  /**
1422
- * Minimum similarity score (0.0-1.0) required for results to be included. Higher threshold filters out less relevant results. Example: 0.5 means only results with 50% or higher similarity are returned. Defaults to 0.5. Adjust based on relevance requirements
1349
+ * Sort order of the results. If there is a '-' prefix, the results will be sorted in descending order. Otherwise, the results will be sorted in ascending order. Example: '-createdAt' will sort the results by createdAt in descending order. 'createdAt' will sort the results by createdAt in ascending order.
1423
1350
  * @public
1424
1351
  */
1425
- threshold?: number | undefined;
1352
+ sort?: string | undefined;
1426
1353
  /**
1427
- * Search algorithm strategy: 'bm25' (full-text keyword search), 'vector' (semantic similarity search using embeddings), 'hybrid' (combines both methods for best results). Defaults to 'hybrid' if not specified
1354
+ * Unique identifier of the data source
1428
1355
  * @public
1429
1356
  */
1430
- searchStrategy?: SearchStrategy | undefined;
1357
+ dataSourceId: string;
1431
1358
  /**
1432
- * Whether to optimize and transform the input query using advanced NLP techniques before searching. Improves search quality for complex or poorly phrased queries. Defaults to false. Set to true for better results with natural language questions
1359
+ * The log level to filter the sync logs by. Possible values: 'debug', 'info', 'warn', 'error'.
1433
1360
  * @public
1434
1361
  */
1435
- useQueryOptimization?: boolean | undefined;
1362
+ logLevel?: SyncLogLevel | undefined;
1436
1363
  /**
1437
- * Whether to enrich search results with additional contextual metadata. Includes document metadata, chunk position information, and related document information. Defaults to false. Set to true for comprehensive result context
1364
+ * The search query string for filtering the history results.
1438
1365
  * @public
1439
1366
  */
1440
- extendMetadata?: boolean | undefined;
1367
+ search?: string | undefined;
1368
+ }
1369
+ /**
1370
+ * @public
1371
+ */
1372
+ export interface SyncLogItem {
1373
+ timestamp: string;
1374
+ level: SyncLogLevel;
1375
+ message: string;
1441
1376
  }
1442
1377
  /**
1443
1378
  * @public
1444
1379
  */
1445
- export interface QueryKnowledgeBaseInput {
1380
+ export interface ListDataSourceSynchronizationLogsOutput {
1381
+ logs: (SyncLogItem)[];
1382
+ }
1383
+ /**
1384
+ * @public
1385
+ */
1386
+ export interface ListDocumentsInput {
1446
1387
  /**
1447
1388
  * The unique identifier of the tenant when a service token is used.
1448
1389
  * @public
1449
1390
  */
1450
1391
  companyId?: string | undefined;
1451
1392
  /**
1452
- * Unique identifier of the knowledge base
1453
- * @public
1454
- */
1455
- knowledgeBaseId: string;
1456
- /**
1457
- * The question or query to be answered using the knowledge base. The LLM will search the knowledge base and generate an answer based on found results. Example: 'What is the product knowledge base?'
1458
- * @public
1459
- */
1460
- query: string;
1461
- /**
1462
- * Optional search configuration to customize how documents are retrieved from the knowledge base. Controls result count, similarity threshold, and search strategy
1463
- * @public
1464
- */
1465
- searchConfig?: SearchConfig | undefined;
1466
- /**
1467
- * Optional LLM configuration to customize the answer generation. Allows specifying the LLM provider, model, temperature, and system prompt
1393
+ * Unique identifier of the data source
1468
1394
  * @public
1469
1395
  */
1470
- llmConfig?: LlmConfig | undefined;
1396
+ dataSourceId: string;
1471
1397
  /**
1472
- * The user who performs the search in the knowledge base. Example: user@example.com
1398
+ * Maximum number of documents to return in a single page. Enables pagination for retrieving large document sets efficiently. Valid range: 1-500. Defaults to 50 if not specified
1473
1399
  * @public
1474
1400
  */
1475
- searchUser?: string | undefined;
1401
+ limit?: number | undefined;
1476
1402
  /**
1477
- * The external session ID from the client.
1403
+ * Number of documents to skip from the beginning for pagination. Use with limit to retrieve specific document pages. Example: 0 for first page, 50 for second page with limit=50. Defaults to 0 if not specified
1478
1404
  * @public
1479
1405
  */
1480
- externalSessionId?: string | undefined;
1406
+ offset?: number | undefined;
1481
1407
  }
1482
1408
  /**
1483
1409
  * @public
1484
1410
  */
1485
- export interface QueryKnowledgeBaseOutput {
1486
- answer: string;
1487
- metadata: __DocumentType;
1488
- sources: __DocumentType;
1411
+ export interface ListDocumentsOutput {
1412
+ documents: (DocumentItem)[];
1489
1413
  }
1490
1414
  /**
1491
1415
  * @public
1492
- * @enum
1493
1416
  */
1494
- export declare const SearchHistoryMode: {
1495
- readonly AI_ANSWER: "ai_answer";
1496
- readonly SEARCH: "search";
1497
- };
1417
+ export interface ListKnowledgeBasesInput {
1418
+ /**
1419
+ * The unique identifier of the tenant when a service token is used.
1420
+ * @public
1421
+ */
1422
+ companyId?: string | undefined;
1423
+ }
1498
1424
  /**
1499
1425
  * @public
1500
1426
  */
1501
- export type SearchHistoryMode = typeof SearchHistoryMode[keyof typeof SearchHistoryMode];
1427
+ export interface ListKnowledgeBasesOutput {
1428
+ knowledgeBases: (KnowledgeBaseItem)[];
1429
+ }
1502
1430
  /**
1503
1431
  * @public
1504
1432
  */
@@ -1528,16 +1456,11 @@ export interface SearchHistoryFilter {
1528
1456
  * @public
1529
1457
  */
1530
1458
  searchUser?: string | undefined;
1531
- /**
1532
- * Filter history by the mode of the search. Can by 'search' or 'ai_answer'.
1533
- * @public
1534
- */
1535
- mode?: SearchHistoryMode | undefined;
1536
1459
  }
1537
1460
  /**
1538
1461
  * @public
1539
1462
  */
1540
- export interface SearchHistoryInput {
1463
+ export interface ListSearchQueriesHistoryInput {
1541
1464
  /**
1542
1465
  * The unique identifier of the tenant when a service token is used.
1543
1466
  * @public
@@ -1564,9 +1487,35 @@ export interface SearchHistoryInput {
1564
1487
  /**
1565
1488
  * @public
1566
1489
  */
1567
- export interface SearchHistoryOutput {
1490
+ export interface ListSearchQueriesHistoryOutput {
1568
1491
  results: (__DocumentType)[];
1569
1492
  }
1493
+ /**
1494
+ * @public
1495
+ * @enum
1496
+ */
1497
+ export declare const SearchStrategy: {
1498
+ readonly BM25: "bm25";
1499
+ readonly HYBRID: "hybrid";
1500
+ readonly VECTOR: "vector";
1501
+ };
1502
+ /**
1503
+ * @public
1504
+ */
1505
+ export type SearchStrategy = typeof SearchStrategy[keyof typeof SearchStrategy];
1506
+ /**
1507
+ * @public
1508
+ * @enum
1509
+ */
1510
+ export declare const SearchThresholdValue: {
1511
+ readonly HIGH: "high";
1512
+ readonly LOW: "low";
1513
+ readonly MEDIUM: "medium";
1514
+ };
1515
+ /**
1516
+ * @public
1517
+ */
1518
+ export type SearchThresholdValue = typeof SearchThresholdValue[keyof typeof SearchThresholdValue];
1570
1519
  /**
1571
1520
  * @public
1572
1521
  */
@@ -1587,49 +1536,35 @@ export interface SearchKnowledgeBaseInput {
1587
1536
  */
1588
1537
  query: string;
1589
1538
  /**
1590
- * Optional search configuration to customize the search behavior. Allows control over number of results (topK), similarity threshold, search strategy (BM25, vector, or hybrid), and result optimization
1591
- * @public
1592
- */
1593
- searchConfig?: SearchConfig | undefined;
1594
- /**
1595
- * Whether to include comprehensive metadata in the search results. When enabled, returns additional context information for each result
1539
+ * Search algorithm strategy: 'bm25' (full-text keyword search), 'vector' (semantic similarity search using embeddings), 'hybrid' (combines both methods for best results). Defaults to 'hybrid' if not specified
1596
1540
  * @public
1597
1541
  */
1598
- withMetadata?: boolean | undefined;
1542
+ searchStrategy?: SearchStrategy | undefined;
1599
1543
  /**
1600
- * The user who performs the search in the knowledge base. Example: user@example.com
1544
+ * Maximum number of search results to return. Controls the size of the result set. Valid range: 1-50. Defaults to 10 if not specified. Higher values return more results but may include less relevant matches
1601
1545
  * @public
1602
1546
  */
1603
- searchUser?: string | undefined;
1547
+ searchLimit?: number | undefined;
1604
1548
  /**
1605
- * The external session ID. Used for tracking and analytics purposes. Example: 123e4567-e89b-12d3-a456-426614174000
1549
+ * Minimum similarity required for results to be included.
1606
1550
  * @public
1607
1551
  */
1608
- externalSessionId?: string | undefined;
1609
- }
1610
- /**
1611
- * @public
1612
- */
1613
- export interface SearchKnowledgeBaseResult {
1552
+ searchThreshold?: SearchThresholdValue | undefined;
1614
1553
  /**
1615
- * Unique identifier of the document
1554
+ * Whether to optimize and transform the input query using advanced NLP techniques before searching. Improves search quality for complex or poorly phrased queries. Defaults to false. Set to true for better results with natural language questions
1616
1555
  * @public
1617
1556
  */
1618
- documentId: string;
1619
- documentTitle: string;
1620
- documentUrl: string;
1557
+ useQueryOptimization?: boolean | undefined;
1621
1558
  /**
1622
- * Unique identifier of the data source
1559
+ * The user who performs the search in the knowledge base. Example: user@example.com
1623
1560
  * @public
1624
1561
  */
1625
- dataSourceId: string;
1626
- dataSourceType: DataSourceType;
1627
- content: string;
1562
+ searchUser?: string | undefined;
1628
1563
  /**
1629
- * The total score of the result, calculated from the semantic search score and the full-text search score.
1564
+ * The external session ID. Used for tracking and analytics purposes. Example: 123e4567-e89b-12d3-a456-426614174000
1630
1565
  * @public
1631
1566
  */
1632
- score: number;
1567
+ externalSessionId?: string | undefined;
1633
1568
  }
1634
1569
  /**
1635
1570
  * @public
@@ -1656,7 +1591,7 @@ export interface StartSyncDataSourceInput {
1656
1591
  * The synchronization mode to use. 'full' performs a complete re-sync of all data, 'incremental' syncs only new or modified data since the last sync. Defaults to 'full' if not specified
1657
1592
  * @public
1658
1593
  */
1659
- syncType: SyncDataSourceMode;
1594
+ syncType?: SyncDataSourceMode | undefined;
1660
1595
  }
1661
1596
  /**
1662
1597
  * @public