@nestbox-ai/doc-processing-api 0.0.1 → 1.0.62
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/.openapi-generator/FILES +53 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +120 -44
- package/api.ts +2970 -0
- package/base.ts +62 -0
- package/common.ts +126 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +1771 -0
- package/dist/api.js +2280 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +34 -0
- package/dist/common.js +138 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +1771 -0
- package/dist/esm/api.js +2241 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +34 -0
- package/dist/esm/common.js +125 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/docs/ArtifactsApi.md +61 -0
- package/docs/BatchQueryDto.md +34 -0
- package/docs/CreateWebhookInputDto.md +20 -0
- package/docs/DocumentCreateResponseDto.md +22 -0
- package/docs/DocumentDto.md +38 -0
- package/docs/DocumentSourcesResponseDto.md +20 -0
- package/docs/DocumentsApi.md +186 -0
- package/docs/ErrorDto.md +26 -0
- package/docs/EvalCreateResponseDto.md +22 -0
- package/docs/EvalDto.md +36 -0
- package/docs/EvalsApi.md +243 -0
- package/docs/GpuDeviceDto.md +28 -0
- package/docs/GpuHealthCheckDto.md +26 -0
- package/docs/HealthApi.md +53 -0
- package/docs/HealthCheckItemDto.md +26 -0
- package/docs/HealthChecksDto.md +24 -0
- package/docs/HealthResponseDto.md +24 -0
- package/docs/JobDto.md +48 -0
- package/docs/JobLinksDto.md +22 -0
- package/docs/JobStatusDto.md +32 -0
- package/docs/JobsApi.md +170 -0
- package/docs/PaginatedDocumentsDto.md +22 -0
- package/docs/PaginatedEvalsDto.md +22 -0
- package/docs/PaginatedJobsDto.md +22 -0
- package/docs/PaginatedProfilesDto.md +22 -0
- package/docs/PaginatedQueriesDto.md +22 -0
- package/docs/PaginatedWebhooksDto.md +22 -0
- package/docs/PaginationDto.md +24 -0
- package/docs/ProfileDto.md +32 -0
- package/docs/ProfilesApi.md +220 -0
- package/docs/QueriesApi.md +232 -0
- package/docs/QueryCreateResponseDto.md +22 -0
- package/docs/SourceItemDto.md +32 -0
- package/docs/SourcesApi.md +67 -0
- package/docs/UpdateWebhookBodyInputDto.md +20 -0
- package/docs/ValidationErrorDto.md +26 -0
- package/docs/ValidationIssueDto.md +24 -0
- package/docs/ValidationResultDto.md +24 -0
- package/docs/WebhookDto.md +26 -0
- package/docs/WebhooksApi.md +280 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +29 -6
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,1771 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Nestbox API Documents Processing API
|
|
3
|
+
* API for Nestbox Documents Processing
|
|
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
|
+
export interface BatchQueryDto {
|
|
17
|
+
/**
|
|
18
|
+
* Batch query ID
|
|
19
|
+
*/
|
|
20
|
+
'id': string;
|
|
21
|
+
/**
|
|
22
|
+
* Associated document ID
|
|
23
|
+
*/
|
|
24
|
+
'documentId'?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Batch query status
|
|
27
|
+
*/
|
|
28
|
+
'status': BatchQueryDtoStatusEnum;
|
|
29
|
+
/**
|
|
30
|
+
* Batch query creation timestamp
|
|
31
|
+
*/
|
|
32
|
+
'createdAt': string;
|
|
33
|
+
/**
|
|
34
|
+
* Batch query last update timestamp
|
|
35
|
+
*/
|
|
36
|
+
'updatedAt'?: string;
|
|
37
|
+
/**
|
|
38
|
+
* Latest job ID associated with this batch query
|
|
39
|
+
*/
|
|
40
|
+
'latestJobId'?: string;
|
|
41
|
+
/**
|
|
42
|
+
* YAML file name
|
|
43
|
+
*/
|
|
44
|
+
'yamlFileName'?: string;
|
|
45
|
+
/**
|
|
46
|
+
* Optional stored results (if persisted)
|
|
47
|
+
*/
|
|
48
|
+
'results'?: {
|
|
49
|
+
[key: string]: any;
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
export declare const BatchQueryDtoStatusEnum: {
|
|
53
|
+
readonly Queued: "queued";
|
|
54
|
+
readonly Running: "running";
|
|
55
|
+
readonly Completed: "completed";
|
|
56
|
+
readonly Failed: "failed";
|
|
57
|
+
};
|
|
58
|
+
export type BatchQueryDtoStatusEnum = typeof BatchQueryDtoStatusEnum[keyof typeof BatchQueryDtoStatusEnum];
|
|
59
|
+
export interface CreateWebhookInputDto {
|
|
60
|
+
/**
|
|
61
|
+
* Webhook target URL
|
|
62
|
+
*/
|
|
63
|
+
'url': string;
|
|
64
|
+
}
|
|
65
|
+
export interface DocumentCreateResponseDto {
|
|
66
|
+
/**
|
|
67
|
+
* Created document
|
|
68
|
+
*/
|
|
69
|
+
'document': DocumentDto;
|
|
70
|
+
/**
|
|
71
|
+
* Processing job
|
|
72
|
+
*/
|
|
73
|
+
'job': JobDto;
|
|
74
|
+
}
|
|
75
|
+
export interface DocumentDto {
|
|
76
|
+
/**
|
|
77
|
+
* Document ID
|
|
78
|
+
*/
|
|
79
|
+
'id': string;
|
|
80
|
+
/**
|
|
81
|
+
* Associated profile ID
|
|
82
|
+
*/
|
|
83
|
+
'profileId': string;
|
|
84
|
+
/**
|
|
85
|
+
* Document processing status
|
|
86
|
+
*/
|
|
87
|
+
'status': DocumentDtoStatusEnum;
|
|
88
|
+
/**
|
|
89
|
+
* Original file name
|
|
90
|
+
*/
|
|
91
|
+
'fileName'?: string;
|
|
92
|
+
/**
|
|
93
|
+
* MIME content type
|
|
94
|
+
*/
|
|
95
|
+
'contentType'?: string;
|
|
96
|
+
/**
|
|
97
|
+
* File size in bytes
|
|
98
|
+
*/
|
|
99
|
+
'sizeBytes'?: number;
|
|
100
|
+
/**
|
|
101
|
+
* Document creation timestamp
|
|
102
|
+
*/
|
|
103
|
+
'createdAt': string;
|
|
104
|
+
/**
|
|
105
|
+
* Document last update timestamp
|
|
106
|
+
*/
|
|
107
|
+
'updatedAt'?: string;
|
|
108
|
+
/**
|
|
109
|
+
* Latest job ID associated with this document
|
|
110
|
+
*/
|
|
111
|
+
'latestJobId'?: string;
|
|
112
|
+
/**
|
|
113
|
+
* Optional processing metrics (pages, chunks, entities, etc.)
|
|
114
|
+
*/
|
|
115
|
+
'metrics'?: {
|
|
116
|
+
[key: string]: any;
|
|
117
|
+
};
|
|
118
|
+
}
|
|
119
|
+
export declare const DocumentDtoStatusEnum: {
|
|
120
|
+
readonly Queued: "queued";
|
|
121
|
+
readonly Processing: "processing";
|
|
122
|
+
readonly Ready: "ready";
|
|
123
|
+
readonly Failed: "failed";
|
|
124
|
+
readonly Deleted: "deleted";
|
|
125
|
+
};
|
|
126
|
+
export type DocumentDtoStatusEnum = typeof DocumentDtoStatusEnum[keyof typeof DocumentDtoStatusEnum];
|
|
127
|
+
export interface DocumentSourcesResponseDto {
|
|
128
|
+
/**
|
|
129
|
+
* Source items
|
|
130
|
+
*/
|
|
131
|
+
'data': Array<SourceItemDto>;
|
|
132
|
+
}
|
|
133
|
+
export interface ErrorDto {
|
|
134
|
+
/**
|
|
135
|
+
* Error type
|
|
136
|
+
*/
|
|
137
|
+
'error': string;
|
|
138
|
+
/**
|
|
139
|
+
* Error message
|
|
140
|
+
*/
|
|
141
|
+
'message': string;
|
|
142
|
+
/**
|
|
143
|
+
* Request ID for tracking
|
|
144
|
+
*/
|
|
145
|
+
'requestId'?: string;
|
|
146
|
+
/**
|
|
147
|
+
* Additional error details
|
|
148
|
+
*/
|
|
149
|
+
'details'?: {
|
|
150
|
+
[key: string]: any;
|
|
151
|
+
};
|
|
152
|
+
}
|
|
153
|
+
export interface EvalCreateResponseDto {
|
|
154
|
+
/**
|
|
155
|
+
* Created evaluation
|
|
156
|
+
*/
|
|
157
|
+
'eval': EvalDto;
|
|
158
|
+
/**
|
|
159
|
+
* Processing job
|
|
160
|
+
*/
|
|
161
|
+
'job': JobDto;
|
|
162
|
+
}
|
|
163
|
+
export interface EvalDto {
|
|
164
|
+
/**
|
|
165
|
+
* Evaluation ID
|
|
166
|
+
*/
|
|
167
|
+
'id': string;
|
|
168
|
+
/**
|
|
169
|
+
* Associated document ID
|
|
170
|
+
*/
|
|
171
|
+
'documentId': string;
|
|
172
|
+
/**
|
|
173
|
+
* Evaluation status
|
|
174
|
+
*/
|
|
175
|
+
'status': EvalDtoStatusEnum;
|
|
176
|
+
/**
|
|
177
|
+
* Evaluation creation timestamp
|
|
178
|
+
*/
|
|
179
|
+
'createdAt': string;
|
|
180
|
+
/**
|
|
181
|
+
* Evaluation last update timestamp
|
|
182
|
+
*/
|
|
183
|
+
'updatedAt'?: string;
|
|
184
|
+
/**
|
|
185
|
+
* Latest job ID associated with this evaluation
|
|
186
|
+
*/
|
|
187
|
+
'latestJobId'?: string;
|
|
188
|
+
/**
|
|
189
|
+
* YAML file name
|
|
190
|
+
*/
|
|
191
|
+
'yamlFileName'?: string;
|
|
192
|
+
/**
|
|
193
|
+
* Optional aggregated metrics (e.g., similarity scores)
|
|
194
|
+
*/
|
|
195
|
+
'summary'?: {
|
|
196
|
+
[key: string]: any;
|
|
197
|
+
};
|
|
198
|
+
/**
|
|
199
|
+
* Optional detailed report (if stored)
|
|
200
|
+
*/
|
|
201
|
+
'report'?: {
|
|
202
|
+
[key: string]: any;
|
|
203
|
+
};
|
|
204
|
+
}
|
|
205
|
+
export declare const EvalDtoStatusEnum: {
|
|
206
|
+
readonly Queued: "queued";
|
|
207
|
+
readonly Running: "running";
|
|
208
|
+
readonly Completed: "completed";
|
|
209
|
+
readonly Failed: "failed";
|
|
210
|
+
};
|
|
211
|
+
export type EvalDtoStatusEnum = typeof EvalDtoStatusEnum[keyof typeof EvalDtoStatusEnum];
|
|
212
|
+
export interface GpuDeviceDto {
|
|
213
|
+
/**
|
|
214
|
+
* GPU device index
|
|
215
|
+
*/
|
|
216
|
+
'index': number;
|
|
217
|
+
/**
|
|
218
|
+
* GPU device name
|
|
219
|
+
*/
|
|
220
|
+
'name': string;
|
|
221
|
+
/**
|
|
222
|
+
* Total GPU memory in MB
|
|
223
|
+
*/
|
|
224
|
+
'memoryTotalMB': number;
|
|
225
|
+
/**
|
|
226
|
+
* Used GPU memory in MB
|
|
227
|
+
*/
|
|
228
|
+
'memoryUsedMB'?: number;
|
|
229
|
+
/**
|
|
230
|
+
* GPU utilization percentage
|
|
231
|
+
*/
|
|
232
|
+
'utilizationPct'?: number;
|
|
233
|
+
}
|
|
234
|
+
export interface GpuHealthCheckDto {
|
|
235
|
+
/**
|
|
236
|
+
* GPU health status
|
|
237
|
+
*/
|
|
238
|
+
'status': GpuHealthCheckDtoStatusEnum;
|
|
239
|
+
/**
|
|
240
|
+
* Number of GPU devices
|
|
241
|
+
*/
|
|
242
|
+
'deviceCount'?: number;
|
|
243
|
+
/**
|
|
244
|
+
* GPU devices information
|
|
245
|
+
*/
|
|
246
|
+
'devices'?: Array<GpuDeviceDto>;
|
|
247
|
+
/**
|
|
248
|
+
* GPU status message
|
|
249
|
+
*/
|
|
250
|
+
'message'?: string;
|
|
251
|
+
}
|
|
252
|
+
export declare const GpuHealthCheckDtoStatusEnum: {
|
|
253
|
+
readonly Ok: "ok";
|
|
254
|
+
readonly Degraded: "degraded";
|
|
255
|
+
readonly Down: "down";
|
|
256
|
+
};
|
|
257
|
+
export type GpuHealthCheckDtoStatusEnum = typeof GpuHealthCheckDtoStatusEnum[keyof typeof GpuHealthCheckDtoStatusEnum];
|
|
258
|
+
export interface HealthCheckItemDto {
|
|
259
|
+
/**
|
|
260
|
+
* Health check status
|
|
261
|
+
*/
|
|
262
|
+
'status': HealthCheckItemDtoStatusEnum;
|
|
263
|
+
/**
|
|
264
|
+
* Latency in milliseconds
|
|
265
|
+
*/
|
|
266
|
+
'latencyMs'?: number;
|
|
267
|
+
/**
|
|
268
|
+
* Status message
|
|
269
|
+
*/
|
|
270
|
+
'message'?: string;
|
|
271
|
+
/**
|
|
272
|
+
* Additional details
|
|
273
|
+
*/
|
|
274
|
+
'details'?: {
|
|
275
|
+
[key: string]: any;
|
|
276
|
+
};
|
|
277
|
+
}
|
|
278
|
+
export declare const HealthCheckItemDtoStatusEnum: {
|
|
279
|
+
readonly Ok: "ok";
|
|
280
|
+
readonly Degraded: "degraded";
|
|
281
|
+
readonly Down: "down";
|
|
282
|
+
};
|
|
283
|
+
export type HealthCheckItemDtoStatusEnum = typeof HealthCheckItemDtoStatusEnum[keyof typeof HealthCheckItemDtoStatusEnum];
|
|
284
|
+
export interface HealthChecksDto {
|
|
285
|
+
/**
|
|
286
|
+
* Redis health check
|
|
287
|
+
*/
|
|
288
|
+
'redis': HealthCheckItemDto;
|
|
289
|
+
/**
|
|
290
|
+
* Database health check
|
|
291
|
+
*/
|
|
292
|
+
'db': HealthCheckItemDto;
|
|
293
|
+
/**
|
|
294
|
+
* GPU health check
|
|
295
|
+
*/
|
|
296
|
+
'gpu': GpuHealthCheckDto;
|
|
297
|
+
}
|
|
298
|
+
export interface HealthResponseDto {
|
|
299
|
+
/**
|
|
300
|
+
* Overall system health status
|
|
301
|
+
*/
|
|
302
|
+
'status': HealthResponseDtoStatusEnum;
|
|
303
|
+
/**
|
|
304
|
+
* Health check timestamp
|
|
305
|
+
*/
|
|
306
|
+
'timestamp': string;
|
|
307
|
+
/**
|
|
308
|
+
* Health check results
|
|
309
|
+
*/
|
|
310
|
+
'checks': HealthChecksDto;
|
|
311
|
+
}
|
|
312
|
+
export declare const HealthResponseDtoStatusEnum: {
|
|
313
|
+
readonly Ok: "ok";
|
|
314
|
+
readonly Degraded: "degraded";
|
|
315
|
+
readonly Down: "down";
|
|
316
|
+
};
|
|
317
|
+
export type HealthResponseDtoStatusEnum = typeof HealthResponseDtoStatusEnum[keyof typeof HealthResponseDtoStatusEnum];
|
|
318
|
+
export interface JobDto {
|
|
319
|
+
/**
|
|
320
|
+
* Job ID
|
|
321
|
+
*/
|
|
322
|
+
'id': string;
|
|
323
|
+
/**
|
|
324
|
+
* Job type
|
|
325
|
+
*/
|
|
326
|
+
'type': JobDtoTypeEnum;
|
|
327
|
+
/**
|
|
328
|
+
* Job state
|
|
329
|
+
*/
|
|
330
|
+
'state': JobDtoStateEnum;
|
|
331
|
+
/**
|
|
332
|
+
* Job creation timestamp
|
|
333
|
+
*/
|
|
334
|
+
'createdAt': string;
|
|
335
|
+
/**
|
|
336
|
+
* Job last update timestamp
|
|
337
|
+
*/
|
|
338
|
+
'updatedAt'?: string;
|
|
339
|
+
/**
|
|
340
|
+
* Associated profile ID
|
|
341
|
+
*/
|
|
342
|
+
'profileId'?: string;
|
|
343
|
+
/**
|
|
344
|
+
* Associated document ID
|
|
345
|
+
*/
|
|
346
|
+
'documentId'?: string;
|
|
347
|
+
/**
|
|
348
|
+
* Associated evaluation ID
|
|
349
|
+
*/
|
|
350
|
+
'evalId'?: string;
|
|
351
|
+
/**
|
|
352
|
+
* Associated query ID
|
|
353
|
+
*/
|
|
354
|
+
'queryId'?: string;
|
|
355
|
+
/**
|
|
356
|
+
* 0..1 progress fraction
|
|
357
|
+
*/
|
|
358
|
+
'progress'?: number;
|
|
359
|
+
/**
|
|
360
|
+
* Current pipeline stage
|
|
361
|
+
*/
|
|
362
|
+
'stage'?: string;
|
|
363
|
+
/**
|
|
364
|
+
* Current job message
|
|
365
|
+
*/
|
|
366
|
+
'message'?: string;
|
|
367
|
+
/**
|
|
368
|
+
* Error message if failed
|
|
369
|
+
*/
|
|
370
|
+
'error'?: string;
|
|
371
|
+
/**
|
|
372
|
+
* Job-related links
|
|
373
|
+
*/
|
|
374
|
+
'links'?: JobLinksDto;
|
|
375
|
+
/**
|
|
376
|
+
* Additional job metadata
|
|
377
|
+
*/
|
|
378
|
+
'metadata'?: {
|
|
379
|
+
[key: string]: any;
|
|
380
|
+
};
|
|
381
|
+
}
|
|
382
|
+
export declare const JobDtoTypeEnum: {
|
|
383
|
+
readonly DocumentProcessing: "document_processing";
|
|
384
|
+
readonly Evaluation: "evaluation";
|
|
385
|
+
readonly BatchQuery: "batch_query";
|
|
386
|
+
readonly Other: "other";
|
|
387
|
+
};
|
|
388
|
+
export type JobDtoTypeEnum = typeof JobDtoTypeEnum[keyof typeof JobDtoTypeEnum];
|
|
389
|
+
export declare const JobDtoStateEnum: {
|
|
390
|
+
readonly Pending: "pending";
|
|
391
|
+
readonly Processing: "processing";
|
|
392
|
+
readonly Completed: "completed";
|
|
393
|
+
readonly Failed: "failed";
|
|
394
|
+
readonly Canceled: "canceled";
|
|
395
|
+
};
|
|
396
|
+
export type JobDtoStateEnum = typeof JobDtoStateEnum[keyof typeof JobDtoStateEnum];
|
|
397
|
+
export interface JobLinksDto {
|
|
398
|
+
/**
|
|
399
|
+
* Job status URI
|
|
400
|
+
*/
|
|
401
|
+
'status'?: string;
|
|
402
|
+
/**
|
|
403
|
+
* Resource URI
|
|
404
|
+
*/
|
|
405
|
+
'resource'?: string;
|
|
406
|
+
}
|
|
407
|
+
export interface JobStatusDto {
|
|
408
|
+
/**
|
|
409
|
+
* Job ID
|
|
410
|
+
*/
|
|
411
|
+
'id': string;
|
|
412
|
+
/**
|
|
413
|
+
* Job state
|
|
414
|
+
*/
|
|
415
|
+
'state': JobStatusDtoStateEnum;
|
|
416
|
+
/**
|
|
417
|
+
* Job last update timestamp
|
|
418
|
+
*/
|
|
419
|
+
'updatedAt': string;
|
|
420
|
+
/**
|
|
421
|
+
* 0..1 progress fraction
|
|
422
|
+
*/
|
|
423
|
+
'progress'?: number;
|
|
424
|
+
/**
|
|
425
|
+
* Current pipeline stage
|
|
426
|
+
*/
|
|
427
|
+
'stage'?: string;
|
|
428
|
+
/**
|
|
429
|
+
* Current job message
|
|
430
|
+
*/
|
|
431
|
+
'message'?: string;
|
|
432
|
+
/**
|
|
433
|
+
* Error message if failed
|
|
434
|
+
*/
|
|
435
|
+
'error'?: string;
|
|
436
|
+
}
|
|
437
|
+
export declare const JobStatusDtoStateEnum: {
|
|
438
|
+
readonly Pending: "pending";
|
|
439
|
+
readonly Processing: "processing";
|
|
440
|
+
readonly Completed: "completed";
|
|
441
|
+
readonly Failed: "failed";
|
|
442
|
+
readonly Canceled: "canceled";
|
|
443
|
+
};
|
|
444
|
+
export type JobStatusDtoStateEnum = typeof JobStatusDtoStateEnum[keyof typeof JobStatusDtoStateEnum];
|
|
445
|
+
export interface PaginatedDocumentsDto {
|
|
446
|
+
/**
|
|
447
|
+
* Document data
|
|
448
|
+
*/
|
|
449
|
+
'data': Array<DocumentDto>;
|
|
450
|
+
/**
|
|
451
|
+
* Pagination information
|
|
452
|
+
*/
|
|
453
|
+
'pagination': PaginationDto;
|
|
454
|
+
}
|
|
455
|
+
export interface PaginatedEvalsDto {
|
|
456
|
+
/**
|
|
457
|
+
* Evaluation data
|
|
458
|
+
*/
|
|
459
|
+
'data': Array<EvalDto>;
|
|
460
|
+
/**
|
|
461
|
+
* Pagination information
|
|
462
|
+
*/
|
|
463
|
+
'pagination': PaginationDto;
|
|
464
|
+
}
|
|
465
|
+
export interface PaginatedJobsDto {
|
|
466
|
+
/**
|
|
467
|
+
* Job data
|
|
468
|
+
*/
|
|
469
|
+
'data': Array<JobDto>;
|
|
470
|
+
/**
|
|
471
|
+
* Pagination information
|
|
472
|
+
*/
|
|
473
|
+
'pagination': PaginationDto;
|
|
474
|
+
}
|
|
475
|
+
export interface PaginatedProfilesDto {
|
|
476
|
+
/**
|
|
477
|
+
* Profile data
|
|
478
|
+
*/
|
|
479
|
+
'data': Array<ProfileDto>;
|
|
480
|
+
/**
|
|
481
|
+
* Pagination information
|
|
482
|
+
*/
|
|
483
|
+
'pagination': PaginationDto;
|
|
484
|
+
}
|
|
485
|
+
export interface PaginatedQueriesDto {
|
|
486
|
+
/**
|
|
487
|
+
* Batch query data
|
|
488
|
+
*/
|
|
489
|
+
'data': Array<BatchQueryDto>;
|
|
490
|
+
/**
|
|
491
|
+
* Pagination information
|
|
492
|
+
*/
|
|
493
|
+
'pagination': PaginationDto;
|
|
494
|
+
}
|
|
495
|
+
export interface PaginatedWebhooksDto {
|
|
496
|
+
/**
|
|
497
|
+
* Webhook data
|
|
498
|
+
*/
|
|
499
|
+
'data': Array<WebhookDto>;
|
|
500
|
+
/**
|
|
501
|
+
* Pagination information
|
|
502
|
+
*/
|
|
503
|
+
'pagination': PaginationDto;
|
|
504
|
+
}
|
|
505
|
+
export interface PaginationDto {
|
|
506
|
+
/**
|
|
507
|
+
* Current page number
|
|
508
|
+
*/
|
|
509
|
+
'page': number;
|
|
510
|
+
/**
|
|
511
|
+
* Page size limit
|
|
512
|
+
*/
|
|
513
|
+
'limit': number;
|
|
514
|
+
/**
|
|
515
|
+
* Total number of items
|
|
516
|
+
*/
|
|
517
|
+
'total': number;
|
|
518
|
+
}
|
|
519
|
+
export interface ProfileDto {
|
|
520
|
+
/**
|
|
521
|
+
* Profile ID
|
|
522
|
+
*/
|
|
523
|
+
'id': string;
|
|
524
|
+
/**
|
|
525
|
+
* Profile name
|
|
526
|
+
*/
|
|
527
|
+
'name': string;
|
|
528
|
+
/**
|
|
529
|
+
* Profile description
|
|
530
|
+
*/
|
|
531
|
+
'description'?: string;
|
|
532
|
+
/**
|
|
533
|
+
* Profile creation timestamp
|
|
534
|
+
*/
|
|
535
|
+
'createdAt': string;
|
|
536
|
+
/**
|
|
537
|
+
* Profile last update timestamp
|
|
538
|
+
*/
|
|
539
|
+
'updatedAt'?: string;
|
|
540
|
+
/**
|
|
541
|
+
* YAML file name
|
|
542
|
+
*/
|
|
543
|
+
'yamlFileName'?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Optional checksum of the uploaded YAML file
|
|
546
|
+
*/
|
|
547
|
+
'yamlSha256'?: string;
|
|
548
|
+
}
|
|
549
|
+
export interface QueryCreateResponseDto {
|
|
550
|
+
/**
|
|
551
|
+
* Created batch query
|
|
552
|
+
*/
|
|
553
|
+
'query': BatchQueryDto;
|
|
554
|
+
/**
|
|
555
|
+
* Processing job
|
|
556
|
+
*/
|
|
557
|
+
'job': JobDto;
|
|
558
|
+
}
|
|
559
|
+
export interface SourceItemDto {
|
|
560
|
+
/**
|
|
561
|
+
* Source ID
|
|
562
|
+
*/
|
|
563
|
+
'id': string;
|
|
564
|
+
/**
|
|
565
|
+
* Associated document ID
|
|
566
|
+
*/
|
|
567
|
+
'documentId': string;
|
|
568
|
+
/**
|
|
569
|
+
* Associated job ID
|
|
570
|
+
*/
|
|
571
|
+
'jobId'?: string;
|
|
572
|
+
/**
|
|
573
|
+
* Chunk ID
|
|
574
|
+
*/
|
|
575
|
+
'chunkId'?: string;
|
|
576
|
+
/**
|
|
577
|
+
* Page number
|
|
578
|
+
*/
|
|
579
|
+
'page'?: number;
|
|
580
|
+
/**
|
|
581
|
+
* Source text content
|
|
582
|
+
*/
|
|
583
|
+
'text': string;
|
|
584
|
+
/**
|
|
585
|
+
* Additional metadata
|
|
586
|
+
*/
|
|
587
|
+
'metadata'?: {
|
|
588
|
+
[key: string]: any;
|
|
589
|
+
};
|
|
590
|
+
}
|
|
591
|
+
export interface UpdateWebhookBodyInputDto {
|
|
592
|
+
/**
|
|
593
|
+
* Updated webhook target URL
|
|
594
|
+
*/
|
|
595
|
+
'url': string;
|
|
596
|
+
}
|
|
597
|
+
export interface ValidationErrorDto {
|
|
598
|
+
/**
|
|
599
|
+
* Error type
|
|
600
|
+
*/
|
|
601
|
+
'error': string;
|
|
602
|
+
/**
|
|
603
|
+
* Error message
|
|
604
|
+
*/
|
|
605
|
+
'message': string;
|
|
606
|
+
/**
|
|
607
|
+
* Validation issues
|
|
608
|
+
*/
|
|
609
|
+
'issues': Array<ValidationIssueDto>;
|
|
610
|
+
/**
|
|
611
|
+
* Request ID for tracking
|
|
612
|
+
*/
|
|
613
|
+
'requestId'?: string;
|
|
614
|
+
}
|
|
615
|
+
export interface ValidationIssueDto {
|
|
616
|
+
/**
|
|
617
|
+
* JSON pointer-like path into the YAML document
|
|
618
|
+
*/
|
|
619
|
+
'path': string;
|
|
620
|
+
/**
|
|
621
|
+
* Validation issue message
|
|
622
|
+
*/
|
|
623
|
+
'message': string;
|
|
624
|
+
/**
|
|
625
|
+
* Issue severity
|
|
626
|
+
*/
|
|
627
|
+
'severity'?: ValidationIssueDtoSeverityEnum;
|
|
628
|
+
}
|
|
629
|
+
export declare const ValidationIssueDtoSeverityEnum: {
|
|
630
|
+
readonly Error: "error";
|
|
631
|
+
readonly Warning: "warning";
|
|
632
|
+
};
|
|
633
|
+
export type ValidationIssueDtoSeverityEnum = typeof ValidationIssueDtoSeverityEnum[keyof typeof ValidationIssueDtoSeverityEnum];
|
|
634
|
+
export interface ValidationResultDto {
|
|
635
|
+
/**
|
|
636
|
+
* Whether the validation passed
|
|
637
|
+
*/
|
|
638
|
+
'valid': boolean;
|
|
639
|
+
/**
|
|
640
|
+
* Non-fatal issues
|
|
641
|
+
*/
|
|
642
|
+
'warnings'?: Array<ValidationIssueDto>;
|
|
643
|
+
/**
|
|
644
|
+
* Optional normalized representation (if available)
|
|
645
|
+
*/
|
|
646
|
+
'normalized'?: {
|
|
647
|
+
[key: string]: any;
|
|
648
|
+
};
|
|
649
|
+
}
|
|
650
|
+
export interface WebhookDto {
|
|
651
|
+
/**
|
|
652
|
+
* Webhook ID
|
|
653
|
+
*/
|
|
654
|
+
'id': string;
|
|
655
|
+
/**
|
|
656
|
+
* Webhook target URL
|
|
657
|
+
*/
|
|
658
|
+
'url': string;
|
|
659
|
+
/**
|
|
660
|
+
* Webhook creation timestamp
|
|
661
|
+
*/
|
|
662
|
+
'createdAt': string;
|
|
663
|
+
/**
|
|
664
|
+
* Webhook last update timestamp
|
|
665
|
+
*/
|
|
666
|
+
'updatedAt': string;
|
|
667
|
+
}
|
|
668
|
+
/**
|
|
669
|
+
* ArtifactsApi - axios parameter creator
|
|
670
|
+
*/
|
|
671
|
+
export declare const ArtifactsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
672
|
+
/**
|
|
673
|
+
* Downloads artifacts produced by the pipeline (e.g., GraphRAG outputs, DB snapshots, visualizations) as a single archive.
|
|
674
|
+
* @summary Download document artifacts
|
|
675
|
+
* @param {string} documentId Document ID.
|
|
676
|
+
* @param {*} [options] Override http request option.
|
|
677
|
+
* @throws {RequiredError}
|
|
678
|
+
*/
|
|
679
|
+
artifactsControllerDownloadDocumentArtifacts: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
680
|
+
};
|
|
681
|
+
/**
|
|
682
|
+
* ArtifactsApi - functional programming interface
|
|
683
|
+
*/
|
|
684
|
+
export declare const ArtifactsApiFp: (configuration?: Configuration) => {
|
|
685
|
+
/**
|
|
686
|
+
* Downloads artifacts produced by the pipeline (e.g., GraphRAG outputs, DB snapshots, visualizations) as a single archive.
|
|
687
|
+
* @summary Download document artifacts
|
|
688
|
+
* @param {string} documentId Document ID.
|
|
689
|
+
* @param {*} [options] Override http request option.
|
|
690
|
+
* @throws {RequiredError}
|
|
691
|
+
*/
|
|
692
|
+
artifactsControllerDownloadDocumentArtifacts(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
693
|
+
};
|
|
694
|
+
/**
|
|
695
|
+
* ArtifactsApi - factory interface
|
|
696
|
+
*/
|
|
697
|
+
export declare const ArtifactsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
698
|
+
/**
|
|
699
|
+
* Downloads artifacts produced by the pipeline (e.g., GraphRAG outputs, DB snapshots, visualizations) as a single archive.
|
|
700
|
+
* @summary Download document artifacts
|
|
701
|
+
* @param {string} documentId Document ID.
|
|
702
|
+
* @param {*} [options] Override http request option.
|
|
703
|
+
* @throws {RequiredError}
|
|
704
|
+
*/
|
|
705
|
+
artifactsControllerDownloadDocumentArtifacts(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
706
|
+
};
|
|
707
|
+
/**
|
|
708
|
+
* ArtifactsApi - object-oriented interface
|
|
709
|
+
*/
|
|
710
|
+
export declare class ArtifactsApi extends BaseAPI {
|
|
711
|
+
/**
|
|
712
|
+
* Downloads artifacts produced by the pipeline (e.g., GraphRAG outputs, DB snapshots, visualizations) as a single archive.
|
|
713
|
+
* @summary Download document artifacts
|
|
714
|
+
* @param {string} documentId Document ID.
|
|
715
|
+
* @param {*} [options] Override http request option.
|
|
716
|
+
* @throws {RequiredError}
|
|
717
|
+
*/
|
|
718
|
+
artifactsControllerDownloadDocumentArtifacts(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* DocumentsApi - axios parameter creator
|
|
722
|
+
*/
|
|
723
|
+
export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
724
|
+
/**
|
|
725
|
+
* Upload a document file (pdf/md/html/docx/etc) via multipart form to start processing.
|
|
726
|
+
* @summary Create document processing job
|
|
727
|
+
* @param {string} profileId Profile/config ID to use for processing (maps to CLI --config).
|
|
728
|
+
* @param {File} file Document file to process (pdf/md/html/docx/etc).
|
|
729
|
+
* @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
|
|
730
|
+
* @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
|
|
731
|
+
* @param {boolean} [visualize] Whether to generate graph visualization artifacts.
|
|
732
|
+
* @param {*} [options] Override http request option.
|
|
733
|
+
* @throws {RequiredError}
|
|
734
|
+
*/
|
|
735
|
+
documentsControllerCreateDocument: (profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
736
|
+
/**
|
|
737
|
+
*
|
|
738
|
+
* @summary Read document
|
|
739
|
+
* @param {string} documentId Document ID.
|
|
740
|
+
* @param {*} [options] Override http request option.
|
|
741
|
+
* @throws {RequiredError}
|
|
742
|
+
*/
|
|
743
|
+
documentsControllerGetDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
744
|
+
/**
|
|
745
|
+
* List processed documents. Supports filtering by profileId.
|
|
746
|
+
* @summary List documents
|
|
747
|
+
* @param {number} [page] 1-based page number.
|
|
748
|
+
* @param {number} [limit] Page size.
|
|
749
|
+
* @param {string} [profileId] Filter documents by profile/config ID.
|
|
750
|
+
* @param {*} [options] Override http request option.
|
|
751
|
+
* @throws {RequiredError}
|
|
752
|
+
*/
|
|
753
|
+
documentsControllerListDocuments: (page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
754
|
+
};
|
|
755
|
+
/**
|
|
756
|
+
* DocumentsApi - functional programming interface
|
|
757
|
+
*/
|
|
758
|
+
export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
759
|
+
/**
|
|
760
|
+
* Upload a document file (pdf/md/html/docx/etc) via multipart form to start processing.
|
|
761
|
+
* @summary Create document processing job
|
|
762
|
+
* @param {string} profileId Profile/config ID to use for processing (maps to CLI --config).
|
|
763
|
+
* @param {File} file Document file to process (pdf/md/html/docx/etc).
|
|
764
|
+
* @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
|
|
765
|
+
* @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
|
|
766
|
+
* @param {boolean} [visualize] Whether to generate graph visualization artifacts.
|
|
767
|
+
* @param {*} [options] Override http request option.
|
|
768
|
+
* @throws {RequiredError}
|
|
769
|
+
*/
|
|
770
|
+
documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentCreateResponseDto>>;
|
|
771
|
+
/**
|
|
772
|
+
*
|
|
773
|
+
* @summary Read document
|
|
774
|
+
* @param {string} documentId Document ID.
|
|
775
|
+
* @param {*} [options] Override http request option.
|
|
776
|
+
* @throws {RequiredError}
|
|
777
|
+
*/
|
|
778
|
+
documentsControllerGetDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentDto>>;
|
|
779
|
+
/**
|
|
780
|
+
* List processed documents. Supports filtering by profileId.
|
|
781
|
+
* @summary List documents
|
|
782
|
+
* @param {number} [page] 1-based page number.
|
|
783
|
+
* @param {number} [limit] Page size.
|
|
784
|
+
* @param {string} [profileId] Filter documents by profile/config ID.
|
|
785
|
+
* @param {*} [options] Override http request option.
|
|
786
|
+
* @throws {RequiredError}
|
|
787
|
+
*/
|
|
788
|
+
documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedDocumentsDto>>;
|
|
789
|
+
};
|
|
790
|
+
/**
|
|
791
|
+
* DocumentsApi - factory interface
|
|
792
|
+
*/
|
|
793
|
+
export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
794
|
+
/**
|
|
795
|
+
* Upload a document file (pdf/md/html/docx/etc) via multipart form to start processing.
|
|
796
|
+
* @summary Create document processing job
|
|
797
|
+
* @param {string} profileId Profile/config ID to use for processing (maps to CLI --config).
|
|
798
|
+
* @param {File} file Document file to process (pdf/md/html/docx/etc).
|
|
799
|
+
* @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
|
|
800
|
+
* @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
|
|
801
|
+
* @param {boolean} [visualize] Whether to generate graph visualization artifacts.
|
|
802
|
+
* @param {*} [options] Override http request option.
|
|
803
|
+
* @throws {RequiredError}
|
|
804
|
+
*/
|
|
805
|
+
documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentCreateResponseDto>;
|
|
806
|
+
/**
|
|
807
|
+
*
|
|
808
|
+
* @summary Read document
|
|
809
|
+
* @param {string} documentId Document ID.
|
|
810
|
+
* @param {*} [options] Override http request option.
|
|
811
|
+
* @throws {RequiredError}
|
|
812
|
+
*/
|
|
813
|
+
documentsControllerGetDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentDto>;
|
|
814
|
+
/**
|
|
815
|
+
* List processed documents. Supports filtering by profileId.
|
|
816
|
+
* @summary List documents
|
|
817
|
+
* @param {number} [page] 1-based page number.
|
|
818
|
+
* @param {number} [limit] Page size.
|
|
819
|
+
* @param {string} [profileId] Filter documents by profile/config ID.
|
|
820
|
+
* @param {*} [options] Override http request option.
|
|
821
|
+
* @throws {RequiredError}
|
|
822
|
+
*/
|
|
823
|
+
documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedDocumentsDto>;
|
|
824
|
+
};
|
|
825
|
+
/**
|
|
826
|
+
* DocumentsApi - object-oriented interface
|
|
827
|
+
*/
|
|
828
|
+
export declare class DocumentsApi extends BaseAPI {
|
|
829
|
+
/**
|
|
830
|
+
* Upload a document file (pdf/md/html/docx/etc) via multipart form to start processing.
|
|
831
|
+
* @summary Create document processing job
|
|
832
|
+
* @param {string} profileId Profile/config ID to use for processing (maps to CLI --config).
|
|
833
|
+
* @param {File} file Document file to process (pdf/md/html/docx/etc).
|
|
834
|
+
* @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
|
|
835
|
+
* @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
|
|
836
|
+
* @param {boolean} [visualize] Whether to generate graph visualization artifacts.
|
|
837
|
+
* @param {*} [options] Override http request option.
|
|
838
|
+
* @throws {RequiredError}
|
|
839
|
+
*/
|
|
840
|
+
documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentCreateResponseDto, any, {}>>;
|
|
841
|
+
/**
|
|
842
|
+
*
|
|
843
|
+
* @summary Read document
|
|
844
|
+
* @param {string} documentId Document ID.
|
|
845
|
+
* @param {*} [options] Override http request option.
|
|
846
|
+
* @throws {RequiredError}
|
|
847
|
+
*/
|
|
848
|
+
documentsControllerGetDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentDto, any, {}>>;
|
|
849
|
+
/**
|
|
850
|
+
* List processed documents. Supports filtering by profileId.
|
|
851
|
+
* @summary List documents
|
|
852
|
+
* @param {number} [page] 1-based page number.
|
|
853
|
+
* @param {number} [limit] Page size.
|
|
854
|
+
* @param {string} [profileId] Filter documents by profile/config ID.
|
|
855
|
+
* @param {*} [options] Override http request option.
|
|
856
|
+
* @throws {RequiredError}
|
|
857
|
+
*/
|
|
858
|
+
documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedDocumentsDto, any, {}>>;
|
|
859
|
+
}
|
|
860
|
+
export declare const DocumentsControllerCreateDocumentPriorityEnum: {
|
|
861
|
+
readonly Low: "low";
|
|
862
|
+
readonly Normal: "normal";
|
|
863
|
+
readonly High: "high";
|
|
864
|
+
};
|
|
865
|
+
export type DocumentsControllerCreateDocumentPriorityEnum = typeof DocumentsControllerCreateDocumentPriorityEnum[keyof typeof DocumentsControllerCreateDocumentPriorityEnum];
|
|
866
|
+
/**
|
|
867
|
+
* EvalsApi - axios parameter creator
|
|
868
|
+
*/
|
|
869
|
+
export declare const EvalsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
870
|
+
/**
|
|
871
|
+
* Uploads an eval YAML (test cases) to run against a document.
|
|
872
|
+
* @summary Create an eval from YAML
|
|
873
|
+
* @param {string} documentId Document ID.
|
|
874
|
+
* @param {File} yaml Eval YAML file (test cases).
|
|
875
|
+
* @param {boolean} [watch] If true, server may keep the request open longer (optional); most clients should poll job status instead.
|
|
876
|
+
* @param {*} [options] Override http request option.
|
|
877
|
+
* @throws {RequiredError}
|
|
878
|
+
*/
|
|
879
|
+
evalsControllerCreateEval: (documentId: string, yaml: File, watch?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
880
|
+
/**
|
|
881
|
+
*
|
|
882
|
+
* @summary Read eval
|
|
883
|
+
* @param {string} documentId Document ID.
|
|
884
|
+
* @param {string} evalId Evaluation ID.
|
|
885
|
+
* @param {*} [options] Override http request option.
|
|
886
|
+
* @throws {RequiredError}
|
|
887
|
+
*/
|
|
888
|
+
evalsControllerGetEval: (documentId: string, evalId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
889
|
+
/**
|
|
890
|
+
*
|
|
891
|
+
* @summary List evals for a document
|
|
892
|
+
* @param {string} documentId Document ID.
|
|
893
|
+
* @param {any} [limit] Page size.
|
|
894
|
+
* @param {any} [page] 1-based page number.
|
|
895
|
+
* @param {*} [options] Override http request option.
|
|
896
|
+
* @throws {RequiredError}
|
|
897
|
+
*/
|
|
898
|
+
evalsControllerListEvals: (documentId: string, limit?: any, page?: any, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
899
|
+
/**
|
|
900
|
+
* Validates an uploaded eval YAML without creating an eval.
|
|
901
|
+
* @summary Validate eval YAML
|
|
902
|
+
* @param {string} documentId Document ID.
|
|
903
|
+
* @param {File} yaml YAML file to validate.
|
|
904
|
+
* @param {*} [options] Override http request option.
|
|
905
|
+
* @throws {RequiredError}
|
|
906
|
+
*/
|
|
907
|
+
evalsControllerValidateEvalYaml: (documentId: string, yaml: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
908
|
+
};
|
|
909
|
+
/**
|
|
910
|
+
* EvalsApi - functional programming interface
|
|
911
|
+
*/
|
|
912
|
+
export declare const EvalsApiFp: (configuration?: Configuration) => {
|
|
913
|
+
/**
|
|
914
|
+
* Uploads an eval YAML (test cases) to run against a document.
|
|
915
|
+
* @summary Create an eval from YAML
|
|
916
|
+
* @param {string} documentId Document ID.
|
|
917
|
+
* @param {File} yaml Eval YAML file (test cases).
|
|
918
|
+
* @param {boolean} [watch] If true, server may keep the request open longer (optional); most clients should poll job status instead.
|
|
919
|
+
* @param {*} [options] Override http request option.
|
|
920
|
+
* @throws {RequiredError}
|
|
921
|
+
*/
|
|
922
|
+
evalsControllerCreateEval(documentId: string, yaml: File, watch?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EvalCreateResponseDto>>;
|
|
923
|
+
/**
|
|
924
|
+
*
|
|
925
|
+
* @summary Read eval
|
|
926
|
+
* @param {string} documentId Document ID.
|
|
927
|
+
* @param {string} evalId Evaluation ID.
|
|
928
|
+
* @param {*} [options] Override http request option.
|
|
929
|
+
* @throws {RequiredError}
|
|
930
|
+
*/
|
|
931
|
+
evalsControllerGetEval(documentId: string, evalId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EvalDto>>;
|
|
932
|
+
/**
|
|
933
|
+
*
|
|
934
|
+
* @summary List evals for a document
|
|
935
|
+
* @param {string} documentId Document ID.
|
|
936
|
+
* @param {any} [limit] Page size.
|
|
937
|
+
* @param {any} [page] 1-based page number.
|
|
938
|
+
* @param {*} [options] Override http request option.
|
|
939
|
+
* @throws {RequiredError}
|
|
940
|
+
*/
|
|
941
|
+
evalsControllerListEvals(documentId: string, limit?: any, page?: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedEvalsDto>>;
|
|
942
|
+
/**
|
|
943
|
+
* Validates an uploaded eval YAML without creating an eval.
|
|
944
|
+
* @summary Validate eval YAML
|
|
945
|
+
* @param {string} documentId Document ID.
|
|
946
|
+
* @param {File} yaml YAML file to validate.
|
|
947
|
+
* @param {*} [options] Override http request option.
|
|
948
|
+
* @throws {RequiredError}
|
|
949
|
+
*/
|
|
950
|
+
evalsControllerValidateEvalYaml(documentId: string, yaml: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValidationResultDto>>;
|
|
951
|
+
};
|
|
952
|
+
/**
|
|
953
|
+
* EvalsApi - factory interface
|
|
954
|
+
*/
|
|
955
|
+
export declare const EvalsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
956
|
+
/**
|
|
957
|
+
* Uploads an eval YAML (test cases) to run against a document.
|
|
958
|
+
* @summary Create an eval from YAML
|
|
959
|
+
* @param {string} documentId Document ID.
|
|
960
|
+
* @param {File} yaml Eval YAML file (test cases).
|
|
961
|
+
* @param {boolean} [watch] If true, server may keep the request open longer (optional); most clients should poll job status instead.
|
|
962
|
+
* @param {*} [options] Override http request option.
|
|
963
|
+
* @throws {RequiredError}
|
|
964
|
+
*/
|
|
965
|
+
evalsControllerCreateEval(documentId: string, yaml: File, watch?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<EvalCreateResponseDto>;
|
|
966
|
+
/**
|
|
967
|
+
*
|
|
968
|
+
* @summary Read eval
|
|
969
|
+
* @param {string} documentId Document ID.
|
|
970
|
+
* @param {string} evalId Evaluation ID.
|
|
971
|
+
* @param {*} [options] Override http request option.
|
|
972
|
+
* @throws {RequiredError}
|
|
973
|
+
*/
|
|
974
|
+
evalsControllerGetEval(documentId: string, evalId: string, options?: RawAxiosRequestConfig): AxiosPromise<EvalDto>;
|
|
975
|
+
/**
|
|
976
|
+
*
|
|
977
|
+
* @summary List evals for a document
|
|
978
|
+
* @param {string} documentId Document ID.
|
|
979
|
+
* @param {any} [limit] Page size.
|
|
980
|
+
* @param {any} [page] 1-based page number.
|
|
981
|
+
* @param {*} [options] Override http request option.
|
|
982
|
+
* @throws {RequiredError}
|
|
983
|
+
*/
|
|
984
|
+
evalsControllerListEvals(documentId: string, limit?: any, page?: any, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedEvalsDto>;
|
|
985
|
+
/**
|
|
986
|
+
* Validates an uploaded eval YAML without creating an eval.
|
|
987
|
+
* @summary Validate eval YAML
|
|
988
|
+
* @param {string} documentId Document ID.
|
|
989
|
+
* @param {File} yaml YAML file to validate.
|
|
990
|
+
* @param {*} [options] Override http request option.
|
|
991
|
+
* @throws {RequiredError}
|
|
992
|
+
*/
|
|
993
|
+
evalsControllerValidateEvalYaml(documentId: string, yaml: File, options?: RawAxiosRequestConfig): AxiosPromise<ValidationResultDto>;
|
|
994
|
+
};
|
|
995
|
+
/**
|
|
996
|
+
* EvalsApi - object-oriented interface
|
|
997
|
+
*/
|
|
998
|
+
export declare class EvalsApi extends BaseAPI {
|
|
999
|
+
/**
|
|
1000
|
+
* Uploads an eval YAML (test cases) to run against a document.
|
|
1001
|
+
* @summary Create an eval from YAML
|
|
1002
|
+
* @param {string} documentId Document ID.
|
|
1003
|
+
* @param {File} yaml Eval YAML file (test cases).
|
|
1004
|
+
* @param {boolean} [watch] If true, server may keep the request open longer (optional); most clients should poll job status instead.
|
|
1005
|
+
* @param {*} [options] Override http request option.
|
|
1006
|
+
* @throws {RequiredError}
|
|
1007
|
+
*/
|
|
1008
|
+
evalsControllerCreateEval(documentId: string, yaml: File, watch?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EvalCreateResponseDto, any, {}>>;
|
|
1009
|
+
/**
|
|
1010
|
+
*
|
|
1011
|
+
* @summary Read eval
|
|
1012
|
+
* @param {string} documentId Document ID.
|
|
1013
|
+
* @param {string} evalId Evaluation ID.
|
|
1014
|
+
* @param {*} [options] Override http request option.
|
|
1015
|
+
* @throws {RequiredError}
|
|
1016
|
+
*/
|
|
1017
|
+
evalsControllerGetEval(documentId: string, evalId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EvalDto, any, {}>>;
|
|
1018
|
+
/**
|
|
1019
|
+
*
|
|
1020
|
+
* @summary List evals for a document
|
|
1021
|
+
* @param {string} documentId Document ID.
|
|
1022
|
+
* @param {any} [limit] Page size.
|
|
1023
|
+
* @param {any} [page] 1-based page number.
|
|
1024
|
+
* @param {*} [options] Override http request option.
|
|
1025
|
+
* @throws {RequiredError}
|
|
1026
|
+
*/
|
|
1027
|
+
evalsControllerListEvals(documentId: string, limit?: any, page?: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedEvalsDto, any, {}>>;
|
|
1028
|
+
/**
|
|
1029
|
+
* Validates an uploaded eval YAML without creating an eval.
|
|
1030
|
+
* @summary Validate eval YAML
|
|
1031
|
+
* @param {string} documentId Document ID.
|
|
1032
|
+
* @param {File} yaml YAML file to validate.
|
|
1033
|
+
* @param {*} [options] Override http request option.
|
|
1034
|
+
* @throws {RequiredError}
|
|
1035
|
+
*/
|
|
1036
|
+
evalsControllerValidateEvalYaml(documentId: string, yaml: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValidationResultDto, any, {}>>;
|
|
1037
|
+
}
|
|
1038
|
+
/**
|
|
1039
|
+
* HealthApi - axios parameter creator
|
|
1040
|
+
*/
|
|
1041
|
+
export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1042
|
+
/**
|
|
1043
|
+
* Returns service health including Redis, database, and GPU status.
|
|
1044
|
+
* @summary Get system health
|
|
1045
|
+
* @param {*} [options] Override http request option.
|
|
1046
|
+
* @throws {RequiredError}
|
|
1047
|
+
*/
|
|
1048
|
+
healthControllerGetHealth: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1049
|
+
};
|
|
1050
|
+
/**
|
|
1051
|
+
* HealthApi - functional programming interface
|
|
1052
|
+
*/
|
|
1053
|
+
export declare const HealthApiFp: (configuration?: Configuration) => {
|
|
1054
|
+
/**
|
|
1055
|
+
* Returns service health including Redis, database, and GPU status.
|
|
1056
|
+
* @summary Get system health
|
|
1057
|
+
* @param {*} [options] Override http request option.
|
|
1058
|
+
* @throws {RequiredError}
|
|
1059
|
+
*/
|
|
1060
|
+
healthControllerGetHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthResponseDto>>;
|
|
1061
|
+
};
|
|
1062
|
+
/**
|
|
1063
|
+
* HealthApi - factory interface
|
|
1064
|
+
*/
|
|
1065
|
+
export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1066
|
+
/**
|
|
1067
|
+
* Returns service health including Redis, database, and GPU status.
|
|
1068
|
+
* @summary Get system health
|
|
1069
|
+
* @param {*} [options] Override http request option.
|
|
1070
|
+
* @throws {RequiredError}
|
|
1071
|
+
*/
|
|
1072
|
+
healthControllerGetHealth(options?: RawAxiosRequestConfig): AxiosPromise<HealthResponseDto>;
|
|
1073
|
+
};
|
|
1074
|
+
/**
|
|
1075
|
+
* HealthApi - object-oriented interface
|
|
1076
|
+
*/
|
|
1077
|
+
export declare class HealthApi extends BaseAPI {
|
|
1078
|
+
/**
|
|
1079
|
+
* Returns service health including Redis, database, and GPU status.
|
|
1080
|
+
* @summary Get system health
|
|
1081
|
+
* @param {*} [options] Override http request option.
|
|
1082
|
+
* @throws {RequiredError}
|
|
1083
|
+
*/
|
|
1084
|
+
healthControllerGetHealth(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthResponseDto, any, {}>>;
|
|
1085
|
+
}
|
|
1086
|
+
/**
|
|
1087
|
+
* JobsApi - axios parameter creator
|
|
1088
|
+
*/
|
|
1089
|
+
export declare const JobsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1090
|
+
/**
|
|
1091
|
+
*
|
|
1092
|
+
* @summary Read job
|
|
1093
|
+
* @param {string} jobId Job ID.
|
|
1094
|
+
* @param {*} [options] Override http request option.
|
|
1095
|
+
* @throws {RequiredError}
|
|
1096
|
+
*/
|
|
1097
|
+
jobsControllerGetJob: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1098
|
+
/**
|
|
1099
|
+
* Returns a lightweight status payload suitable for polling.
|
|
1100
|
+
* @summary Get job status
|
|
1101
|
+
* @param {string} jobId Job ID.
|
|
1102
|
+
* @param {*} [options] Override http request option.
|
|
1103
|
+
* @throws {RequiredError}
|
|
1104
|
+
*/
|
|
1105
|
+
jobsControllerGetJobStatus: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1106
|
+
/**
|
|
1107
|
+
* Lists jobs for document processing, evaluations, and query jobs.
|
|
1108
|
+
* @summary List jobs
|
|
1109
|
+
* @param {number} [page] 1-based page number.
|
|
1110
|
+
* @param {number} [limit] Page size.
|
|
1111
|
+
* @param {*} [options] Override http request option.
|
|
1112
|
+
* @throws {RequiredError}
|
|
1113
|
+
*/
|
|
1114
|
+
jobsControllerListJobs: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1115
|
+
};
|
|
1116
|
+
/**
|
|
1117
|
+
* JobsApi - functional programming interface
|
|
1118
|
+
*/
|
|
1119
|
+
export declare const JobsApiFp: (configuration?: Configuration) => {
|
|
1120
|
+
/**
|
|
1121
|
+
*
|
|
1122
|
+
* @summary Read job
|
|
1123
|
+
* @param {string} jobId Job ID.
|
|
1124
|
+
* @param {*} [options] Override http request option.
|
|
1125
|
+
* @throws {RequiredError}
|
|
1126
|
+
*/
|
|
1127
|
+
jobsControllerGetJob(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobDto>>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Returns a lightweight status payload suitable for polling.
|
|
1130
|
+
* @summary Get job status
|
|
1131
|
+
* @param {string} jobId Job ID.
|
|
1132
|
+
* @param {*} [options] Override http request option.
|
|
1133
|
+
* @throws {RequiredError}
|
|
1134
|
+
*/
|
|
1135
|
+
jobsControllerGetJobStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobStatusDto>>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Lists jobs for document processing, evaluations, and query jobs.
|
|
1138
|
+
* @summary List jobs
|
|
1139
|
+
* @param {number} [page] 1-based page number.
|
|
1140
|
+
* @param {number} [limit] Page size.
|
|
1141
|
+
* @param {*} [options] Override http request option.
|
|
1142
|
+
* @throws {RequiredError}
|
|
1143
|
+
*/
|
|
1144
|
+
jobsControllerListJobs(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedJobsDto>>;
|
|
1145
|
+
};
|
|
1146
|
+
/**
|
|
1147
|
+
* JobsApi - factory interface
|
|
1148
|
+
*/
|
|
1149
|
+
export declare const JobsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1150
|
+
/**
|
|
1151
|
+
*
|
|
1152
|
+
* @summary Read job
|
|
1153
|
+
* @param {string} jobId Job ID.
|
|
1154
|
+
* @param {*} [options] Override http request option.
|
|
1155
|
+
* @throws {RequiredError}
|
|
1156
|
+
*/
|
|
1157
|
+
jobsControllerGetJob(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<JobDto>;
|
|
1158
|
+
/**
|
|
1159
|
+
* Returns a lightweight status payload suitable for polling.
|
|
1160
|
+
* @summary Get job status
|
|
1161
|
+
* @param {string} jobId Job ID.
|
|
1162
|
+
* @param {*} [options] Override http request option.
|
|
1163
|
+
* @throws {RequiredError}
|
|
1164
|
+
*/
|
|
1165
|
+
jobsControllerGetJobStatus(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<JobStatusDto>;
|
|
1166
|
+
/**
|
|
1167
|
+
* Lists jobs for document processing, evaluations, and query jobs.
|
|
1168
|
+
* @summary List jobs
|
|
1169
|
+
* @param {number} [page] 1-based page number.
|
|
1170
|
+
* @param {number} [limit] Page size.
|
|
1171
|
+
* @param {*} [options] Override http request option.
|
|
1172
|
+
* @throws {RequiredError}
|
|
1173
|
+
*/
|
|
1174
|
+
jobsControllerListJobs(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedJobsDto>;
|
|
1175
|
+
};
|
|
1176
|
+
/**
|
|
1177
|
+
* JobsApi - object-oriented interface
|
|
1178
|
+
*/
|
|
1179
|
+
export declare class JobsApi extends BaseAPI {
|
|
1180
|
+
/**
|
|
1181
|
+
*
|
|
1182
|
+
* @summary Read job
|
|
1183
|
+
* @param {string} jobId Job ID.
|
|
1184
|
+
* @param {*} [options] Override http request option.
|
|
1185
|
+
* @throws {RequiredError}
|
|
1186
|
+
*/
|
|
1187
|
+
jobsControllerGetJob(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JobDto, any, {}>>;
|
|
1188
|
+
/**
|
|
1189
|
+
* Returns a lightweight status payload suitable for polling.
|
|
1190
|
+
* @summary Get job status
|
|
1191
|
+
* @param {string} jobId Job ID.
|
|
1192
|
+
* @param {*} [options] Override http request option.
|
|
1193
|
+
* @throws {RequiredError}
|
|
1194
|
+
*/
|
|
1195
|
+
jobsControllerGetJobStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JobStatusDto, any, {}>>;
|
|
1196
|
+
/**
|
|
1197
|
+
* Lists jobs for document processing, evaluations, and query jobs.
|
|
1198
|
+
* @summary List jobs
|
|
1199
|
+
* @param {number} [page] 1-based page number.
|
|
1200
|
+
* @param {number} [limit] Page size.
|
|
1201
|
+
* @param {*} [options] Override http request option.
|
|
1202
|
+
* @throws {RequiredError}
|
|
1203
|
+
*/
|
|
1204
|
+
jobsControllerListJobs(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedJobsDto, any, {}>>;
|
|
1205
|
+
}
|
|
1206
|
+
/**
|
|
1207
|
+
* ProfilesApi - axios parameter creator
|
|
1208
|
+
*/
|
|
1209
|
+
export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1210
|
+
/**
|
|
1211
|
+
* Upload a YAML config file (multipart form). Do not inline YAML parameters in JSON.
|
|
1212
|
+
* @summary Create profile from YAML
|
|
1213
|
+
* @param {File} yaml YAML file containing the profile/config.
|
|
1214
|
+
* @param {string} [name] Optional override for profile name (otherwise derived from YAML).
|
|
1215
|
+
* @param {*} [options] Override http request option.
|
|
1216
|
+
* @throws {RequiredError}
|
|
1217
|
+
*/
|
|
1218
|
+
profilesControllerCreateProfile: (yaml: File, name?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1219
|
+
/**
|
|
1220
|
+
*
|
|
1221
|
+
* @summary Read profile
|
|
1222
|
+
* @param {string} profileId Profile/config ID.
|
|
1223
|
+
* @param {*} [options] Override http request option.
|
|
1224
|
+
* @throws {RequiredError}
|
|
1225
|
+
*/
|
|
1226
|
+
profilesControllerGetProfile: (profileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1227
|
+
/**
|
|
1228
|
+
* Returns the JSON schema for profile YAML configuration files.
|
|
1229
|
+
* @summary Get profile schema
|
|
1230
|
+
* @param {*} [options] Override http request option.
|
|
1231
|
+
* @throws {RequiredError}
|
|
1232
|
+
*/
|
|
1233
|
+
profilesControllerGetProfileSchema: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1234
|
+
/**
|
|
1235
|
+
*
|
|
1236
|
+
* @summary List profiles
|
|
1237
|
+
* @param {number} [page] 1-based page number.
|
|
1238
|
+
* @param {number} [limit] Page size.
|
|
1239
|
+
* @param {*} [options] Override http request option.
|
|
1240
|
+
* @throws {RequiredError}
|
|
1241
|
+
*/
|
|
1242
|
+
profilesControllerListProfiles: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1243
|
+
};
|
|
1244
|
+
/**
|
|
1245
|
+
* ProfilesApi - functional programming interface
|
|
1246
|
+
*/
|
|
1247
|
+
export declare const ProfilesApiFp: (configuration?: Configuration) => {
|
|
1248
|
+
/**
|
|
1249
|
+
* Upload a YAML config file (multipart form). Do not inline YAML parameters in JSON.
|
|
1250
|
+
* @summary Create profile from YAML
|
|
1251
|
+
* @param {File} yaml YAML file containing the profile/config.
|
|
1252
|
+
* @param {string} [name] Optional override for profile name (otherwise derived from YAML).
|
|
1253
|
+
* @param {*} [options] Override http request option.
|
|
1254
|
+
* @throws {RequiredError}
|
|
1255
|
+
*/
|
|
1256
|
+
profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
|
|
1257
|
+
/**
|
|
1258
|
+
*
|
|
1259
|
+
* @summary Read profile
|
|
1260
|
+
* @param {string} profileId Profile/config ID.
|
|
1261
|
+
* @param {*} [options] Override http request option.
|
|
1262
|
+
* @throws {RequiredError}
|
|
1263
|
+
*/
|
|
1264
|
+
profilesControllerGetProfile(profileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
|
|
1265
|
+
/**
|
|
1266
|
+
* Returns the JSON schema for profile YAML configuration files.
|
|
1267
|
+
* @summary Get profile schema
|
|
1268
|
+
* @param {*} [options] Override http request option.
|
|
1269
|
+
* @throws {RequiredError}
|
|
1270
|
+
*/
|
|
1271
|
+
profilesControllerGetProfileSchema(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
1272
|
+
[key: string]: any;
|
|
1273
|
+
}>>;
|
|
1274
|
+
/**
|
|
1275
|
+
*
|
|
1276
|
+
* @summary List profiles
|
|
1277
|
+
* @param {number} [page] 1-based page number.
|
|
1278
|
+
* @param {number} [limit] Page size.
|
|
1279
|
+
* @param {*} [options] Override http request option.
|
|
1280
|
+
* @throws {RequiredError}
|
|
1281
|
+
*/
|
|
1282
|
+
profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>>;
|
|
1283
|
+
};
|
|
1284
|
+
/**
|
|
1285
|
+
* ProfilesApi - factory interface
|
|
1286
|
+
*/
|
|
1287
|
+
export declare const ProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1288
|
+
/**
|
|
1289
|
+
* Upload a YAML config file (multipart form). Do not inline YAML parameters in JSON.
|
|
1290
|
+
* @summary Create profile from YAML
|
|
1291
|
+
* @param {File} yaml YAML file containing the profile/config.
|
|
1292
|
+
* @param {string} [name] Optional override for profile name (otherwise derived from YAML).
|
|
1293
|
+
* @param {*} [options] Override http request option.
|
|
1294
|
+
* @throws {RequiredError}
|
|
1295
|
+
*/
|
|
1296
|
+
profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
|
|
1297
|
+
/**
|
|
1298
|
+
*
|
|
1299
|
+
* @summary Read profile
|
|
1300
|
+
* @param {string} profileId Profile/config ID.
|
|
1301
|
+
* @param {*} [options] Override http request option.
|
|
1302
|
+
* @throws {RequiredError}
|
|
1303
|
+
*/
|
|
1304
|
+
profilesControllerGetProfile(profileId: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
|
|
1305
|
+
/**
|
|
1306
|
+
* Returns the JSON schema for profile YAML configuration files.
|
|
1307
|
+
* @summary Get profile schema
|
|
1308
|
+
* @param {*} [options] Override http request option.
|
|
1309
|
+
* @throws {RequiredError}
|
|
1310
|
+
*/
|
|
1311
|
+
profilesControllerGetProfileSchema(options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
1312
|
+
[key: string]: any;
|
|
1313
|
+
}>;
|
|
1314
|
+
/**
|
|
1315
|
+
*
|
|
1316
|
+
* @summary List profiles
|
|
1317
|
+
* @param {number} [page] 1-based page number.
|
|
1318
|
+
* @param {number} [limit] Page size.
|
|
1319
|
+
* @param {*} [options] Override http request option.
|
|
1320
|
+
* @throws {RequiredError}
|
|
1321
|
+
*/
|
|
1322
|
+
profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto>;
|
|
1323
|
+
};
|
|
1324
|
+
/**
|
|
1325
|
+
* ProfilesApi - object-oriented interface
|
|
1326
|
+
*/
|
|
1327
|
+
export declare class ProfilesApi extends BaseAPI {
|
|
1328
|
+
/**
|
|
1329
|
+
* Upload a YAML config file (multipart form). Do not inline YAML parameters in JSON.
|
|
1330
|
+
* @summary Create profile from YAML
|
|
1331
|
+
* @param {File} yaml YAML file containing the profile/config.
|
|
1332
|
+
* @param {string} [name] Optional override for profile name (otherwise derived from YAML).
|
|
1333
|
+
* @param {*} [options] Override http request option.
|
|
1334
|
+
* @throws {RequiredError}
|
|
1335
|
+
*/
|
|
1336
|
+
profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
|
|
1337
|
+
/**
|
|
1338
|
+
*
|
|
1339
|
+
* @summary Read profile
|
|
1340
|
+
* @param {string} profileId Profile/config ID.
|
|
1341
|
+
* @param {*} [options] Override http request option.
|
|
1342
|
+
* @throws {RequiredError}
|
|
1343
|
+
*/
|
|
1344
|
+
profilesControllerGetProfile(profileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
|
|
1345
|
+
/**
|
|
1346
|
+
* Returns the JSON schema for profile YAML configuration files.
|
|
1347
|
+
* @summary Get profile schema
|
|
1348
|
+
* @param {*} [options] Override http request option.
|
|
1349
|
+
* @throws {RequiredError}
|
|
1350
|
+
*/
|
|
1351
|
+
profilesControllerGetProfileSchema(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
1352
|
+
[key: string]: any;
|
|
1353
|
+
}, any, {}>>;
|
|
1354
|
+
/**
|
|
1355
|
+
*
|
|
1356
|
+
* @summary List profiles
|
|
1357
|
+
* @param {number} [page] 1-based page number.
|
|
1358
|
+
* @param {number} [limit] Page size.
|
|
1359
|
+
* @param {*} [options] Override http request option.
|
|
1360
|
+
* @throws {RequiredError}
|
|
1361
|
+
*/
|
|
1362
|
+
profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedProfilesDto, any, {}>>;
|
|
1363
|
+
}
|
|
1364
|
+
/**
|
|
1365
|
+
* QueriesApi - axios parameter creator
|
|
1366
|
+
*/
|
|
1367
|
+
export declare const QueriesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1368
|
+
/**
|
|
1369
|
+
* Uploads a batch queries YAML (multipart form). Typically schedules a job.
|
|
1370
|
+
* @summary Create batch query from YAML
|
|
1371
|
+
* @param {File} yaml Batch queries YAML file.
|
|
1372
|
+
* @param {boolean} [watch]
|
|
1373
|
+
* @param {*} [options] Override http request option.
|
|
1374
|
+
* @throws {RequiredError}
|
|
1375
|
+
*/
|
|
1376
|
+
queriesControllerCreateQuery: (yaml: File, watch?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1377
|
+
/**
|
|
1378
|
+
*
|
|
1379
|
+
* @summary Read batch query
|
|
1380
|
+
* @param {string} queryId Batch query ID.
|
|
1381
|
+
* @param {*} [options] Override http request option.
|
|
1382
|
+
* @throws {RequiredError}
|
|
1383
|
+
*/
|
|
1384
|
+
queriesControllerGetQuery: (queryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1385
|
+
/**
|
|
1386
|
+
* Lists batch query runs (submitted via YAML).
|
|
1387
|
+
* @summary List batch queries
|
|
1388
|
+
* @param {number} [page] 1-based page number.
|
|
1389
|
+
* @param {number} [limit] Page size.
|
|
1390
|
+
* @param {string} [documentId] Filter by document ID.
|
|
1391
|
+
* @param {*} [options] Override http request option.
|
|
1392
|
+
* @throws {RequiredError}
|
|
1393
|
+
*/
|
|
1394
|
+
queriesControllerListQueries: (page?: number, limit?: number, documentId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1395
|
+
/**
|
|
1396
|
+
* Validates an uploaded batch queries YAML without creating a query.
|
|
1397
|
+
* @summary Validate batch query YAML
|
|
1398
|
+
* @param {File} yaml YAML file to validate.
|
|
1399
|
+
* @param {*} [options] Override http request option.
|
|
1400
|
+
* @throws {RequiredError}
|
|
1401
|
+
*/
|
|
1402
|
+
queriesControllerValidateQueryYaml: (yaml: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1403
|
+
};
|
|
1404
|
+
/**
|
|
1405
|
+
* QueriesApi - functional programming interface
|
|
1406
|
+
*/
|
|
1407
|
+
export declare const QueriesApiFp: (configuration?: Configuration) => {
|
|
1408
|
+
/**
|
|
1409
|
+
* Uploads a batch queries YAML (multipart form). Typically schedules a job.
|
|
1410
|
+
* @summary Create batch query from YAML
|
|
1411
|
+
* @param {File} yaml Batch queries YAML file.
|
|
1412
|
+
* @param {boolean} [watch]
|
|
1413
|
+
* @param {*} [options] Override http request option.
|
|
1414
|
+
* @throws {RequiredError}
|
|
1415
|
+
*/
|
|
1416
|
+
queriesControllerCreateQuery(yaml: File, watch?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryCreateResponseDto>>;
|
|
1417
|
+
/**
|
|
1418
|
+
*
|
|
1419
|
+
* @summary Read batch query
|
|
1420
|
+
* @param {string} queryId Batch query ID.
|
|
1421
|
+
* @param {*} [options] Override http request option.
|
|
1422
|
+
* @throws {RequiredError}
|
|
1423
|
+
*/
|
|
1424
|
+
queriesControllerGetQuery(queryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchQueryDto>>;
|
|
1425
|
+
/**
|
|
1426
|
+
* Lists batch query runs (submitted via YAML).
|
|
1427
|
+
* @summary List batch queries
|
|
1428
|
+
* @param {number} [page] 1-based page number.
|
|
1429
|
+
* @param {number} [limit] Page size.
|
|
1430
|
+
* @param {string} [documentId] Filter by document ID.
|
|
1431
|
+
* @param {*} [options] Override http request option.
|
|
1432
|
+
* @throws {RequiredError}
|
|
1433
|
+
*/
|
|
1434
|
+
queriesControllerListQueries(page?: number, limit?: number, documentId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedQueriesDto>>;
|
|
1435
|
+
/**
|
|
1436
|
+
* Validates an uploaded batch queries YAML without creating a query.
|
|
1437
|
+
* @summary Validate batch query YAML
|
|
1438
|
+
* @param {File} yaml YAML file to validate.
|
|
1439
|
+
* @param {*} [options] Override http request option.
|
|
1440
|
+
* @throws {RequiredError}
|
|
1441
|
+
*/
|
|
1442
|
+
queriesControllerValidateQueryYaml(yaml: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValidationResultDto>>;
|
|
1443
|
+
};
|
|
1444
|
+
/**
|
|
1445
|
+
* QueriesApi - factory interface
|
|
1446
|
+
*/
|
|
1447
|
+
export declare const QueriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1448
|
+
/**
|
|
1449
|
+
* Uploads a batch queries YAML (multipart form). Typically schedules a job.
|
|
1450
|
+
* @summary Create batch query from YAML
|
|
1451
|
+
* @param {File} yaml Batch queries YAML file.
|
|
1452
|
+
* @param {boolean} [watch]
|
|
1453
|
+
* @param {*} [options] Override http request option.
|
|
1454
|
+
* @throws {RequiredError}
|
|
1455
|
+
*/
|
|
1456
|
+
queriesControllerCreateQuery(yaml: File, watch?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<QueryCreateResponseDto>;
|
|
1457
|
+
/**
|
|
1458
|
+
*
|
|
1459
|
+
* @summary Read batch query
|
|
1460
|
+
* @param {string} queryId Batch query ID.
|
|
1461
|
+
* @param {*} [options] Override http request option.
|
|
1462
|
+
* @throws {RequiredError}
|
|
1463
|
+
*/
|
|
1464
|
+
queriesControllerGetQuery(queryId: string, options?: RawAxiosRequestConfig): AxiosPromise<BatchQueryDto>;
|
|
1465
|
+
/**
|
|
1466
|
+
* Lists batch query runs (submitted via YAML).
|
|
1467
|
+
* @summary List batch queries
|
|
1468
|
+
* @param {number} [page] 1-based page number.
|
|
1469
|
+
* @param {number} [limit] Page size.
|
|
1470
|
+
* @param {string} [documentId] Filter by document ID.
|
|
1471
|
+
* @param {*} [options] Override http request option.
|
|
1472
|
+
* @throws {RequiredError}
|
|
1473
|
+
*/
|
|
1474
|
+
queriesControllerListQueries(page?: number, limit?: number, documentId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedQueriesDto>;
|
|
1475
|
+
/**
|
|
1476
|
+
* Validates an uploaded batch queries YAML without creating a query.
|
|
1477
|
+
* @summary Validate batch query YAML
|
|
1478
|
+
* @param {File} yaml YAML file to validate.
|
|
1479
|
+
* @param {*} [options] Override http request option.
|
|
1480
|
+
* @throws {RequiredError}
|
|
1481
|
+
*/
|
|
1482
|
+
queriesControllerValidateQueryYaml(yaml: File, options?: RawAxiosRequestConfig): AxiosPromise<ValidationResultDto>;
|
|
1483
|
+
};
|
|
1484
|
+
/**
|
|
1485
|
+
* QueriesApi - object-oriented interface
|
|
1486
|
+
*/
|
|
1487
|
+
export declare class QueriesApi extends BaseAPI {
|
|
1488
|
+
/**
|
|
1489
|
+
* Uploads a batch queries YAML (multipart form). Typically schedules a job.
|
|
1490
|
+
* @summary Create batch query from YAML
|
|
1491
|
+
* @param {File} yaml Batch queries YAML file.
|
|
1492
|
+
* @param {boolean} [watch]
|
|
1493
|
+
* @param {*} [options] Override http request option.
|
|
1494
|
+
* @throws {RequiredError}
|
|
1495
|
+
*/
|
|
1496
|
+
queriesControllerCreateQuery(yaml: File, watch?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryCreateResponseDto, any, {}>>;
|
|
1497
|
+
/**
|
|
1498
|
+
*
|
|
1499
|
+
* @summary Read batch query
|
|
1500
|
+
* @param {string} queryId Batch query ID.
|
|
1501
|
+
* @param {*} [options] Override http request option.
|
|
1502
|
+
* @throws {RequiredError}
|
|
1503
|
+
*/
|
|
1504
|
+
queriesControllerGetQuery(queryId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchQueryDto, any, {}>>;
|
|
1505
|
+
/**
|
|
1506
|
+
* Lists batch query runs (submitted via YAML).
|
|
1507
|
+
* @summary List batch queries
|
|
1508
|
+
* @param {number} [page] 1-based page number.
|
|
1509
|
+
* @param {number} [limit] Page size.
|
|
1510
|
+
* @param {string} [documentId] Filter by document ID.
|
|
1511
|
+
* @param {*} [options] Override http request option.
|
|
1512
|
+
* @throws {RequiredError}
|
|
1513
|
+
*/
|
|
1514
|
+
queriesControllerListQueries(page?: number, limit?: number, documentId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedQueriesDto, any, {}>>;
|
|
1515
|
+
/**
|
|
1516
|
+
* Validates an uploaded batch queries YAML without creating a query.
|
|
1517
|
+
* @summary Validate batch query YAML
|
|
1518
|
+
* @param {File} yaml YAML file to validate.
|
|
1519
|
+
* @param {*} [options] Override http request option.
|
|
1520
|
+
* @throws {RequiredError}
|
|
1521
|
+
*/
|
|
1522
|
+
queriesControllerValidateQueryYaml(yaml: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValidationResultDto, any, {}>>;
|
|
1523
|
+
}
|
|
1524
|
+
/**
|
|
1525
|
+
* SourcesApi - axios parameter creator
|
|
1526
|
+
*/
|
|
1527
|
+
export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1528
|
+
/**
|
|
1529
|
+
* Returns source data used to produce answers/results. If sourceId is provided, returns the matching source. Otherwise returns a list.
|
|
1530
|
+
* @summary Read document sources
|
|
1531
|
+
* @param {string} documentId Document ID.
|
|
1532
|
+
* @param {any} [jobId] Optional job ID to scope sources to a specific query job.
|
|
1533
|
+
* @param {any} [sourceId] Optional source ID (full or partial) to retrieve a specific source.
|
|
1534
|
+
* @param {*} [options] Override http request option.
|
|
1535
|
+
* @throws {RequiredError}
|
|
1536
|
+
*/
|
|
1537
|
+
sourcesControllerGetDocumentSources: (documentId: string, jobId?: any, sourceId?: any, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1538
|
+
};
|
|
1539
|
+
/**
|
|
1540
|
+
* SourcesApi - functional programming interface
|
|
1541
|
+
*/
|
|
1542
|
+
export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
1543
|
+
/**
|
|
1544
|
+
* Returns source data used to produce answers/results. If sourceId is provided, returns the matching source. Otherwise returns a list.
|
|
1545
|
+
* @summary Read document sources
|
|
1546
|
+
* @param {string} documentId Document ID.
|
|
1547
|
+
* @param {any} [jobId] Optional job ID to scope sources to a specific query job.
|
|
1548
|
+
* @param {any} [sourceId] Optional source ID (full or partial) to retrieve a specific source.
|
|
1549
|
+
* @param {*} [options] Override http request option.
|
|
1550
|
+
* @throws {RequiredError}
|
|
1551
|
+
*/
|
|
1552
|
+
sourcesControllerGetDocumentSources(documentId: string, jobId?: any, sourceId?: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentSourcesResponseDto>>;
|
|
1553
|
+
};
|
|
1554
|
+
/**
|
|
1555
|
+
* SourcesApi - factory interface
|
|
1556
|
+
*/
|
|
1557
|
+
export declare const SourcesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1558
|
+
/**
|
|
1559
|
+
* Returns source data used to produce answers/results. If sourceId is provided, returns the matching source. Otherwise returns a list.
|
|
1560
|
+
* @summary Read document sources
|
|
1561
|
+
* @param {string} documentId Document ID.
|
|
1562
|
+
* @param {any} [jobId] Optional job ID to scope sources to a specific query job.
|
|
1563
|
+
* @param {any} [sourceId] Optional source ID (full or partial) to retrieve a specific source.
|
|
1564
|
+
* @param {*} [options] Override http request option.
|
|
1565
|
+
* @throws {RequiredError}
|
|
1566
|
+
*/
|
|
1567
|
+
sourcesControllerGetDocumentSources(documentId: string, jobId?: any, sourceId?: any, options?: RawAxiosRequestConfig): AxiosPromise<DocumentSourcesResponseDto>;
|
|
1568
|
+
};
|
|
1569
|
+
/**
|
|
1570
|
+
* SourcesApi - object-oriented interface
|
|
1571
|
+
*/
|
|
1572
|
+
export declare class SourcesApi extends BaseAPI {
|
|
1573
|
+
/**
|
|
1574
|
+
* Returns source data used to produce answers/results. If sourceId is provided, returns the matching source. Otherwise returns a list.
|
|
1575
|
+
* @summary Read document sources
|
|
1576
|
+
* @param {string} documentId Document ID.
|
|
1577
|
+
* @param {any} [jobId] Optional job ID to scope sources to a specific query job.
|
|
1578
|
+
* @param {any} [sourceId] Optional source ID (full or partial) to retrieve a specific source.
|
|
1579
|
+
* @param {*} [options] Override http request option.
|
|
1580
|
+
* @throws {RequiredError}
|
|
1581
|
+
*/
|
|
1582
|
+
sourcesControllerGetDocumentSources(documentId: string, jobId?: any, sourceId?: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentSourcesResponseDto, any, {}>>;
|
|
1583
|
+
}
|
|
1584
|
+
/**
|
|
1585
|
+
* WebhooksApi - axios parameter creator
|
|
1586
|
+
*/
|
|
1587
|
+
export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1588
|
+
/**
|
|
1589
|
+
*
|
|
1590
|
+
* @summary Create webhook
|
|
1591
|
+
* @param {CreateWebhookInputDto} createWebhookInputDto
|
|
1592
|
+
* @param {*} [options] Override http request option.
|
|
1593
|
+
* @throws {RequiredError}
|
|
1594
|
+
*/
|
|
1595
|
+
webhooksControllerCreateWebhook: (createWebhookInputDto: CreateWebhookInputDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1596
|
+
/**
|
|
1597
|
+
*
|
|
1598
|
+
* @summary Delete webhook
|
|
1599
|
+
* @param {string} webhookId Webhook ID.
|
|
1600
|
+
* @param {*} [options] Override http request option.
|
|
1601
|
+
* @throws {RequiredError}
|
|
1602
|
+
*/
|
|
1603
|
+
webhooksControllerDeleteWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1604
|
+
/**
|
|
1605
|
+
*
|
|
1606
|
+
* @summary Read webhook
|
|
1607
|
+
* @param {string} webhookId Webhook ID.
|
|
1608
|
+
* @param {*} [options] Override http request option.
|
|
1609
|
+
* @throws {RequiredError}
|
|
1610
|
+
*/
|
|
1611
|
+
webhooksControllerGetWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1612
|
+
/**
|
|
1613
|
+
*
|
|
1614
|
+
* @summary List webhooks
|
|
1615
|
+
* @param {number} [page] 1-based page number.
|
|
1616
|
+
* @param {number} [limit] Page size.
|
|
1617
|
+
* @param {*} [options] Override http request option.
|
|
1618
|
+
* @throws {RequiredError}
|
|
1619
|
+
*/
|
|
1620
|
+
webhooksControllerListWebhooks: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1621
|
+
/**
|
|
1622
|
+
*
|
|
1623
|
+
* @summary Update webhook
|
|
1624
|
+
* @param {string} webhookId Webhook ID.
|
|
1625
|
+
* @param {UpdateWebhookBodyInputDto} updateWebhookBodyInputDto
|
|
1626
|
+
* @param {*} [options] Override http request option.
|
|
1627
|
+
* @throws {RequiredError}
|
|
1628
|
+
*/
|
|
1629
|
+
webhooksControllerUpdateWebhook: (webhookId: string, updateWebhookBodyInputDto: UpdateWebhookBodyInputDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1630
|
+
};
|
|
1631
|
+
/**
|
|
1632
|
+
* WebhooksApi - functional programming interface
|
|
1633
|
+
*/
|
|
1634
|
+
export declare const WebhooksApiFp: (configuration?: Configuration) => {
|
|
1635
|
+
/**
|
|
1636
|
+
*
|
|
1637
|
+
* @summary Create webhook
|
|
1638
|
+
* @param {CreateWebhookInputDto} createWebhookInputDto
|
|
1639
|
+
* @param {*} [options] Override http request option.
|
|
1640
|
+
* @throws {RequiredError}
|
|
1641
|
+
*/
|
|
1642
|
+
webhooksControllerCreateWebhook(createWebhookInputDto: CreateWebhookInputDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookDto>>;
|
|
1643
|
+
/**
|
|
1644
|
+
*
|
|
1645
|
+
* @summary Delete webhook
|
|
1646
|
+
* @param {string} webhookId Webhook ID.
|
|
1647
|
+
* @param {*} [options] Override http request option.
|
|
1648
|
+
* @throws {RequiredError}
|
|
1649
|
+
*/
|
|
1650
|
+
webhooksControllerDeleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookDto>>;
|
|
1651
|
+
/**
|
|
1652
|
+
*
|
|
1653
|
+
* @summary Read webhook
|
|
1654
|
+
* @param {string} webhookId Webhook ID.
|
|
1655
|
+
* @param {*} [options] Override http request option.
|
|
1656
|
+
* @throws {RequiredError}
|
|
1657
|
+
*/
|
|
1658
|
+
webhooksControllerGetWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookDto>>;
|
|
1659
|
+
/**
|
|
1660
|
+
*
|
|
1661
|
+
* @summary List webhooks
|
|
1662
|
+
* @param {number} [page] 1-based page number.
|
|
1663
|
+
* @param {number} [limit] Page size.
|
|
1664
|
+
* @param {*} [options] Override http request option.
|
|
1665
|
+
* @throws {RequiredError}
|
|
1666
|
+
*/
|
|
1667
|
+
webhooksControllerListWebhooks(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedWebhooksDto>>;
|
|
1668
|
+
/**
|
|
1669
|
+
*
|
|
1670
|
+
* @summary Update webhook
|
|
1671
|
+
* @param {string} webhookId Webhook ID.
|
|
1672
|
+
* @param {UpdateWebhookBodyInputDto} updateWebhookBodyInputDto
|
|
1673
|
+
* @param {*} [options] Override http request option.
|
|
1674
|
+
* @throws {RequiredError}
|
|
1675
|
+
*/
|
|
1676
|
+
webhooksControllerUpdateWebhook(webhookId: string, updateWebhookBodyInputDto: UpdateWebhookBodyInputDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookDto>>;
|
|
1677
|
+
};
|
|
1678
|
+
/**
|
|
1679
|
+
* WebhooksApi - factory interface
|
|
1680
|
+
*/
|
|
1681
|
+
export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1682
|
+
/**
|
|
1683
|
+
*
|
|
1684
|
+
* @summary Create webhook
|
|
1685
|
+
* @param {CreateWebhookInputDto} createWebhookInputDto
|
|
1686
|
+
* @param {*} [options] Override http request option.
|
|
1687
|
+
* @throws {RequiredError}
|
|
1688
|
+
*/
|
|
1689
|
+
webhooksControllerCreateWebhook(createWebhookInputDto: CreateWebhookInputDto, options?: RawAxiosRequestConfig): AxiosPromise<WebhookDto>;
|
|
1690
|
+
/**
|
|
1691
|
+
*
|
|
1692
|
+
* @summary Delete webhook
|
|
1693
|
+
* @param {string} webhookId Webhook ID.
|
|
1694
|
+
* @param {*} [options] Override http request option.
|
|
1695
|
+
* @throws {RequiredError}
|
|
1696
|
+
*/
|
|
1697
|
+
webhooksControllerDeleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise<WebhookDto>;
|
|
1698
|
+
/**
|
|
1699
|
+
*
|
|
1700
|
+
* @summary Read webhook
|
|
1701
|
+
* @param {string} webhookId Webhook ID.
|
|
1702
|
+
* @param {*} [options] Override http request option.
|
|
1703
|
+
* @throws {RequiredError}
|
|
1704
|
+
*/
|
|
1705
|
+
webhooksControllerGetWebhook(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise<WebhookDto>;
|
|
1706
|
+
/**
|
|
1707
|
+
*
|
|
1708
|
+
* @summary List webhooks
|
|
1709
|
+
* @param {number} [page] 1-based page number.
|
|
1710
|
+
* @param {number} [limit] Page size.
|
|
1711
|
+
* @param {*} [options] Override http request option.
|
|
1712
|
+
* @throws {RequiredError}
|
|
1713
|
+
*/
|
|
1714
|
+
webhooksControllerListWebhooks(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedWebhooksDto>;
|
|
1715
|
+
/**
|
|
1716
|
+
*
|
|
1717
|
+
* @summary Update webhook
|
|
1718
|
+
* @param {string} webhookId Webhook ID.
|
|
1719
|
+
* @param {UpdateWebhookBodyInputDto} updateWebhookBodyInputDto
|
|
1720
|
+
* @param {*} [options] Override http request option.
|
|
1721
|
+
* @throws {RequiredError}
|
|
1722
|
+
*/
|
|
1723
|
+
webhooksControllerUpdateWebhook(webhookId: string, updateWebhookBodyInputDto: UpdateWebhookBodyInputDto, options?: RawAxiosRequestConfig): AxiosPromise<WebhookDto>;
|
|
1724
|
+
};
|
|
1725
|
+
/**
|
|
1726
|
+
* WebhooksApi - object-oriented interface
|
|
1727
|
+
*/
|
|
1728
|
+
export declare class WebhooksApi extends BaseAPI {
|
|
1729
|
+
/**
|
|
1730
|
+
*
|
|
1731
|
+
* @summary Create webhook
|
|
1732
|
+
* @param {CreateWebhookInputDto} createWebhookInputDto
|
|
1733
|
+
* @param {*} [options] Override http request option.
|
|
1734
|
+
* @throws {RequiredError}
|
|
1735
|
+
*/
|
|
1736
|
+
webhooksControllerCreateWebhook(createWebhookInputDto: CreateWebhookInputDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhookDto, any, {}>>;
|
|
1737
|
+
/**
|
|
1738
|
+
*
|
|
1739
|
+
* @summary Delete webhook
|
|
1740
|
+
* @param {string} webhookId Webhook ID.
|
|
1741
|
+
* @param {*} [options] Override http request option.
|
|
1742
|
+
* @throws {RequiredError}
|
|
1743
|
+
*/
|
|
1744
|
+
webhooksControllerDeleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhookDto, any, {}>>;
|
|
1745
|
+
/**
|
|
1746
|
+
*
|
|
1747
|
+
* @summary Read webhook
|
|
1748
|
+
* @param {string} webhookId Webhook ID.
|
|
1749
|
+
* @param {*} [options] Override http request option.
|
|
1750
|
+
* @throws {RequiredError}
|
|
1751
|
+
*/
|
|
1752
|
+
webhooksControllerGetWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhookDto, any, {}>>;
|
|
1753
|
+
/**
|
|
1754
|
+
*
|
|
1755
|
+
* @summary List webhooks
|
|
1756
|
+
* @param {number} [page] 1-based page number.
|
|
1757
|
+
* @param {number} [limit] Page size.
|
|
1758
|
+
* @param {*} [options] Override http request option.
|
|
1759
|
+
* @throws {RequiredError}
|
|
1760
|
+
*/
|
|
1761
|
+
webhooksControllerListWebhooks(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedWebhooksDto, any, {}>>;
|
|
1762
|
+
/**
|
|
1763
|
+
*
|
|
1764
|
+
* @summary Update webhook
|
|
1765
|
+
* @param {string} webhookId Webhook ID.
|
|
1766
|
+
* @param {UpdateWebhookBodyInputDto} updateWebhookBodyInputDto
|
|
1767
|
+
* @param {*} [options] Override http request option.
|
|
1768
|
+
* @throws {RequiredError}
|
|
1769
|
+
*/
|
|
1770
|
+
webhooksControllerUpdateWebhook(webhookId: string, updateWebhookBodyInputDto: UpdateWebhookBodyInputDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhookDto, any, {}>>;
|
|
1771
|
+
}
|