parallel-web 0.2.4 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/LICENSE +1 -1
  3. package/client.d.mts +1 -1
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +1 -1
  6. package/client.d.ts.map +1 -1
  7. package/package.json +1 -1
  8. package/resources/beta/beta.d.mts +14 -7
  9. package/resources/beta/beta.d.mts.map +1 -1
  10. package/resources/beta/beta.d.ts +14 -7
  11. package/resources/beta/beta.d.ts.map +1 -1
  12. package/resources/beta/beta.js +3 -3
  13. package/resources/beta/beta.js.map +1 -1
  14. package/resources/beta/beta.mjs +4 -4
  15. package/resources/beta/beta.mjs.map +1 -1
  16. package/resources/beta/findall.d.mts +122 -432
  17. package/resources/beta/findall.d.mts.map +1 -1
  18. package/resources/beta/findall.d.ts +122 -432
  19. package/resources/beta/findall.d.ts.map +1 -1
  20. package/resources/beta/findall.js +20 -11
  21. package/resources/beta/findall.js.map +1 -1
  22. package/resources/beta/findall.mjs +18 -10
  23. package/resources/beta/findall.mjs.map +1 -1
  24. package/resources/beta/index.d.mts +1 -1
  25. package/resources/beta/index.d.mts.map +1 -1
  26. package/resources/beta/index.d.ts +1 -1
  27. package/resources/beta/index.d.ts.map +1 -1
  28. package/resources/beta/index.js +2 -1
  29. package/resources/beta/index.js.map +1 -1
  30. package/resources/beta/index.mjs +1 -1
  31. package/resources/beta/index.mjs.map +1 -1
  32. package/resources/beta/task-group.d.mts +3 -3
  33. package/resources/beta/task-group.d.ts +3 -3
  34. package/resources/beta/task-run.d.mts +13 -9
  35. package/resources/beta/task-run.d.mts.map +1 -1
  36. package/resources/beta/task-run.d.ts +13 -9
  37. package/resources/beta/task-run.d.ts.map +1 -1
  38. package/resources/shared.d.mts +7 -1
  39. package/resources/shared.d.mts.map +1 -1
  40. package/resources/shared.d.ts +7 -1
  41. package/resources/shared.d.ts.map +1 -1
  42. package/resources/task-run.d.mts +4 -2
  43. package/resources/task-run.d.mts.map +1 -1
  44. package/resources/task-run.d.ts +4 -2
  45. package/resources/task-run.d.ts.map +1 -1
  46. package/src/client.ts +1 -1
  47. package/src/resources/beta/beta.ts +56 -50
  48. package/src/resources/beta/findall.ts +172 -522
  49. package/src/resources/beta/index.ts +23 -2
  50. package/src/resources/beta/task-group.ts +3 -3
  51. package/src/resources/beta/task-run.ts +13 -8
  52. package/src/resources/shared.ts +8 -1
  53. package/src/resources/task-run.ts +4 -2
  54. package/src/version.ts +1 -1
  55. package/version.d.mts +1 -1
  56. package/version.d.ts +1 -1
  57. package/version.js +1 -1
  58. package/version.mjs +1 -1
@@ -4,7 +4,7 @@ import * as BetaTaskRunAPI from "./task-run.mjs";
4
4
  import { APIPromise } from "../../core/api-promise.mjs";
5
5
  import { Stream } from "../../core/streaming.mjs";
6
6
  import { RequestOptions } from "../../internal/request-options.mjs";
7
- export declare class Findall extends APIResource {
7
+ export declare class FindAll extends APIResource {
8
8
  /**
9
9
  * Starts a FindAll run.
10
10
  *
@@ -19,19 +19,19 @@ export declare class Findall extends APIResource {
19
19
  * - Or specifying a webhook with relevant event types during run creation to
20
20
  * receive notifications.
21
21
  */
22
- create(params: FindallCreateParams, options?: RequestOptions): APIPromise<FindallRun>;
22
+ create(params: FindAllCreateParams, options?: RequestOptions): APIPromise<FindAllRun>;
23
23
  /**
24
24
  * Retrieve a FindAll run.
25
25
  */
26
- retrieve(findallID: string, params?: FindallRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<FindallRetrieveResponse>;
26
+ retrieve(findallID: string, params?: FindAllRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<FindAllRun>;
27
27
  /**
28
28
  * Cancel a FindAll run.
29
29
  */
30
- cancel(findallID: string, params?: FindallCancelParams | null | undefined, options?: RequestOptions): APIPromise<unknown>;
30
+ cancel(findallID: string, params?: FindAllCancelParams | null | undefined, options?: RequestOptions): APIPromise<unknown>;
31
31
  /**
32
32
  * Add an enrichment to a FindAll run.
33
33
  */
34
- enrich(findallID: string, params: FindallEnrichParams, options?: RequestOptions): APIPromise<FindallSchema>;
34
+ enrich(findallID: string, params: FindAllEnrichParams, options?: RequestOptions): APIPromise<FindAllSchema>;
35
35
  /**
36
36
  * Stream events from a FindAll run.
37
37
  *
@@ -40,11 +40,11 @@ export declare class Findall extends APIResource {
40
40
  * keep connection alive as long as the run is going. If set, stop after specified
41
41
  * duration.
42
42
  */
43
- events(findallID: string, params?: FindallEventsParams | undefined, options?: RequestOptions): APIPromise<Stream<FindallEventsResponse>>;
43
+ events(findallID: string, params?: FindAllEventsParams | undefined, options?: RequestOptions): APIPromise<Stream<FindAllEventsResponse>>;
44
44
  /**
45
45
  * Extend a FindAll run by adding additional matches to the current match limit.
46
46
  */
47
- extend(findallID: string, params: FindallExtendParams, options?: RequestOptions): APIPromise<FindallSchema>;
47
+ extend(findallID: string, params: FindAllExtendParams, options?: RequestOptions): APIPromise<FindAllSchema>;
48
48
  /**
49
49
  * Transforms a natural language search objective into a structured FindAll spec.
50
50
  *
@@ -53,27 +53,24 @@ export declare class Findall extends APIResource {
53
53
  * The generated specification serves as a suggested starting point and can be
54
54
  * further customized by the user.
55
55
  */
56
- ingest(params: FindallIngestParams, options?: RequestOptions): APIPromise<FindallSchema>;
56
+ ingest(params: FindAllIngestParams, options?: RequestOptions): APIPromise<FindAllSchema>;
57
57
  /**
58
58
  * Retrieve the FindAll run result at the time of the request.
59
59
  */
60
- result(findallID: string, params?: FindallResultParams | null | undefined, options?: RequestOptions): APIPromise<FindallRunResult>;
60
+ result(findallID: string, params?: FindAllResultParams | null | undefined, options?: RequestOptions): APIPromise<FindAllRunResult>;
61
61
  /**
62
62
  * Get FindAll Run Schema
63
63
  */
64
- schema(findallID: string, params?: FindallSchemaParams | null | undefined, options?: RequestOptions): APIPromise<FindallSchema>;
64
+ schema(findallID: string, params?: FindAllSchemaParams | null | undefined, options?: RequestOptions): APIPromise<FindAllSchema>;
65
65
  }
66
66
  /**
67
67
  * Event containing a candidate whose match status has changed.
68
68
  */
69
- export interface FindallCandidateMatchStatusEvent {
69
+ export interface FindAllCandidateMatchStatusEvent {
70
70
  /**
71
- * Candidate for a find all run that may end up as a match.
72
- *
73
- * Contains all the candidate's metadata and the output of the match conditions. A
74
- * candidate is a match if all match conditions are satisfied.
71
+ * The candidate whose match status has been updated.
75
72
  */
76
- data: FindallCandidateMatchStatusEvent.Data;
73
+ data: FindAllCandidateMatchStatusEvent.Data;
77
74
  /**
78
75
  * Unique event identifier for the event.
79
76
  */
@@ -89,12 +86,9 @@ export interface FindallCandidateMatchStatusEvent {
89
86
  */
90
87
  type: 'findall.candidate.generated' | 'findall.candidate.matched' | 'findall.candidate.unmatched' | 'findall.candidate.discarded' | 'findall.candidate.enriched';
91
88
  }
92
- export declare namespace FindallCandidateMatchStatusEvent {
89
+ export declare namespace FindAllCandidateMatchStatusEvent {
93
90
  /**
94
- * Candidate for a find all run that may end up as a match.
95
- *
96
- * Contains all the candidate's metadata and the output of the match conditions. A
97
- * candidate is a match if all match conditions are satisfied.
91
+ * The candidate whose match status has been updated.
98
92
  */
99
93
  interface Data {
100
94
  /**
@@ -135,9 +129,9 @@ export declare namespace FindallCandidateMatchStatusEvent {
135
129
  /**
136
130
  * Input model for FindAll enrich.
137
131
  */
138
- export interface FindallEnrichInput {
132
+ export interface FindAllEnrichInput {
139
133
  /**
140
- * JSON schema for a task input or output.
134
+ * JSON schema for the enrichment output schema for the FindAll run.
141
135
  */
142
136
  output_schema: TaskRunAPI.JsonSchema;
143
137
  /**
@@ -152,7 +146,7 @@ export interface FindallEnrichInput {
152
146
  /**
153
147
  * Input model for FindAll extend.
154
148
  */
155
- export interface FindallExtendInput {
149
+ export interface FindAllExtendInput {
156
150
  /**
157
151
  * Additional number of matches to find for this FindAll run. This value will be
158
152
  * added to the current match limit to determine the new total match limit. Must be
@@ -163,7 +157,7 @@ export interface FindallExtendInput {
163
157
  /**
164
158
  * FindAll run object with status and metadata.
165
159
  */
166
- export interface FindallRun {
160
+ export interface FindAllRun {
167
161
  /**
168
162
  * ID of the FindAll run.
169
163
  */
@@ -173,9 +167,9 @@ export interface FindallRun {
173
167
  */
174
168
  generator: 'base' | 'core' | 'pro' | 'preview';
175
169
  /**
176
- * Status object for FindAll run.
170
+ * Status object for the FindAll run.
177
171
  */
178
- status: FindallRun.Status;
172
+ status: FindAllRun.Status;
179
173
  /**
180
174
  * Timestamp of the creation of the run, in RFC 3339 format.
181
175
  */
@@ -192,9 +186,9 @@ export interface FindallRun {
192
186
  */
193
187
  modified_at?: string | null;
194
188
  }
195
- export declare namespace FindallRun {
189
+ export declare namespace FindAllRun {
196
190
  /**
197
- * Status object for FindAll run.
191
+ * Status object for the FindAll run.
198
192
  */
199
193
  interface Status {
200
194
  /**
@@ -202,7 +196,7 @@ export declare namespace FindallRun {
202
196
  */
203
197
  is_active: boolean;
204
198
  /**
205
- * Metrics object for FindAll run.
199
+ * Candidate metrics for the FindAll run.
206
200
  */
207
201
  metrics: Status.Metrics;
208
202
  /**
@@ -212,11 +206,11 @@ export declare namespace FindallRun {
212
206
  /**
213
207
  * Reason for termination when FindAll run is in terminal status.
214
208
  */
215
- termination_reason?: string | null;
209
+ termination_reason?: 'low_match_rate' | 'match_limit_met' | 'candidates_exhausted' | 'user_cancelled' | 'error_occurred' | 'timeout' | null;
216
210
  }
217
211
  namespace Status {
218
212
  /**
219
- * Metrics object for FindAll run.
213
+ * Candidate metrics for the FindAll run.
220
214
  */
221
215
  interface Metrics {
222
216
  /**
@@ -233,21 +227,22 @@ export declare namespace FindallRun {
233
227
  /**
234
228
  * Input model for FindAll run.
235
229
  */
236
- export interface FindallRunInput {
230
+ export interface FindAllRunInput {
237
231
  /**
238
232
  * Type of the entity for the FindAll run.
239
233
  */
240
234
  entity_type: string;
241
235
  /**
242
- * Generator for the FindAll run.
236
+ * Generator for the FindAll run. One of base, core, pro, preview.
243
237
  */
244
238
  generator: 'base' | 'core' | 'pro' | 'preview';
245
239
  /**
246
240
  * List of match conditions for the FindAll run.
247
241
  */
248
- match_conditions: Array<FindallRunInput.MatchCondition>;
242
+ match_conditions: Array<FindAllRunInput.MatchCondition>;
249
243
  /**
250
- * Maximum number of matches to find for this FindAll run.
244
+ * Maximum number of matches to find for this FindAll run. Must be between 5 and
245
+ * 1000 (inclusive).
251
246
  */
252
247
  match_limit: number;
253
248
  /**
@@ -257,7 +252,7 @@ export interface FindallRunInput {
257
252
  /**
258
253
  * List of entity names/IDs to exclude from results.
259
254
  */
260
- exclude_list?: Array<FindallRunInput.ExcludeList> | null;
255
+ exclude_list?: Array<FindAllRunInput.ExcludeList> | null;
261
256
  /**
262
257
  * Metadata for the FindAll run.
263
258
  */
@@ -269,7 +264,7 @@ export interface FindallRunInput {
269
264
  */
270
265
  webhook?: BetaTaskRunAPI.Webhook | null;
271
266
  }
272
- export declare namespace FindallRunInput {
267
+ export declare namespace FindAllRunInput {
273
268
  /**
274
269
  * Match condition model for FindAll ingest.
275
270
  */
@@ -306,22 +301,22 @@ export declare namespace FindallRunInput {
306
301
  * candidate entities with their match status and details at the time the snapshot
307
302
  * was taken.
308
303
  */
309
- export interface FindallRunResult {
304
+ export interface FindAllRunResult {
310
305
  /**
311
306
  * All evaluated candidates at the time of the snapshot.
312
307
  */
313
- candidates: Array<FindallRunResult.Candidate>;
308
+ candidates: Array<FindAllRunResult.Candidate>;
314
309
  /**
315
- * FindAll run object with status and metadata.
310
+ * FindAll run object.
316
311
  */
317
- run: FindallRun;
312
+ run: FindAllRun;
318
313
  /**
319
314
  * ID of the last event of the run at the time of the request. This can be used to
320
315
  * resume streaming from the last event.
321
316
  */
322
317
  last_event_id?: string | null;
323
318
  }
324
- export declare namespace FindallRunResult {
319
+ export declare namespace FindAllRunResult {
325
320
  /**
326
321
  * Candidate for a find all run that may end up as a match.
327
322
  *
@@ -367,11 +362,11 @@ export declare namespace FindallRunResult {
367
362
  /**
368
363
  * Event containing status update for FindAll run.
369
364
  */
370
- export interface FindallRunStatusEvent {
365
+ export interface FindAllRunStatusEvent {
371
366
  /**
372
- * FindAll run object with status and metadata.
367
+ * Updated FindAll run information.
373
368
  */
374
- data: FindallRun;
369
+ data: FindAllRun;
375
370
  /**
376
371
  * Unique event identifier for the event.
377
372
  */
@@ -388,7 +383,7 @@ export interface FindallRunStatusEvent {
388
383
  /**
389
384
  * Response model for FindAll ingest.
390
385
  */
391
- export interface FindallSchema {
386
+ export interface FindAllSchema {
392
387
  /**
393
388
  * Type of the entity for the FindAll run.
394
389
  */
@@ -396,7 +391,7 @@ export interface FindallSchema {
396
391
  /**
397
392
  * List of match conditions for the FindAll run.
398
393
  */
399
- match_conditions: Array<FindallSchema.MatchCondition>;
394
+ match_conditions: Array<FindAllSchema.MatchCondition>;
400
395
  /**
401
396
  * Natural language objective of the FindAll run.
402
397
  */
@@ -404,7 +399,7 @@ export interface FindallSchema {
404
399
  /**
405
400
  * List of enrichment inputs for the FindAll run.
406
401
  */
407
- enrichments?: Array<FindallEnrichInput> | null;
402
+ enrichments?: Array<FindAllEnrichInput> | null;
408
403
  /**
409
404
  * The generator of the FindAll run.
410
405
  */
@@ -414,7 +409,7 @@ export interface FindallSchema {
414
409
  */
415
410
  match_limit?: number | null;
416
411
  }
417
- export declare namespace FindallSchema {
412
+ export declare namespace FindAllSchema {
418
413
  /**
419
414
  * Match condition model for FindAll ingest.
420
415
  */
@@ -434,11 +429,11 @@ export declare namespace FindallSchema {
434
429
  /**
435
430
  * Event containing full snapshot of FindAll run state.
436
431
  */
437
- export interface FindallSchemaUpdatedEvent {
432
+ export interface FindAllSchemaUpdatedEvent {
438
433
  /**
439
- * Response model for FindAll ingest.
434
+ * Updated FindAll schema.
440
435
  */
441
- data: FindallSchema;
436
+ data: FindAllSchema;
442
437
  /**
443
438
  * Unique event identifier for the event.
444
439
  */
@@ -461,385 +456,27 @@ export interface IngestInput {
461
456
  */
462
457
  objective: string;
463
458
  }
464
- /**
465
- * FindAll run object with status and metadata.
466
- */
467
- export type FindallRetrieveResponse = FindallRun | FindallRetrieveResponse.FindAllPollResponse;
468
- export declare namespace FindallRetrieveResponse {
469
- /**
470
- * Response format for polling a FindAll run status.
471
- */
472
- interface FindAllPollResponse {
473
- /**
474
- * Billing metrics for the run.
475
- */
476
- billing_metrics: FindAllPollResponse.BillingMetrics;
477
- /**
478
- * List of candidates being processed
479
- */
480
- candidates: Array<FindAllPollResponse.Candidate>;
481
- /**
482
- * List of enrichments derived from the query
483
- */
484
- enrichments: Array<FindAllPollResponse.Enrichment>;
485
- /**
486
- * List of filters derived from the query
487
- */
488
- filters: Array<FindAllPollResponse.Filter>;
489
- /**
490
- * True if the run is still processing candidates
491
- */
492
- is_active: boolean;
493
- /**
494
- * Max results processed for the run
495
- */
496
- max_results: number;
497
- /**
498
- * Query for the run
499
- */
500
- query: string;
501
- /**
502
- * List of entities which are fully processed
503
- */
504
- results: Array<FindAllPollResponse.Result>;
505
- /**
506
- * View model for the run.
507
- */
508
- spec: FindAllPollResponse.Spec;
509
- /**
510
- * Derived overall status (e.g., 'running', 'completed', 'failed')
511
- */
512
- status: string;
513
- /**
514
- * List of processing steps undertaken with their status
515
- */
516
- steps: Array<FindAllPollResponse.Step>;
517
- /**
518
- * Title of the run
519
- */
520
- title: string;
521
- /**
522
- * True if enrichments are still being processed
523
- */
524
- are_enrichments_active?: boolean;
525
- /**
526
- * Timestamp of the request
527
- */
528
- created_at?: string | null;
529
- /**
530
- * List of recommended enrichments that could be added
531
- */
532
- enrichment_recommendations?: Array<FindAllPollResponse.EnrichmentRecommendation>;
533
- /**
534
- * Timestamp of the last status update
535
- */
536
- modified_at?: string | null;
537
- /**
538
- * Number of web pages considered for this entity
539
- */
540
- pages_considered?: number | null;
541
- /**
542
- * Number of web pages read for this entity
543
- */
544
- pages_read?: number | null;
545
- }
546
- namespace FindAllPollResponse {
547
- /**
548
- * Billing metrics for the run.
549
- */
550
- interface BillingMetrics {
551
- /**
552
- * Number of enrichment cells processed
553
- */
554
- enrichment_cells: number;
555
- /**
556
- * Number of rows processed
557
- */
558
- rows_processed: number;
559
- cost_mode?: 'lite' | 'base' | 'pro' | 'preview';
560
- }
561
- /**
562
- * Simplified entity model for candidates.
563
- */
564
- interface Candidate {
565
- /**
566
- * Unique entity identifier
567
- */
568
- entity_id: string;
569
- /**
570
- * Entity name
571
- */
572
- name: string;
573
- }
574
- /**
575
- * Column model for filters and enrichments.
576
- */
577
- interface Enrichment {
578
- /**
579
- * Human-readable description of the column
580
- */
581
- description: string;
582
- /**
583
- * Column identifier
584
- */
585
- name: string;
586
- /**
587
- * Column type ('enrichment' or 'filter')
588
- */
589
- type: string;
590
- /**
591
- * Status of the column ('running', 'done', 'failed')
592
- */
593
- status?: string | null;
594
- }
595
- /**
596
- * Column model for filters and enrichments.
597
- */
598
- interface Filter {
599
- /**
600
- * Human-readable description of the column
601
- */
602
- description: string;
603
- /**
604
- * Column identifier
605
- */
606
- name: string;
607
- /**
608
- * Column type ('enrichment' or 'filter')
609
- */
610
- type: string;
611
- /**
612
- * Status of the column ('running', 'done', 'failed')
613
- */
614
- status?: string | null;
615
- }
616
- /**
617
- * Entity model for results and candidates.
618
- */
619
- interface Result {
620
- /**
621
- * Unique entity identifier
622
- */
623
- entity_id: string;
624
- /**
625
- * Entity name
626
- */
627
- name: string;
628
- /**
629
- * Entity description if available
630
- */
631
- description?: string | null;
632
- /**
633
- * List of enrichment results
634
- */
635
- enrichment_results?: Array<Result.EnrichmentResult>;
636
- /**
637
- * List of filter results
638
- */
639
- filter_results?: Array<Result.FilterResult>;
640
- /**
641
- * Confidence score (positive real number)
642
- */
643
- score?: number | null;
644
- /**
645
- * Entity URL if available
646
- */
647
- url?: string | null;
648
- }
649
- namespace Result {
650
- /**
651
- * Result model for filter and enrichment results.
652
- */
653
- interface EnrichmentResult {
654
- /**
655
- * Name of column
656
- */
657
- key: string;
658
- /**
659
- * Result of column
660
- */
661
- value: string;
662
- /**
663
- * Space separated list of citation urls
664
- */
665
- citations?: string | null;
666
- /**
667
- * Confidence score (e.g. 'high', 'medium', 'low')
668
- */
669
- confidence?: string | null;
670
- /**
671
- * List of enhanced citations with title and excerpts
672
- */
673
- enhanced_citations?: Array<EnrichmentResult.EnhancedCitation>;
674
- /**
675
- * Reasoning behind the value
676
- */
677
- reasoning?: string | null;
678
- }
679
- namespace EnrichmentResult {
680
- /**
681
- * Enhanced citation model with title, excerpts, and URL for UI.
682
- */
683
- interface EnhancedCitation {
684
- /**
685
- * Citation URL
686
- */
687
- url: string;
688
- /**
689
- * List of relevant excerpts from the cited page
690
- */
691
- excerpts?: Array<string>;
692
- /**
693
- * Title of the cited page
694
- */
695
- title?: string | null;
696
- }
697
- }
698
- /**
699
- * Result model for filter and enrichment results.
700
- */
701
- interface FilterResult {
702
- /**
703
- * Name of column
704
- */
705
- key: string;
706
- /**
707
- * Result of column
708
- */
709
- value: string;
710
- /**
711
- * Space separated list of citation urls
712
- */
713
- citations?: string | null;
714
- /**
715
- * Confidence score (e.g. 'high', 'medium', 'low')
716
- */
717
- confidence?: string | null;
718
- /**
719
- * List of enhanced citations with title and excerpts
720
- */
721
- enhanced_citations?: Array<FilterResult.EnhancedCitation>;
722
- /**
723
- * Reasoning behind the value
724
- */
725
- reasoning?: string | null;
726
- }
727
- namespace FilterResult {
728
- /**
729
- * Enhanced citation model with title, excerpts, and URL for UI.
730
- */
731
- interface EnhancedCitation {
732
- /**
733
- * Citation URL
734
- */
735
- url: string;
736
- /**
737
- * List of relevant excerpts from the cited page
738
- */
739
- excerpts?: Array<string>;
740
- /**
741
- * Title of the cited page
742
- */
743
- title?: string | null;
744
- }
745
- }
746
- }
747
- /**
748
- * View model for the run.
749
- */
750
- interface Spec {
751
- /**
752
- * List of columns in the view
753
- */
754
- columns: Array<Spec.Column>;
755
- /**
756
- * Name of the view
757
- */
758
- name: string;
759
- }
760
- namespace Spec {
761
- /**
762
- * Column model for filters and enrichments.
763
- */
764
- interface Column {
765
- /**
766
- * Human-readable description of the column
767
- */
768
- description: string;
769
- /**
770
- * Column identifier
771
- */
772
- name: string;
773
- /**
774
- * Column type ('enrichment' or 'filter')
775
- */
776
- type: string;
777
- /**
778
- * Status of the column ('running', 'done', 'failed')
779
- */
780
- status?: string | null;
781
- }
782
- }
783
- /**
784
- * Step model for tracking progress of FindAll operations.
785
- */
786
- interface Step {
787
- /**
788
- * Human-readable description of the step
789
- */
790
- description: string;
791
- /**
792
- * Step identifier
793
- */
794
- name: string;
795
- /**
796
- * Current status of the step
797
- */
798
- status: string;
799
- }
800
- /**
801
- * Enrichment recommendation model.
802
- */
803
- interface EnrichmentRecommendation {
804
- /**
805
- * Recommended column name
806
- */
807
- column_name: string;
808
- /**
809
- * Description of the recommended enrichment
810
- */
811
- description: string;
812
- /**
813
- * Run ID that generated this recommendation
814
- */
815
- recommendation_run_id: string;
816
- /**
817
- * Task ID that generated this recommendation
818
- */
819
- recommendation_task_id: string;
820
- }
821
- }
822
- }
823
- export type FindallCancelResponse = unknown;
459
+ export type FindAllCancelResponse = unknown;
824
460
  /**
825
461
  * Event containing full snapshot of FindAll run state.
826
462
  */
827
- export type FindallEventsResponse = FindallSchemaUpdatedEvent | FindallRunStatusEvent | FindallCandidateMatchStatusEvent | BetaTaskRunAPI.ErrorEvent;
828
- export interface FindallCreateParams {
463
+ export type FindAllEventsResponse = FindAllSchemaUpdatedEvent | FindAllRunStatusEvent | FindAllCandidateMatchStatusEvent | BetaTaskRunAPI.ErrorEvent;
464
+ export interface FindAllCreateParams {
829
465
  /**
830
466
  * Body param: Type of the entity for the FindAll run.
831
467
  */
832
468
  entity_type: string;
833
469
  /**
834
- * Body param: Generator for the FindAll run.
470
+ * Body param: Generator for the FindAll run. One of base, core, pro, preview.
835
471
  */
836
472
  generator: 'base' | 'core' | 'pro' | 'preview';
837
473
  /**
838
474
  * Body param: List of match conditions for the FindAll run.
839
475
  */
840
- match_conditions: Array<FindallCreateParams.MatchCondition>;
476
+ match_conditions: Array<FindAllCreateParams.MatchCondition>;
841
477
  /**
842
- * Body param: Maximum number of matches to find for this FindAll run.
478
+ * Body param: Maximum number of matches to find for this FindAll run. Must be
479
+ * between 5 and 1000 (inclusive).
843
480
  */
844
481
  match_limit: number;
845
482
  /**
@@ -849,7 +486,7 @@ export interface FindallCreateParams {
849
486
  /**
850
487
  * Body param: List of entity names/IDs to exclude from results.
851
488
  */
852
- exclude_list?: Array<FindallCreateParams.ExcludeList> | null;
489
+ exclude_list?: Array<FindAllCreateParams.ExcludeList> | null;
853
490
  /**
854
491
  * Body param: Metadata for the FindAll run.
855
492
  */
@@ -865,7 +502,7 @@ export interface FindallCreateParams {
865
502
  */
866
503
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
867
504
  }
868
- export declare namespace FindallCreateParams {
505
+ export declare namespace FindAllCreateParams {
869
506
  /**
870
507
  * Match condition model for FindAll ingest.
871
508
  */
@@ -895,21 +532,21 @@ export declare namespace FindallCreateParams {
895
532
  url: string;
896
533
  }
897
534
  }
898
- export interface FindallRetrieveParams {
535
+ export interface FindAllRetrieveParams {
899
536
  /**
900
537
  * Optional header to specify the beta version(s) to enable.
901
538
  */
902
539
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
903
540
  }
904
- export interface FindallCancelParams {
541
+ export interface FindAllCancelParams {
905
542
  /**
906
543
  * Optional header to specify the beta version(s) to enable.
907
544
  */
908
545
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
909
546
  }
910
- export interface FindallEnrichParams {
547
+ export interface FindAllEnrichParams {
911
548
  /**
912
- * Body param: JSON schema for a task input or output.
549
+ * Body param: JSON schema for the enrichment output schema for the FindAll run.
913
550
  */
914
551
  output_schema: TaskRunAPI.JsonSchema;
915
552
  /**
@@ -925,13 +562,13 @@ export interface FindallEnrichParams {
925
562
  */
926
563
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
927
564
  }
928
- export interface FindallEventsParams {
565
+ export interface FindAllEventsParams {
929
566
  /**
930
- * Query param:
567
+ * Query param
931
568
  */
932
569
  last_event_id?: string | null;
933
570
  /**
934
- * Query param:
571
+ * Query param
935
572
  */
936
573
  timeout?: number | null;
937
574
  /**
@@ -939,7 +576,7 @@ export interface FindallEventsParams {
939
576
  */
940
577
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
941
578
  }
942
- export interface FindallExtendParams {
579
+ export interface FindAllExtendParams {
943
580
  /**
944
581
  * Body param: Additional number of matches to find for this FindAll run. This
945
582
  * value will be added to the current match limit to determine the new total match
@@ -951,7 +588,7 @@ export interface FindallExtendParams {
951
588
  */
952
589
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
953
590
  }
954
- export interface FindallIngestParams {
591
+ export interface FindAllIngestParams {
955
592
  /**
956
593
  * Body param: Natural language objective to create a FindAll run spec.
957
594
  */
@@ -961,19 +598,72 @@ export interface FindallIngestParams {
961
598
  */
962
599
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
963
600
  }
964
- export interface FindallResultParams {
601
+ export interface FindAllResultParams {
965
602
  /**
966
603
  * Optional header to specify the beta version(s) to enable.
967
604
  */
968
605
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
969
606
  }
970
- export interface FindallSchemaParams {
607
+ export interface FindAllSchemaParams {
971
608
  /**
972
609
  * Optional header to specify the beta version(s) to enable.
973
610
  */
974
611
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
975
612
  }
613
+ export declare namespace FindAll {
614
+ export { type FindAllCandidateMatchStatusEvent as FindAllCandidateMatchStatusEvent, type FindAllEnrichInput as FindAllEnrichInput, type FindAllExtendInput as FindAllExtendInput, type FindAllRun as FindAllRun, type FindAllRunInput as FindAllRunInput, type FindAllRunResult as FindAllRunResult, type FindAllRunStatusEvent as FindAllRunStatusEvent, type FindAllSchema as FindAllSchema, type FindAllSchemaUpdatedEvent as FindAllSchemaUpdatedEvent, type IngestInput as IngestInput, type FindAllCancelResponse as FindAllCancelResponse, type FindAllEventsResponse as FindAllEventsResponse, type FindAllCreateParams as FindAllCreateParams, type FindAllRetrieveParams as FindAllRetrieveParams, type FindAllCancelParams as FindAllCancelParams, type FindAllEnrichParams as FindAllEnrichParams, type FindAllEventsParams as FindAllEventsParams, type FindAllExtendParams as FindAllExtendParams, type FindAllIngestParams as FindAllIngestParams, type FindAllResultParams as FindAllResultParams, type FindAllSchemaParams as FindAllSchemaParams, };
615
+ }
616
+ /**
617
+ * Backwards-compatible aliases (deprecated).
618
+ *
619
+ * Historically these types/resources were exported as `Findall*` (lowercase "a").
620
+ * The canonical names are now `FindAll*`.
621
+ */
622
+ export declare class Findall extends FindAll {
623
+ }
624
+ /** @deprecated Use `FindAllCandidateMatchStatusEvent` instead. */
625
+ export type FindallCandidateMatchStatusEvent = FindAllCandidateMatchStatusEvent;
626
+ /** @deprecated Use `FindAllEnrichInput` instead. */
627
+ export type FindallEnrichInput = FindAllEnrichInput;
628
+ /** @deprecated Use `FindAllExtendInput` instead. */
629
+ export type FindallExtendInput = FindAllExtendInput;
630
+ /** @deprecated Use `FindAllRun` instead. */
631
+ export type FindallRun = FindAllRun;
632
+ /** @deprecated Use `FindAllRunInput` instead. */
633
+ export type FindallRunInput = FindAllRunInput;
634
+ /** @deprecated Use `FindAllRunResult` instead. */
635
+ export type FindallRunResult = FindAllRunResult;
636
+ /** @deprecated Use `FindAllRunStatusEvent` instead. */
637
+ export type FindallRunStatusEvent = FindAllRunStatusEvent;
638
+ /** @deprecated Use `FindAllSchema` instead. */
639
+ export type FindallSchema = FindAllSchema;
640
+ /** @deprecated Use `FindAllSchemaUpdatedEvent` instead. */
641
+ export type FindallSchemaUpdatedEvent = FindAllSchemaUpdatedEvent;
642
+ /** @deprecated Use `IngestInput` instead. */
643
+ export type FindallIngestInput = IngestInput;
644
+ /** @deprecated Use `FindAllCancelResponse` instead. */
645
+ export type FindallCancelResponse = FindAllCancelResponse;
646
+ /** @deprecated Use `FindAllEventsResponse` instead. */
647
+ export type FindallEventsResponse = FindAllEventsResponse;
648
+ /** @deprecated Use `FindAllCreateParams` instead. */
649
+ export type FindallCreateParams = FindAllCreateParams;
650
+ /** @deprecated Use `FindAllRetrieveParams` instead. */
651
+ export type FindallRetrieveParams = FindAllRetrieveParams;
652
+ /** @deprecated Use `FindAllCancelParams` instead. */
653
+ export type FindallCancelParams = FindAllCancelParams;
654
+ /** @deprecated Use `FindAllEnrichParams` instead. */
655
+ export type FindallEnrichParams = FindAllEnrichParams;
656
+ /** @deprecated Use `FindAllEventsParams` instead. */
657
+ export type FindallEventsParams = FindAllEventsParams;
658
+ /** @deprecated Use `FindAllExtendParams` instead. */
659
+ export type FindallExtendParams = FindAllExtendParams;
660
+ /** @deprecated Use `FindAllIngestParams` instead. */
661
+ export type FindallIngestParams = FindAllIngestParams;
662
+ /** @deprecated Use `FindAllResultParams` instead. */
663
+ export type FindallResultParams = FindAllResultParams;
664
+ /** @deprecated Use `FindAllSchemaParams` instead. */
665
+ export type FindallSchemaParams = FindAllSchemaParams;
976
666
  export declare namespace Findall {
977
- export { type FindallCandidateMatchStatusEvent as FindallCandidateMatchStatusEvent, type FindallEnrichInput as FindallEnrichInput, type FindallExtendInput as FindallExtendInput, type FindallRun as FindallRun, type FindallRunInput as FindallRunInput, type FindallRunResult as FindallRunResult, type FindallRunStatusEvent as FindallRunStatusEvent, type FindallSchema as FindallSchema, type FindallSchemaUpdatedEvent as FindallSchemaUpdatedEvent, type IngestInput as IngestInput, type FindallRetrieveResponse as FindallRetrieveResponse, type FindallCancelResponse as FindallCancelResponse, type FindallEventsResponse as FindallEventsResponse, type FindallCreateParams as FindallCreateParams, type FindallRetrieveParams as FindallRetrieveParams, type FindallCancelParams as FindallCancelParams, type FindallEnrichParams as FindallEnrichParams, type FindallEventsParams as FindallEventsParams, type FindallExtendParams as FindallExtendParams, type FindallIngestParams as FindallIngestParams, type FindallResultParams as FindallResultParams, type FindallSchemaParams as FindallSchemaParams, };
667
+ export { type FindallCandidateMatchStatusEvent as FindallCandidateMatchStatusEvent, type FindallEnrichInput as FindallEnrichInput, type FindallExtendInput as FindallExtendInput, type FindallRun as FindallRun, type FindallRunInput as FindallRunInput, type FindallRunResult as FindallRunResult, type FindallRunStatusEvent as FindallRunStatusEvent, type FindallSchema as FindallSchema, type FindallSchemaUpdatedEvent as FindallSchemaUpdatedEvent, type FindallIngestInput as FindallIngestInput, type FindallCancelResponse as FindallCancelResponse, type FindallEventsResponse as FindallEventsResponse, type FindallCreateParams as FindallCreateParams, type FindallRetrieveParams as FindallRetrieveParams, type FindallCancelParams as FindallCancelParams, type FindallEnrichParams as FindallEnrichParams, type FindallEventsParams as FindallEventsParams, type FindallExtendParams as FindallExtendParams, type FindallIngestParams as FindallIngestParams, type FindallResultParams as FindallResultParams, type FindallSchemaParams as FindallSchemaParams, };
978
668
  }
979
669
  //# sourceMappingURL=findall.d.mts.map