Repository navigation
Expand file tree
/
Copy pathclassify.ts
More file actions
1078 lines (937 loc) · 26.2 KB
/
Copy pathclassify.ts
File metadata and controls
1078 lines (937 loc) · 26.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../core/resource';
import { APIPromise } from '../core/api-promise';
import { PagePromise, PaginatedCursor, type PaginatedCursorParams } from '../core/pagination';
import { RequestOptions } from '../internal/request-options';
import { path } from '../internal/utils/path';
import { pollUntilComplete, PollingOptions, DEFAULT_TIMEOUT } from '../core/polling';
export class Classify extends APIResource {
/**
* Create a classify job.
*
* Classifies a document against a set of rules. Set `file_input` to a file ID
* (`dfl-...`) or parse job ID (`pjb-...`), and provide either inline
* `configuration` with rules or a `configuration_id` referencing a saved preset.
*
* Each rule has a `type` (the label to assign) and a `description` (natural
* language criteria). The classifier returns the best matching rule with a
* confidence score.
*
* The job runs asynchronously. Poll `GET /classify/{job_id}` to check status and
* retrieve results.
*
* @example
* ```ts
* const classify = await client.classify.create();
* ```
*/
create(params: ClassifyCreateParams, options?: RequestOptions): APIPromise<ClassifyCreateResponse> {
const { organization_id, project_id, ...body } = params;
return this._client.post('/api/v2/classify', {
query: { organization_id, project_id },
body,
...options,
});
}
/**
* List classify jobs with optional filtering and pagination.
*
* Filter by `status`, `configuration_id`, specific `job_ids`, or creation date
* range.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const classifyListResponse of client.classify.list()) {
* // ...
* }
* ```
*/
list(
query: ClassifyListParams | null | undefined = {},
options?: RequestOptions,
): PagePromise<ClassifyListResponsesPaginatedCursor, ClassifyListResponse> {
return this._client.getAPIList('/api/v2/classify', PaginatedCursor<ClassifyListResponse>, {
query,
...options,
});
}
/**
* Get a classify job by ID.
*
* Returns the job status, configuration, and classify result when complete. The
* result includes the matched document type, confidence score, and reasoning. Use
* `expand=usage` for credits billed against the job.
*
* @example
* ```ts
* const classify = await client.classify.get('job_id');
* ```
*/
get(
jobID: string,
query: ClassifyGetParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<ClassifyGetResponse> {
return this._client.get(path`/api/v2/classify/${jobID}`, { query, ...options });
}
/**
* Cancel a running classify job.
*
* Stops processing and marks the job as CANCELLED. Returns the updated job. Jobs
* already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.
*
* @example
* ```ts
* const response = await client.classify.cancel('job_id');
* ```
*/
cancel(
jobID: string,
params: ClassifyCancelParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<ClassifyCancelResponse> {
const { organization_id, project_id } = params ?? {};
return this._client.post(path`/api/v2/classify/${jobID}/cancel`, {
query: { organization_id, project_id },
...options,
});
}
/**
* Delete a classify job and its result.
*
* The job must be in a terminal state (COMPLETED, FAILED, CANCELLED). Cancel a job
* that is still running before deleting it.
*
* Returns the identifiers of the deleted job.
*
* @example
* ```ts
* const classify = await client.classify.delete('job_id');
* ```
*/
delete(
jobID: string,
params: ClassifyDeleteParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<ClassifyDeleteResponse> {
const { organization_id, project_id } = params ?? {};
return this._client.delete(path`/api/v2/classify/${jobID}`, {
query: { organization_id, project_id },
...options,
});
}
/**
* Wait for a classify job to complete by polling until it reaches a terminal state.
*
* @param jobID - The ID of the classify job to wait for
* @param query - Optional query parameters (organization_id, project_id)
* @param options - Polling configuration and request options
* @returns The completed classify job
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
* @throws {PollingError} If the job fails
*
* @example
* ```typescript
* const job = await client.classify.create({
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
* configuration_id: 'cfg-...',
* });
*
* const completed = await client.classify.waitForCompletion(job.id, undefined, { verbose: true });
* console.log(completed.result);
* ```
*/
async waitForCompletion(
jobID: string,
query?: ClassifyGetParams,
options?: PollingOptions & RequestOptions,
): Promise<ClassifyGetResponse> {
const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
const getStatus = async (): Promise<ClassifyGetResponse> => {
return await this.get(jobID, query, requestOptions);
};
const isComplete = (job: ClassifyGetResponse): boolean => {
return job.status === 'COMPLETED';
};
const isError = (job: ClassifyGetResponse): boolean => {
return job.status === 'FAILED';
};
const getErrorMessage = (job: ClassifyGetResponse): string => {
const errorParts = [`Job ${jobID} failed with status: ${job.status}`];
if (job.error_message) {
errorParts.push(`Error: ${job.error_message}`);
}
return errorParts.join(' | ');
};
return await pollUntilComplete(getStatus, isComplete, isError, getErrorMessage, {
pollingInterval,
maxInterval,
timeout: timeout || DEFAULT_TIMEOUT,
backoff,
verbose,
});
}
/**
* Create a classify job, wait for it to complete, and return the result.
*
* This is a convenience method that combines create() and waitForCompletion()
* into a single call for the most common end-to-end workflow.
*
* @param params - Classify job creation parameters
* @param options - Polling configuration and request options
* @returns The completed classify job with result populated
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
* @throws {PollingError} If the job fails
*
* @example
* ```typescript
* import { LlamaCloud } from 'llama-cloud';
*
* const client = new LlamaCloud({ apiKey: '...' });
*
* const result = await client.classify.run({
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
* configuration: {
* rules: [{ type: 'invoice', description: 'contains invoice number' }],
* },
* }, { verbose: true });
*
* console.log(result.result);
* ```
*/
async run(
params: ClassifyCreateParams,
options?: PollingOptions & RequestOptions,
): Promise<ClassifyGetResponse> {
const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
const job = await this.create(params, requestOptions);
const getQuery: ClassifyGetParams = {};
if (params.organization_id !== undefined) {
getQuery.organization_id = params.organization_id;
}
if (params.project_id !== undefined) {
getQuery.project_id = params.project_id;
}
return await this.waitForCompletion(job.id, getQuery, {
pollingInterval,
maxInterval,
timeout: timeout || DEFAULT_TIMEOUT,
backoff,
verbose,
...requestOptions,
});
}
}
export type ClassifyListResponsesPaginatedCursor = PaginatedCursor<ClassifyListResponse>;
/**
* Configuration for a classify job.
*/
export interface ClassifyConfiguration {
/**
* Classify rules to evaluate against the document (at least one required)
*/
rules: Array<ClassifyConfiguration.Rule>;
/**
* Classify execution mode
*/
mode?: 'FAST';
/**
* Parsing configuration for classify jobs.
*/
parsing_configuration?: ClassifyConfiguration.ParsingConfiguration | null;
}
export namespace ClassifyConfiguration {
/**
* A rule for classifying documents.
*/
export interface Rule {
/**
* Natural language criteria for matching this rule
*/
description: string;
/**
* Document type to assign when rule matches
*/
type: string;
}
/**
* Parsing configuration for classify jobs.
*/
export interface ParsingConfiguration {
/**
* ISO 639-1 language code for the document
*/
lang?: string;
/**
* Maximum number of pages to process. Omit for no limit.
*/
max_pages?: number | null;
/**
* Comma-separated page numbers or ranges to process (1-based). Omit to process all
* pages.
*/
target_pages?: string | null;
}
}
/**
* Request to create a classify job.
*/
export interface ClassifyCreateRequest {
/**
* Configuration for a classify job.
*/
configuration?: ClassifyConfiguration | null;
/**
* Saved configuration ID
*/
configuration_id?: string | null;
/**
* @deprecated Deprecated: use file_input instead
*/
file_id?: string | null;
/**
* File ID or parse job ID to classify
*/
file_input?: string | null;
/**
* @deprecated Deprecated: use file_input instead
*/
parse_job_id?: string | null;
/**
* Idempotency key scoped to the project. Reusing a key returns the original job;
* the new request body is ignored.
*/
transaction_id?: string | null;
/**
* IDs of saved webhook configurations to notify for this job.
*/
webhook_configuration_ids?: Array<string> | null;
/**
* Outbound webhook endpoints to notify on job status changes
*/
webhook_configurations?: Array<ClassifyCreateRequest.WebhookConfiguration> | null;
}
export namespace ClassifyCreateRequest {
/**
* Configuration for a single outbound webhook endpoint.
*/
export interface WebhookConfiguration {
/**
* Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all
* events are delivered.
*/
webhook_events?: Array<
| 'batch.cancelled'
| 'batch.error'
| 'batch.pending'
| 'batch.running'
| 'batch.success'
| 'classify.cancelled'
| 'classify.error'
| 'classify.partial_success'
| 'classify.pending'
| 'classify.running'
| 'classify.success'
| 'extract.cancelled'
| 'extract.error'
| 'extract.partial_success'
| 'extract.pending'
| 'extract.success'
| 'parse.cancelled'
| 'parse.error'
| 'parse.partial_success'
| 'parse.pending'
| 'parse.running'
| 'parse.success'
| 'sheets.cancelled'
| 'sheets.error'
| 'sheets.partial_success'
| 'sheets.pending'
| 'sheets.success'
| 'split.cancelled'
| 'split.error'
| 'split.pending'
| 'split.processing'
| 'split.success'
| 'unmapped_event'
| 'verify.cancelled'
| 'verify.error'
| 'verify.pending'
| 'verify.running'
| 'verify.success'
> | null;
/**
* Custom HTTP headers sent with each webhook request (e.g. auth tokens)
*/
webhook_headers?: { [key: string]: string } | null;
/**
* Response format sent to the webhook: 'string' (default) or 'json'
*/
webhook_output_format?: string | null;
/**
* Shared signing secret used to sign webhook deliveries. When set, each request
* includes an HMAC-SHA256 signature of the request body in the 'LC-Signature'
* header (value 'sha256=<hex>'). Recompute the HMAC over the raw request body with
* this secret to verify the delivery is authentic.
*/
webhook_signing_secret?: string | null;
/**
* URL to receive webhook POST notifications
*/
webhook_url?: string | null;
}
}
/**
* Result of classifying a document.
*/
export interface ClassifyResult {
/**
* Confidence score between 0.0 and 1.0
*/
confidence: number;
/**
* Why the document matched (or didn't match) the returned rule
*/
reasoning: string;
/**
* Matched rule type, or null if no rule matched
*/
type: string | null;
}
/**
* Response for a classify job.
*/
export interface ClassifyCreateResponse {
/**
* Unique identifier
*/
id: string;
/**
* Classify configuration used for this job
*/
configuration: ClassifyConfiguration;
/**
* Whether the input was a file or parse job (FILE or PARSE_JOB)
*/
document_input_type: 'file_id' | 'parse_job_id' | 'url';
/**
* ID of the input file or parse job
*/
file_input: string;
/**
* Project this job belongs to
*/
project_id: string;
/**
* Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
*/
status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
/**
* User who created this job
*/
user_id: string;
/**
* Product configuration ID
*/
configuration_id?: string | null;
/**
* Creation datetime
*/
created_at?: string | null;
/**
* Error message if job failed
*/
error_message?: string | null;
/**
* Associated parse job ID
*/
parse_job_id?: string | null;
/**
* Result of classifying a document.
*/
result?: ClassifyResult | null;
/**
* Idempotency key
*/
transaction_id?: string | null;
/**
* Update datetime
*/
updated_at?: string | null;
/**
* Usage recorded against a classify job.
*
* Classify bills through the parse job it runs on a file input, so that parse
* job's credits are the whole total. A job run on a parse job you created bills
* nothing of its own: `parse_credits` is null and `credits` is 0.
*/
usage?: ClassifyCreateResponse.Usage | null;
}
export namespace ClassifyCreateResponse {
/**
* Usage recorded against a classify job.
*
* Classify bills through the parse job it runs on a file input, so that parse
* job's credits are the whole total. A job run on a parse job you created bills
* nothing of its own: `parse_credits` is null and `credits` is 0.
*/
export interface Usage {
/**
* Total credits billed against this job. Null until billing has recorded it.
*/
credits?: number | null;
/**
* Credits billed against the parse job Classify ran on the input file
*/
parse_credits?: number | null;
}
}
/**
* Response for a classify job.
*/
export interface ClassifyListResponse {
/**
* Unique identifier
*/
id: string;
/**
* Classify configuration used for this job
*/
configuration: ClassifyConfiguration;
/**
* Whether the input was a file or parse job (FILE or PARSE_JOB)
*/
document_input_type: 'file_id' | 'parse_job_id' | 'url';
/**
* ID of the input file or parse job
*/
file_input: string;
/**
* Project this job belongs to
*/
project_id: string;
/**
* Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
*/
status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
/**
* User who created this job
*/
user_id: string;
/**
* Product configuration ID
*/
configuration_id?: string | null;
/**
* Creation datetime
*/
created_at?: string | null;
/**
* Error message if job failed
*/
error_message?: string | null;
/**
* Associated parse job ID
*/
parse_job_id?: string | null;
/**
* Result of classifying a document.
*/
result?: ClassifyResult | null;
/**
* Idempotency key
*/
transaction_id?: string | null;
/**
* Update datetime
*/
updated_at?: string | null;
/**
* Usage recorded against a classify job.
*
* Classify bills through the parse job it runs on a file input, so that parse
* job's credits are the whole total. A job run on a parse job you created bills
* nothing of its own: `parse_credits` is null and `credits` is 0.
*/
usage?: ClassifyListResponse.Usage | null;
}
export namespace ClassifyListResponse {
/**
* Usage recorded against a classify job.
*
* Classify bills through the parse job it runs on a file input, so that parse
* job's credits are the whole total. A job run on a parse job you created bills
* nothing of its own: `parse_credits` is null and `credits` is 0.
*/
export interface Usage {
/**
* Total credits billed against this job. Null until billing has recorded it.
*/
credits?: number | null;
/**
* Credits billed against the parse job Classify ran on the input file
*/
parse_credits?: number | null;
}
}
/**
* Identifiers for a deleted classify job.
*/
export interface ClassifyDeleteResponse {
/**
* Identifier of the deleted classify job
*/
id: string;
/**
* Project the deleted job belonged to
*/
project_id?: string | null;
}
/**
* Response for a classify job.
*/
export interface ClassifyCancelResponse {
/**
* Unique identifier
*/
id: string;
/**
* Classify configuration used for this job
*/
configuration: ClassifyConfiguration;
/**
* Whether the input was a file or parse job (FILE or PARSE_JOB)
*/
document_input_type: 'file_id' | 'parse_job_id' | 'url';
/**
* ID of the input file or parse job
*/
file_input: string;
/**
* Project this job belongs to
*/
project_id: string;
/**
* Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
*/
status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
/**
* User who created this job
*/
user_id: string;
/**
* Product configuration ID
*/
configuration_id?: string | null;
/**
* Creation datetime
*/
created_at?: string | null;
/**
* Error message if job failed
*/
error_message?: string | null;
/**
* Associated parse job ID
*/
parse_job_id?: string | null;
/**
* Result of classifying a document.
*/
result?: ClassifyResult | null;
/**
* Idempotency key
*/
transaction_id?: string | null;
/**
* Update datetime
*/
updated_at?: string | null;
/**
* Usage recorded against a classify job.
*
* Classify bills through the parse job it runs on a file input, so that parse
* job's credits are the whole total. A job run on a parse job you created bills
* nothing of its own: `parse_credits` is null and `credits` is 0.
*/
usage?: ClassifyCancelResponse.Usage | null;
}
export namespace ClassifyCancelResponse {
/**
* Usage recorded against a classify job.
*
* Classify bills through the parse job it runs on a file input, so that parse
* job's credits are the whole total. A job run on a parse job you created bills
* nothing of its own: `parse_credits` is null and `credits` is 0.
*/
export interface Usage {
/**
* Total credits billed against this job. Null until billing has recorded it.
*/
credits?: number | null;
/**
* Credits billed against the parse job Classify ran on the input file
*/
parse_credits?: number | null;
}
}
/**
* Response for a classify job.
*/
export interface ClassifyGetResponse {
/**
* Unique identifier
*/
id: string;
/**
* Classify configuration used for this job
*/
configuration: ClassifyConfiguration;
/**
* Whether the input was a file or parse job (FILE or PARSE_JOB)
*/
document_input_type: 'file_id' | 'parse_job_id' | 'url';
/**
* ID of the input file or parse job
*/
file_input: string;
/**
* Project this job belongs to
*/
project_id: string;
/**
* Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
*/
status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
/**
* User who created this job
*/
user_id: string;
/**
* Product configuration ID
*/
configuration_id?: string | null;
/**
* Creation datetime
*/
created_at?: string | null;
/**
* Error message if job failed
*/
error_message?: string | null;
/**
* Associated parse job ID
*/
parse_job_id?: string | null;
/**
* Result of classifying a document.
*/
result?: ClassifyResult | null;
/**
* Idempotency key
*/
transaction_id?: string | null;
/**
* Update datetime
*/
updated_at?: string | null;
/**
* Usage recorded against a classify job.
*
* Classify bills through the parse job it runs on a file input, so that parse
* job's credits are the whole total. A job run on a parse job you created bills
* nothing of its own: `parse_credits` is null and `credits` is 0.
*/
usage?: ClassifyGetResponse.Usage | null;
}
export namespace ClassifyGetResponse {
/**
* Usage recorded against a classify job.
*
* Classify bills through the parse job it runs on a file input, so that parse
* job's credits are the whole total. A job run on a parse job you created bills
* nothing of its own: `parse_credits` is null and `credits` is 0.
*/
export interface Usage {
/**
* Total credits billed against this job. Null until billing has recorded it.
*/
credits?: number | null;
/**
* Credits billed against the parse job Classify ran on the input file
*/
parse_credits?: number | null;
}
}
export interface ClassifyCreateParams {
/**
* Query param
*/
organization_id?: string | null;
/**
* Query param
*/
project_id?: string | null;
/**
* Body param: Configuration for a classify job.
*/
configuration?: ClassifyConfiguration | null;
/**
* Body param: Saved configuration ID
*/
configuration_id?: string | null;
/**
* @deprecated Body param: Deprecated: use file_input instead
*/
file_id?: string | null;
/**
* Body param: File ID or parse job ID to classify
*/
file_input?: string | null;
/**
* @deprecated Body param: Deprecated: use file_input instead
*/
parse_job_id?: string | null;
/**
* Body param: Idempotency key scoped to the project. Reusing a key returns the
* original job; the new request body is ignored.
*/
transaction_id?: string | null;
/**
* Body param: IDs of saved webhook configurations to notify for this job.
*/
webhook_configuration_ids?: Array<string> | null;
/**
* Body param: Outbound webhook endpoints to notify on job status changes
*/
webhook_configurations?: Array<ClassifyCreateParams.WebhookConfiguration> | null;
}
export namespace ClassifyCreateParams {
/**
* Configuration for a single outbound webhook endpoint.
*/
export interface WebhookConfiguration {
/**
* Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all
* events are delivered.
*/
webhook_events?: Array<
| 'batch.cancelled'
| 'batch.error'
| 'batch.pending'
| 'batch.running'
| 'batch.success'
| 'classify.cancelled'
| 'classify.error'
| 'classify.partial_success'
| 'classify.pending'
| 'classify.running'
| 'classify.success'
| 'extract.cancelled'
| 'extract.error'
| 'extract.partial_success'
| 'extract.pending'
| 'extract.success'
| 'parse.cancelled'
| 'parse.error'
| 'parse.partial_success'
| 'parse.pending'
| 'parse.running'
| 'parse.success'
| 'sheets.cancelled'
| 'sheets.error'
| 'sheets.partial_success'
| 'sheets.pending'
| 'sheets.success'
| 'split.cancelled'
| 'split.error'
| 'split.pending'
| 'split.processing'
| 'split.success'
| 'unmapped_event'
| 'verify.cancelled'
| 'verify.error'
| 'verify.pending'
| 'verify.running'
| 'verify.success'
> | null;
/**
* Custom HTTP headers sent with each webhook request (e.g. auth tokens)
*/
webhook_headers?: { [key: string]: string } | null;
/**
* Response format sent to the webhook: 'string' (default) or 'json'
*/
webhook_output_format?: string | null;
/**
* Shared signing secret used to sign webhook deliveries. When set, each request
* includes an HMAC-SHA256 signature of the request body in the 'LC-Signature'
* header (value 'sha256=<hex>'). Recompute the HMAC over the raw request body with
* this secret to verify the delivery is authentic.
*/
webhook_signing_secret?: string | null;
/**