@nestbox-ai/documents 1.0.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts ADDED
@@ -0,0 +1,723 @@
1
+ /**
2
+ * Nestbox API Documents API
3
+ * API for Nestbox Documents, control your documents
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from './configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import type { RequestArgs } from './base';
15
+ import { BaseAPI } from './base';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface BadRequestExceptionResponse
20
+ */
21
+ export interface BadRequestExceptionResponse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof BadRequestExceptionResponse
26
+ */
27
+ 'message': string;
28
+ /**
29
+ *
30
+ * @type {object}
31
+ * @memberof BadRequestExceptionResponse
32
+ */
33
+ 'errors': object | null;
34
+ }
35
+ /**
36
+ *
37
+ * @export
38
+ * @interface ChunkFileRequestDTO
39
+ */
40
+ export interface ChunkFileRequestDTO {
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof ChunkFileRequestDTO
45
+ */
46
+ 'type': string;
47
+ /**
48
+ *
49
+ * @type {string}
50
+ * @memberof ChunkFileRequestDTO
51
+ */
52
+ 'url': string;
53
+ /**
54
+ *
55
+ * @type {object}
56
+ * @memberof ChunkFileRequestDTO
57
+ */
58
+ 'options': object;
59
+ }
60
+ /**
61
+ *
62
+ * @export
63
+ * @interface CreateCollectionRequestDTO
64
+ */
65
+ export interface CreateCollectionRequestDTO {
66
+ /**
67
+ *
68
+ * @type {string}
69
+ * @memberof CreateCollectionRequestDTO
70
+ */
71
+ 'name': string;
72
+ /**
73
+ *
74
+ * @type {object}
75
+ * @memberof CreateCollectionRequestDTO
76
+ */
77
+ 'metadata': object;
78
+ }
79
+ /**
80
+ *
81
+ * @export
82
+ * @interface CreateDocumentRequestDTO
83
+ */
84
+ export interface CreateDocumentRequestDTO {
85
+ /**
86
+ *
87
+ * @type {string}
88
+ * @memberof CreateDocumentRequestDTO
89
+ */
90
+ 'id': string;
91
+ /**
92
+ *
93
+ * @type {string}
94
+ * @memberof CreateDocumentRequestDTO
95
+ */
96
+ 'document': string;
97
+ /**
98
+ *
99
+ * @type {object}
100
+ * @memberof CreateDocumentRequestDTO
101
+ */
102
+ 'metadata': object;
103
+ }
104
+ /**
105
+ *
106
+ * @export
107
+ * @interface FatalErrorExceptionResponse
108
+ */
109
+ export interface FatalErrorExceptionResponse {
110
+ /**
111
+ *
112
+ * @type {string}
113
+ * @memberof FatalErrorExceptionResponse
114
+ */
115
+ 'message': string;
116
+ }
117
+ /**
118
+ *
119
+ * @export
120
+ * @interface ForbiddenExceptionResponse
121
+ */
122
+ export interface ForbiddenExceptionResponse {
123
+ /**
124
+ *
125
+ * @type {string}
126
+ * @memberof ForbiddenExceptionResponse
127
+ */
128
+ 'message': string;
129
+ }
130
+ /**
131
+ *
132
+ * @export
133
+ * @interface MessageResponseDTO
134
+ */
135
+ export interface MessageResponseDTO {
136
+ /**
137
+ *
138
+ * @type {string}
139
+ * @memberof MessageResponseDTO
140
+ */
141
+ 'message': string;
142
+ }
143
+ /**
144
+ *
145
+ * @export
146
+ * @interface NotFoundExceptionResponse
147
+ */
148
+ export interface NotFoundExceptionResponse {
149
+ /**
150
+ *
151
+ * @type {string}
152
+ * @memberof NotFoundExceptionResponse
153
+ */
154
+ 'message': string;
155
+ }
156
+ /**
157
+ *
158
+ * @export
159
+ * @interface SimilaritySearchQueryDTO
160
+ */
161
+ export interface SimilaritySearchQueryDTO {
162
+ /**
163
+ *
164
+ * @type {string}
165
+ * @memberof SimilaritySearchQueryDTO
166
+ */
167
+ 'query': string;
168
+ /**
169
+ *
170
+ * @type {object}
171
+ * @memberof SimilaritySearchQueryDTO
172
+ */
173
+ 'params': object;
174
+ /**
175
+ *
176
+ * @type {object}
177
+ * @memberof SimilaritySearchQueryDTO
178
+ */
179
+ 'filter': object;
180
+ /**
181
+ *
182
+ * @type {Array<string>}
183
+ * @memberof SimilaritySearchQueryDTO
184
+ */
185
+ 'include': Array<string>;
186
+ }
187
+ /**
188
+ *
189
+ * @export
190
+ * @interface UnauthorizedExceptionResponse
191
+ */
192
+ export interface UnauthorizedExceptionResponse {
193
+ /**
194
+ *
195
+ * @type {string}
196
+ * @memberof UnauthorizedExceptionResponse
197
+ */
198
+ 'message': string;
199
+ }
200
+ /**
201
+ *
202
+ * @export
203
+ * @interface UpdateDocumentRequestDTO
204
+ */
205
+ export interface UpdateDocumentRequestDTO {
206
+ /**
207
+ *
208
+ * @type {string}
209
+ * @memberof UpdateDocumentRequestDTO
210
+ */
211
+ 'document': string;
212
+ /**
213
+ *
214
+ * @type {object}
215
+ * @memberof UpdateDocumentRequestDTO
216
+ */
217
+ 'metadata': object;
218
+ }
219
+ /**
220
+ * AppApi - axios parameter creator
221
+ * @export
222
+ */
223
+ export declare const AppApiAxiosParamCreator: (configuration?: Configuration) => {
224
+ /**
225
+ *
226
+ * @param {*} [options] Override http request option.
227
+ * @throws {RequiredError}
228
+ */
229
+ appControllerGetHello: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
230
+ };
231
+ /**
232
+ * AppApi - functional programming interface
233
+ * @export
234
+ */
235
+ export declare const AppApiFp: (configuration?: Configuration) => {
236
+ /**
237
+ *
238
+ * @param {*} [options] Override http request option.
239
+ * @throws {RequiredError}
240
+ */
241
+ appControllerGetHello(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
242
+ };
243
+ /**
244
+ * AppApi - factory interface
245
+ * @export
246
+ */
247
+ export declare const AppApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
248
+ /**
249
+ *
250
+ * @param {*} [options] Override http request option.
251
+ * @throws {RequiredError}
252
+ */
253
+ appControllerGetHello(options?: RawAxiosRequestConfig): AxiosPromise<void>;
254
+ };
255
+ /**
256
+ * AppApi - object-oriented interface
257
+ * @export
258
+ * @class AppApi
259
+ * @extends {BaseAPI}
260
+ */
261
+ export declare class AppApi extends BaseAPI {
262
+ /**
263
+ *
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ * @memberof AppApi
267
+ */
268
+ appControllerGetHello(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
269
+ }
270
+ /**
271
+ * CollectionApi - axios parameter creator
272
+ * @export
273
+ */
274
+ export declare const CollectionApiAxiosParamCreator: (configuration?: Configuration) => {
275
+ /**
276
+ *
277
+ * @summary Add a new doc
278
+ * @param {string} collectionId
279
+ * @param {CreateDocumentRequestDTO} createDocumentRequestDTO
280
+ * @param {*} [options] Override http request option.
281
+ * @throws {RequiredError}
282
+ */
283
+ collectionControllerAddDocToCollection: (collectionId: string, createDocumentRequestDTO: CreateDocumentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
284
+ /**
285
+ *
286
+ * @summary Use a file to chunk and add to collection
287
+ * @param {string} collectionId
288
+ * @param {ChunkFileRequestDTO} chunkFileRequestDTO
289
+ * @param {*} [options] Override http request option.
290
+ * @throws {RequiredError}
291
+ */
292
+ collectionControllerChunkFileToCollection: (collectionId: string, chunkFileRequestDTO: ChunkFileRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
293
+ /**
294
+ *
295
+ * @summary Create a new collection
296
+ * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
297
+ * @param {*} [options] Override http request option.
298
+ * @throws {RequiredError}
299
+ */
300
+ collectionControllerCreateCollection: (createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
301
+ /**
302
+ *
303
+ * @summary Delete a collection
304
+ * @param {string} collectionId
305
+ * @param {*} [options] Override http request option.
306
+ * @throws {RequiredError}
307
+ */
308
+ collectionControllerDeleteCollection: (collectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
309
+ /**
310
+ *
311
+ * @summary Delete doc by ID
312
+ * @param {string} collectionId
313
+ * @param {string} docId
314
+ * @param {*} [options] Override http request option.
315
+ * @throws {RequiredError}
316
+ */
317
+ collectionControllerDeleteDoc: (collectionId: string, docId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
318
+ /**
319
+ *
320
+ * @summary Delete docs based on metadata filter
321
+ * @param {string} collectionId
322
+ * @param {string} filter
323
+ * @param {*} [options] Override http request option.
324
+ * @throws {RequiredError}
325
+ */
326
+ collectionControllerDeleteDocsByMetadata: (collectionId: string, filter: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
327
+ /**
328
+ *
329
+ * @summary Get a collection info
330
+ * @param {string} collectionId
331
+ * @param {*} [options] Override http request option.
332
+ * @throws {RequiredError}
333
+ */
334
+ collectionControllerGetCollection: (collectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
335
+ /**
336
+ *
337
+ * @summary List all collections
338
+ * @param {*} [options] Override http request option.
339
+ * @throws {RequiredError}
340
+ */
341
+ collectionControllerGetCollections: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
342
+ /**
343
+ *
344
+ * @summary Retrieve doc by ID
345
+ * @param {string} collectionId
346
+ * @param {string} docId
347
+ * @param {*} [options] Override http request option.
348
+ * @throws {RequiredError}
349
+ */
350
+ collectionControllerGetDocById: (collectionId: string, docId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
351
+ /**
352
+ *
353
+ * @summary Similarity search query
354
+ * @param {string} collectionId
355
+ * @param {SimilaritySearchQueryDTO} similaritySearchQueryDTO
356
+ * @param {*} [options] Override http request option.
357
+ * @throws {RequiredError}
358
+ */
359
+ collectionControllerSimilaritySearch: (collectionId: string, similaritySearchQueryDTO: SimilaritySearchQueryDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
360
+ /**
361
+ *
362
+ * @summary Updates a collection
363
+ * @param {string} collectionId
364
+ * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
365
+ * @param {*} [options] Override http request option.
366
+ * @throws {RequiredError}
367
+ */
368
+ collectionControllerUpdateCollection: (collectionId: string, createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
369
+ /**
370
+ *
371
+ * @summary Update or upsert doc
372
+ * @param {string} collectionId
373
+ * @param {string} docId
374
+ * @param {UpdateDocumentRequestDTO} updateDocumentRequestDTO
375
+ * @param {*} [options] Override http request option.
376
+ * @throws {RequiredError}
377
+ */
378
+ collectionControllerUpdateDoc: (collectionId: string, docId: string, updateDocumentRequestDTO: UpdateDocumentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
379
+ };
380
+ /**
381
+ * CollectionApi - functional programming interface
382
+ * @export
383
+ */
384
+ export declare const CollectionApiFp: (configuration?: Configuration) => {
385
+ /**
386
+ *
387
+ * @summary Add a new doc
388
+ * @param {string} collectionId
389
+ * @param {CreateDocumentRequestDTO} createDocumentRequestDTO
390
+ * @param {*} [options] Override http request option.
391
+ * @throws {RequiredError}
392
+ */
393
+ collectionControllerAddDocToCollection(collectionId: string, createDocumentRequestDTO: CreateDocumentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
394
+ /**
395
+ *
396
+ * @summary Use a file to chunk and add to collection
397
+ * @param {string} collectionId
398
+ * @param {ChunkFileRequestDTO} chunkFileRequestDTO
399
+ * @param {*} [options] Override http request option.
400
+ * @throws {RequiredError}
401
+ */
402
+ collectionControllerChunkFileToCollection(collectionId: string, chunkFileRequestDTO: ChunkFileRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
403
+ /**
404
+ *
405
+ * @summary Create a new collection
406
+ * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
407
+ * @param {*} [options] Override http request option.
408
+ * @throws {RequiredError}
409
+ */
410
+ collectionControllerCreateCollection(createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
411
+ /**
412
+ *
413
+ * @summary Delete a collection
414
+ * @param {string} collectionId
415
+ * @param {*} [options] Override http request option.
416
+ * @throws {RequiredError}
417
+ */
418
+ collectionControllerDeleteCollection(collectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
419
+ /**
420
+ *
421
+ * @summary Delete doc by ID
422
+ * @param {string} collectionId
423
+ * @param {string} docId
424
+ * @param {*} [options] Override http request option.
425
+ * @throws {RequiredError}
426
+ */
427
+ collectionControllerDeleteDoc(collectionId: string, docId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
428
+ /**
429
+ *
430
+ * @summary Delete docs based on metadata filter
431
+ * @param {string} collectionId
432
+ * @param {string} filter
433
+ * @param {*} [options] Override http request option.
434
+ * @throws {RequiredError}
435
+ */
436
+ collectionControllerDeleteDocsByMetadata(collectionId: string, filter: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
437
+ /**
438
+ *
439
+ * @summary Get a collection info
440
+ * @param {string} collectionId
441
+ * @param {*} [options] Override http request option.
442
+ * @throws {RequiredError}
443
+ */
444
+ collectionControllerGetCollection(collectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
445
+ /**
446
+ *
447
+ * @summary List all collections
448
+ * @param {*} [options] Override http request option.
449
+ * @throws {RequiredError}
450
+ */
451
+ collectionControllerGetCollections(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
452
+ /**
453
+ *
454
+ * @summary Retrieve doc by ID
455
+ * @param {string} collectionId
456
+ * @param {string} docId
457
+ * @param {*} [options] Override http request option.
458
+ * @throws {RequiredError}
459
+ */
460
+ collectionControllerGetDocById(collectionId: string, docId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
461
+ /**
462
+ *
463
+ * @summary Similarity search query
464
+ * @param {string} collectionId
465
+ * @param {SimilaritySearchQueryDTO} similaritySearchQueryDTO
466
+ * @param {*} [options] Override http request option.
467
+ * @throws {RequiredError}
468
+ */
469
+ collectionControllerSimilaritySearch(collectionId: string, similaritySearchQueryDTO: SimilaritySearchQueryDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
470
+ /**
471
+ *
472
+ * @summary Updates a collection
473
+ * @param {string} collectionId
474
+ * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
475
+ * @param {*} [options] Override http request option.
476
+ * @throws {RequiredError}
477
+ */
478
+ collectionControllerUpdateCollection(collectionId: string, createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
479
+ /**
480
+ *
481
+ * @summary Update or upsert doc
482
+ * @param {string} collectionId
483
+ * @param {string} docId
484
+ * @param {UpdateDocumentRequestDTO} updateDocumentRequestDTO
485
+ * @param {*} [options] Override http request option.
486
+ * @throws {RequiredError}
487
+ */
488
+ collectionControllerUpdateDoc(collectionId: string, docId: string, updateDocumentRequestDTO: UpdateDocumentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponseDTO>>;
489
+ };
490
+ /**
491
+ * CollectionApi - factory interface
492
+ * @export
493
+ */
494
+ export declare const CollectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
495
+ /**
496
+ *
497
+ * @summary Add a new doc
498
+ * @param {string} collectionId
499
+ * @param {CreateDocumentRequestDTO} createDocumentRequestDTO
500
+ * @param {*} [options] Override http request option.
501
+ * @throws {RequiredError}
502
+ */
503
+ collectionControllerAddDocToCollection(collectionId: string, createDocumentRequestDTO: CreateDocumentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
504
+ /**
505
+ *
506
+ * @summary Use a file to chunk and add to collection
507
+ * @param {string} collectionId
508
+ * @param {ChunkFileRequestDTO} chunkFileRequestDTO
509
+ * @param {*} [options] Override http request option.
510
+ * @throws {RequiredError}
511
+ */
512
+ collectionControllerChunkFileToCollection(collectionId: string, chunkFileRequestDTO: ChunkFileRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
513
+ /**
514
+ *
515
+ * @summary Create a new collection
516
+ * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
517
+ * @param {*} [options] Override http request option.
518
+ * @throws {RequiredError}
519
+ */
520
+ collectionControllerCreateCollection(createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
521
+ /**
522
+ *
523
+ * @summary Delete a collection
524
+ * @param {string} collectionId
525
+ * @param {*} [options] Override http request option.
526
+ * @throws {RequiredError}
527
+ */
528
+ collectionControllerDeleteCollection(collectionId: string, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
529
+ /**
530
+ *
531
+ * @summary Delete doc by ID
532
+ * @param {string} collectionId
533
+ * @param {string} docId
534
+ * @param {*} [options] Override http request option.
535
+ * @throws {RequiredError}
536
+ */
537
+ collectionControllerDeleteDoc(collectionId: string, docId: string, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
538
+ /**
539
+ *
540
+ * @summary Delete docs based on metadata filter
541
+ * @param {string} collectionId
542
+ * @param {string} filter
543
+ * @param {*} [options] Override http request option.
544
+ * @throws {RequiredError}
545
+ */
546
+ collectionControllerDeleteDocsByMetadata(collectionId: string, filter: string, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
547
+ /**
548
+ *
549
+ * @summary Get a collection info
550
+ * @param {string} collectionId
551
+ * @param {*} [options] Override http request option.
552
+ * @throws {RequiredError}
553
+ */
554
+ collectionControllerGetCollection(collectionId: string, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
555
+ /**
556
+ *
557
+ * @summary List all collections
558
+ * @param {*} [options] Override http request option.
559
+ * @throws {RequiredError}
560
+ */
561
+ collectionControllerGetCollections(options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
562
+ /**
563
+ *
564
+ * @summary Retrieve doc by ID
565
+ * @param {string} collectionId
566
+ * @param {string} docId
567
+ * @param {*} [options] Override http request option.
568
+ * @throws {RequiredError}
569
+ */
570
+ collectionControllerGetDocById(collectionId: string, docId: string, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
571
+ /**
572
+ *
573
+ * @summary Similarity search query
574
+ * @param {string} collectionId
575
+ * @param {SimilaritySearchQueryDTO} similaritySearchQueryDTO
576
+ * @param {*} [options] Override http request option.
577
+ * @throws {RequiredError}
578
+ */
579
+ collectionControllerSimilaritySearch(collectionId: string, similaritySearchQueryDTO: SimilaritySearchQueryDTO, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
580
+ /**
581
+ *
582
+ * @summary Updates a collection
583
+ * @param {string} collectionId
584
+ * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
585
+ * @param {*} [options] Override http request option.
586
+ * @throws {RequiredError}
587
+ */
588
+ collectionControllerUpdateCollection(collectionId: string, createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
589
+ /**
590
+ *
591
+ * @summary Update or upsert doc
592
+ * @param {string} collectionId
593
+ * @param {string} docId
594
+ * @param {UpdateDocumentRequestDTO} updateDocumentRequestDTO
595
+ * @param {*} [options] Override http request option.
596
+ * @throws {RequiredError}
597
+ */
598
+ collectionControllerUpdateDoc(collectionId: string, docId: string, updateDocumentRequestDTO: UpdateDocumentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponseDTO>;
599
+ };
600
+ /**
601
+ * CollectionApi - object-oriented interface
602
+ * @export
603
+ * @class CollectionApi
604
+ * @extends {BaseAPI}
605
+ */
606
+ export declare class CollectionApi extends BaseAPI {
607
+ /**
608
+ *
609
+ * @summary Add a new doc
610
+ * @param {string} collectionId
611
+ * @param {CreateDocumentRequestDTO} createDocumentRequestDTO
612
+ * @param {*} [options] Override http request option.
613
+ * @throws {RequiredError}
614
+ * @memberof CollectionApi
615
+ */
616
+ collectionControllerAddDocToCollection(collectionId: string, createDocumentRequestDTO: CreateDocumentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
617
+ /**
618
+ *
619
+ * @summary Use a file to chunk and add to collection
620
+ * @param {string} collectionId
621
+ * @param {ChunkFileRequestDTO} chunkFileRequestDTO
622
+ * @param {*} [options] Override http request option.
623
+ * @throws {RequiredError}
624
+ * @memberof CollectionApi
625
+ */
626
+ collectionControllerChunkFileToCollection(collectionId: string, chunkFileRequestDTO: ChunkFileRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
627
+ /**
628
+ *
629
+ * @summary Create a new collection
630
+ * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
631
+ * @param {*} [options] Override http request option.
632
+ * @throws {RequiredError}
633
+ * @memberof CollectionApi
634
+ */
635
+ collectionControllerCreateCollection(createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
636
+ /**
637
+ *
638
+ * @summary Delete a collection
639
+ * @param {string} collectionId
640
+ * @param {*} [options] Override http request option.
641
+ * @throws {RequiredError}
642
+ * @memberof CollectionApi
643
+ */
644
+ collectionControllerDeleteCollection(collectionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
645
+ /**
646
+ *
647
+ * @summary Delete doc by ID
648
+ * @param {string} collectionId
649
+ * @param {string} docId
650
+ * @param {*} [options] Override http request option.
651
+ * @throws {RequiredError}
652
+ * @memberof CollectionApi
653
+ */
654
+ collectionControllerDeleteDoc(collectionId: string, docId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
655
+ /**
656
+ *
657
+ * @summary Delete docs based on metadata filter
658
+ * @param {string} collectionId
659
+ * @param {string} filter
660
+ * @param {*} [options] Override http request option.
661
+ * @throws {RequiredError}
662
+ * @memberof CollectionApi
663
+ */
664
+ collectionControllerDeleteDocsByMetadata(collectionId: string, filter: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
665
+ /**
666
+ *
667
+ * @summary Get a collection info
668
+ * @param {string} collectionId
669
+ * @param {*} [options] Override http request option.
670
+ * @throws {RequiredError}
671
+ * @memberof CollectionApi
672
+ */
673
+ collectionControllerGetCollection(collectionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
674
+ /**
675
+ *
676
+ * @summary List all collections
677
+ * @param {*} [options] Override http request option.
678
+ * @throws {RequiredError}
679
+ * @memberof CollectionApi
680
+ */
681
+ collectionControllerGetCollections(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
682
+ /**
683
+ *
684
+ * @summary Retrieve doc by ID
685
+ * @param {string} collectionId
686
+ * @param {string} docId
687
+ * @param {*} [options] Override http request option.
688
+ * @throws {RequiredError}
689
+ * @memberof CollectionApi
690
+ */
691
+ collectionControllerGetDocById(collectionId: string, docId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
692
+ /**
693
+ *
694
+ * @summary Similarity search query
695
+ * @param {string} collectionId
696
+ * @param {SimilaritySearchQueryDTO} similaritySearchQueryDTO
697
+ * @param {*} [options] Override http request option.
698
+ * @throws {RequiredError}
699
+ * @memberof CollectionApi
700
+ */
701
+ collectionControllerSimilaritySearch(collectionId: string, similaritySearchQueryDTO: SimilaritySearchQueryDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
702
+ /**
703
+ *
704
+ * @summary Updates a collection
705
+ * @param {string} collectionId
706
+ * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
707
+ * @param {*} [options] Override http request option.
708
+ * @throws {RequiredError}
709
+ * @memberof CollectionApi
710
+ */
711
+ collectionControllerUpdateCollection(collectionId: string, createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
712
+ /**
713
+ *
714
+ * @summary Update or upsert doc
715
+ * @param {string} collectionId
716
+ * @param {string} docId
717
+ * @param {UpdateDocumentRequestDTO} updateDocumentRequestDTO
718
+ * @param {*} [options] Override http request option.
719
+ * @throws {RequiredError}
720
+ * @memberof CollectionApi
721
+ */
722
+ collectionControllerUpdateDoc(collectionId: string, docId: string, updateDocumentRequestDTO: UpdateDocumentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
723
+ }