@permute/sdk 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,536 @@
1
+ export type paths = Record<string, never>;
2
+ export type webhooks = Record<string, never>;
3
+ export interface components {
4
+ schemas: {
5
+ AnswerCitation: {
6
+ metadata?: {
7
+ [key: string]: unknown;
8
+ };
9
+ ref?: string;
10
+ sourceId?: string;
11
+ title?: string;
12
+ /** @enum {string} */
13
+ type: 'text' | 'table' | 'web';
14
+ url?: string;
15
+ };
16
+ AnswerConfidence: {
17
+ /** @enum {string} */
18
+ queryComplexity: 'high' | 'medium' | 'low';
19
+ reason: string;
20
+ score: number;
21
+ };
22
+ AnswerJobIdParams: {
23
+ answerJobId: string;
24
+ };
25
+ AnswerJobResponse: {
26
+ answerJobId: string;
27
+ /** Format: date-time */
28
+ completedAt?: string | null;
29
+ /** Format: date-time */
30
+ createdAt?: string;
31
+ error?: string;
32
+ pollAfterMs?: number;
33
+ result?: {
34
+ answer: string;
35
+ assumptions?: {
36
+ [key: string]: unknown;
37
+ }[];
38
+ charts?: {
39
+ [key: string]: unknown;
40
+ }[];
41
+ citations: {
42
+ metadata?: {
43
+ [key: string]: unknown;
44
+ };
45
+ ref?: string;
46
+ sourceId?: string;
47
+ title?: string;
48
+ /** @enum {string} */
49
+ type: 'text' | 'table' | 'web';
50
+ url?: string;
51
+ }[];
52
+ confidence?: {
53
+ /** @enum {string} */
54
+ queryComplexity: 'high' | 'medium' | 'low';
55
+ reason: string;
56
+ score: number;
57
+ };
58
+ followUps?: string[];
59
+ };
60
+ /** Format: date-time */
61
+ startedAt?: string | null;
62
+ /** @enum {string} */
63
+ status: 'queued' | 'running' | 'completed' | 'failed' | 'cancelled';
64
+ /** Format: date-time */
65
+ updatedAt?: string;
66
+ };
67
+ /** @enum {string} */
68
+ AnswerJobStatus: 'queued' | 'running' | 'completed' | 'failed' | 'cancelled';
69
+ AnswerRequest: {
70
+ question: string;
71
+ sourceIds?: string[];
72
+ };
73
+ AnswerResponse: {
74
+ answer: string;
75
+ assumptions?: {
76
+ [key: string]: unknown;
77
+ }[];
78
+ charts?: {
79
+ [key: string]: unknown;
80
+ }[];
81
+ citations: {
82
+ metadata?: {
83
+ [key: string]: unknown;
84
+ };
85
+ ref?: string;
86
+ sourceId?: string;
87
+ title?: string;
88
+ /** @enum {string} */
89
+ type: 'text' | 'table' | 'web';
90
+ url?: string;
91
+ }[];
92
+ confidence?: {
93
+ /** @enum {string} */
94
+ queryComplexity: 'high' | 'medium' | 'low';
95
+ reason: string;
96
+ score: number;
97
+ };
98
+ followUps?: string[];
99
+ };
100
+ ApiError: {
101
+ code: string;
102
+ details?: unknown;
103
+ message: string;
104
+ requestId?: string;
105
+ };
106
+ CatalogField: {
107
+ description?: string | null;
108
+ isPrimaryKey?: boolean | null;
109
+ name: string;
110
+ nullable?: boolean | null;
111
+ type?: string | null;
112
+ };
113
+ CatalogTable: {
114
+ fieldCount?: number;
115
+ fields?: {
116
+ description?: string | null;
117
+ isPrimaryKey?: boolean | null;
118
+ name: string;
119
+ nullable?: boolean | null;
120
+ type?: string | null;
121
+ }[];
122
+ id: string;
123
+ label?: string;
124
+ name: string;
125
+ provider?: string;
126
+ };
127
+ CustomDatasetResponse: {
128
+ context: string[];
129
+ /** Format: date-time */
130
+ createdAt: string;
131
+ id: string;
132
+ key: string;
133
+ name: string;
134
+ sourceId: string;
135
+ /** @enum {string} */
136
+ status: 'pending' | 'uploaded' | 'processing' | 'completed' | 'failed';
137
+ tables: {
138
+ columnCount: number;
139
+ name: string;
140
+ rowCount: number;
141
+ }[];
142
+ /** @enum {string} */
143
+ type: 'custom';
144
+ /** Format: date-time */
145
+ updatedAt: string;
146
+ version: number;
147
+ write?: {
148
+ error?: string;
149
+ id: string;
150
+ /** @enum {string} */
151
+ status: 'pending' | 'processing' | 'completed' | 'failed';
152
+ };
153
+ };
154
+ DatasetCreateRequest: {
155
+ context?: string[];
156
+ key: string;
157
+ name?: string;
158
+ /** @enum {string} */
159
+ type: 'custom';
160
+ } | {
161
+ contentType: string;
162
+ fileName: string;
163
+ sizeBytes: number;
164
+ /** @enum {string} */
165
+ type: 'file';
166
+ };
167
+ DatasetIdParams: {
168
+ datasetId: string;
169
+ };
170
+ DatasetKeyQuery: {
171
+ key: string;
172
+ };
173
+ DatasetResponse: {
174
+ context: string[];
175
+ /** Format: date-time */
176
+ createdAt: string;
177
+ id: string;
178
+ key: string;
179
+ name: string;
180
+ sourceId: string;
181
+ /** @enum {string} */
182
+ status: 'pending' | 'uploaded' | 'processing' | 'completed' | 'failed';
183
+ tables: {
184
+ columnCount: number;
185
+ name: string;
186
+ rowCount: number;
187
+ }[];
188
+ /** @enum {string} */
189
+ type: 'custom';
190
+ /** Format: date-time */
191
+ updatedAt: string;
192
+ version: number;
193
+ write?: {
194
+ error?: string;
195
+ id: string;
196
+ /** @enum {string} */
197
+ status: 'pending' | 'processing' | 'completed' | 'failed';
198
+ };
199
+ } | {
200
+ contentType: string;
201
+ /** Format: date-time */
202
+ createdAt: string;
203
+ error?: string;
204
+ id: string;
205
+ name: string;
206
+ progress?: {
207
+ details?: string;
208
+ percent: number;
209
+ step?: string;
210
+ stepLabel?: string;
211
+ };
212
+ sizeBytes: number;
213
+ sourceId: string;
214
+ /** @enum {string} */
215
+ status: 'pending' | 'uploaded' | 'processing' | 'completed' | 'failed';
216
+ /** @enum {string} */
217
+ type: 'file';
218
+ /** Format: date-time */
219
+ updatedAt: string;
220
+ upload?: {
221
+ /** Format: date-time */
222
+ expiresAt: string;
223
+ headers: {
224
+ [key: string]: string;
225
+ };
226
+ /** @enum {string} */
227
+ method: 'PUT';
228
+ /** Format: uri */
229
+ url: string;
230
+ };
231
+ };
232
+ /** @enum {string} */
233
+ DatasetStatus: 'pending' | 'uploaded' | 'processing' | 'completed' | 'failed';
234
+ DatasetTable: {
235
+ columnCount: number;
236
+ name: string;
237
+ rowCount: number;
238
+ };
239
+ DatasetWriteState: {
240
+ error?: string;
241
+ id: string;
242
+ /** @enum {string} */
243
+ status: 'pending' | 'processing' | 'completed' | 'failed';
244
+ };
245
+ DatasetWriteTablesRequest: {
246
+ contentHash: string;
247
+ /** @enum {string} */
248
+ mode: 'replace';
249
+ sizeBytes: number;
250
+ tables: {
251
+ name: string;
252
+ rowCount: number;
253
+ }[];
254
+ } | {
255
+ contentHash: string;
256
+ /** @enum {string} */
257
+ mode: 'replaceTable';
258
+ rowCount: number;
259
+ sizeBytes: number;
260
+ tableName: string;
261
+ } | {
262
+ batchId: string;
263
+ contentHash: string;
264
+ /** @enum {string} */
265
+ mode: 'appendTable';
266
+ rowCount: number;
267
+ sizeBytes: number;
268
+ tableName: string;
269
+ };
270
+ DatasetWriteTablesResponse: {
271
+ dataset: {
272
+ context: string[];
273
+ /** Format: date-time */
274
+ createdAt: string;
275
+ id: string;
276
+ key: string;
277
+ name: string;
278
+ sourceId: string;
279
+ /** @enum {string} */
280
+ status: 'pending' | 'uploaded' | 'processing' | 'completed' | 'failed';
281
+ tables: {
282
+ columnCount: number;
283
+ name: string;
284
+ rowCount: number;
285
+ }[];
286
+ /** @enum {string} */
287
+ type: 'custom';
288
+ /** Format: date-time */
289
+ updatedAt: string;
290
+ version: number;
291
+ write?: {
292
+ error?: string;
293
+ id: string;
294
+ /** @enum {string} */
295
+ status: 'pending' | 'processing' | 'completed' | 'failed';
296
+ };
297
+ };
298
+ pollAfterMs: number;
299
+ upload?: {
300
+ /** Format: date-time */
301
+ expiresAt: string;
302
+ headers: {
303
+ [key: string]: string;
304
+ };
305
+ /** @enum {string} */
306
+ method: 'PUT';
307
+ /** Format: uri */
308
+ url: string;
309
+ };
310
+ write: {
311
+ error?: string;
312
+ id: string;
313
+ /** @enum {string} */
314
+ status: 'pending' | 'processing' | 'completed' | 'failed';
315
+ };
316
+ };
317
+ EmptyObject: Record<string, never>;
318
+ FileDatasetResponse: {
319
+ contentType: string;
320
+ /** Format: date-time */
321
+ createdAt: string;
322
+ error?: string;
323
+ id: string;
324
+ name: string;
325
+ progress?: {
326
+ details?: string;
327
+ percent: number;
328
+ step?: string;
329
+ stepLabel?: string;
330
+ };
331
+ sizeBytes: number;
332
+ sourceId: string;
333
+ /** @enum {string} */
334
+ status: 'pending' | 'uploaded' | 'processing' | 'completed' | 'failed';
335
+ /** @enum {string} */
336
+ type: 'file';
337
+ /** Format: date-time */
338
+ updatedAt: string;
339
+ upload?: {
340
+ /** Format: date-time */
341
+ expiresAt: string;
342
+ headers: {
343
+ [key: string]: string;
344
+ };
345
+ /** @enum {string} */
346
+ method: 'PUT';
347
+ /** Format: uri */
348
+ url: string;
349
+ };
350
+ };
351
+ QueryRequest: {
352
+ limit?: number;
353
+ sourceIds: string[];
354
+ sql: string;
355
+ };
356
+ QueryResponse: {
357
+ columns: {
358
+ name: string;
359
+ type?: string;
360
+ }[];
361
+ executionMs: number;
362
+ queryId: string;
363
+ rowCount: number;
364
+ rows: {
365
+ [key: string]: unknown;
366
+ }[];
367
+ sourceIds: string[];
368
+ sql: string;
369
+ truncated: boolean;
370
+ };
371
+ SearchRequest: {
372
+ limit?: number;
373
+ query: string;
374
+ rerank?: boolean;
375
+ sourceIds?: string[];
376
+ types?: ('records' | 'documents' | 'tables' | 'text_blocks')[];
377
+ };
378
+ SearchResponse: {
379
+ items: {
380
+ citation?: {
381
+ [key: string]: unknown;
382
+ };
383
+ content: string;
384
+ metadata?: {
385
+ [key: string]: unknown;
386
+ };
387
+ score?: number;
388
+ sourceId?: string;
389
+ title?: string;
390
+ /** @enum {string} */
391
+ type: 'record' | 'document' | 'table' | 'text_block' | 'unknown';
392
+ }[];
393
+ meta: {
394
+ candidateCount?: number;
395
+ reranked: boolean;
396
+ /** @enum {string} */
397
+ strategy: 'semantic';
398
+ totalMs?: number;
399
+ };
400
+ };
401
+ SearchResult: {
402
+ citation?: {
403
+ [key: string]: unknown;
404
+ };
405
+ content: string;
406
+ metadata?: {
407
+ [key: string]: unknown;
408
+ };
409
+ score?: number;
410
+ sourceId?: string;
411
+ title?: string;
412
+ /** @enum {string} */
413
+ type: 'record' | 'document' | 'table' | 'text_block' | 'unknown';
414
+ };
415
+ Source: {
416
+ context?: string[];
417
+ fileType?: string;
418
+ id: string;
419
+ name: string;
420
+ provider?: string;
421
+ summary?: string | null;
422
+ /** @enum {string} */
423
+ type: 'dataset' | 'connector';
424
+ };
425
+ SourceDetail: {
426
+ metadata?: {
427
+ [key: string]: unknown;
428
+ };
429
+ source: {
430
+ context?: string[];
431
+ fileType?: string;
432
+ id: string;
433
+ name: string;
434
+ provider?: string;
435
+ summary?: string | null;
436
+ /** @enum {string} */
437
+ type: 'dataset' | 'connector';
438
+ };
439
+ tables: {
440
+ fieldCount?: number;
441
+ fields?: {
442
+ description?: string | null;
443
+ isPrimaryKey?: boolean | null;
444
+ name: string;
445
+ nullable?: boolean | null;
446
+ type?: string | null;
447
+ }[];
448
+ id: string;
449
+ label?: string;
450
+ name: string;
451
+ provider?: string;
452
+ }[];
453
+ };
454
+ SourceIdParams: {
455
+ sourceId: string;
456
+ };
457
+ SourceList: {
458
+ items: {
459
+ context?: string[];
460
+ fileType?: string;
461
+ id: string;
462
+ name: string;
463
+ provider?: string;
464
+ summary?: string | null;
465
+ /** @enum {string} */
466
+ type: 'dataset' | 'connector';
467
+ }[];
468
+ };
469
+ UploadProgress: {
470
+ details?: string;
471
+ percent: number;
472
+ step?: string;
473
+ stepLabel?: string;
474
+ };
475
+ UploadTarget: {
476
+ /** Format: date-time */
477
+ expiresAt: string;
478
+ headers: {
479
+ [key: string]: string;
480
+ };
481
+ /** @enum {string} */
482
+ method: 'PUT';
483
+ /** Format: uri */
484
+ url: string;
485
+ };
486
+ Workspace: {
487
+ context: string;
488
+ /** Format: date-time */
489
+ createdAt: string;
490
+ id: string;
491
+ name: string;
492
+ organizationId: string;
493
+ /** Format: date-time */
494
+ updatedAt: string;
495
+ /** @enum {string} */
496
+ visibility: 'private' | 'internal' | 'public' | 'unlisted';
497
+ };
498
+ WorkspaceCreateRequest: {
499
+ context?: string;
500
+ name: string;
501
+ };
502
+ WorkspaceDeleteResponse: {
503
+ /** @enum {boolean} */
504
+ deleted: true;
505
+ id: string;
506
+ };
507
+ WorkspaceIdParams: {
508
+ workspaceId: string;
509
+ };
510
+ WorkspaceList: {
511
+ items: {
512
+ context: string;
513
+ /** Format: date-time */
514
+ createdAt: string;
515
+ id: string;
516
+ name: string;
517
+ organizationId: string;
518
+ /** Format: date-time */
519
+ updatedAt: string;
520
+ /** @enum {string} */
521
+ visibility: 'private' | 'internal' | 'public' | 'unlisted';
522
+ }[];
523
+ };
524
+ WorkspaceUpdateRequest: {
525
+ context?: string;
526
+ name?: string;
527
+ };
528
+ };
529
+ responses: never;
530
+ parameters: never;
531
+ requestBodies: never;
532
+ headers: never;
533
+ pathItems: never;
534
+ }
535
+ export type $defs = Record<string, never>;
536
+ export type operations = Record<string, never>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,12 @@
1
+ export type JsonSchema = Record<string, unknown>;
2
+ export interface RuntimeRoute {
3
+ operationId: string;
4
+ method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
5
+ path: string;
6
+ scope: 'workspace' | 'organization' | 'none';
7
+ bodySchema: JsonSchema | null;
8
+ querySchema: JsonSchema | null;
9
+ responseSchema: JsonSchema;
10
+ }
11
+ export type PublicApiOperationId = 'workspacesList' | 'workspacesCreate' | 'workspacesGet' | 'workspacesUpdate' | 'workspacesDelete' | 'sourcesList' | 'sourcesGet' | 'datasetsCreate' | 'datasetsGetByKey' | 'datasetsGet' | 'datasetsWriteTables' | 'searchCreate' | 'answerJobsCreate' | 'answerJobsGet' | 'queriesCreate';
12
+ export declare const publicApiRoutes: Record<PublicApiOperationId, RuntimeRoute>;