parallel-web 0.2.4 → 0.3.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.
Files changed (58) hide show
  1. package/CHANGELOG.md +29 -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 +17 -10
  9. package/resources/beta/beta.d.mts.map +1 -1
  10. package/resources/beta/beta.d.ts +17 -10
  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 +120 -430
  17. package/resources/beta/findall.d.mts.map +1 -1
  18. package/resources/beta/findall.d.ts +120 -430
  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 +12 -8
  35. package/resources/beta/task-run.d.mts.map +1 -1
  36. package/resources/beta/task-run.d.ts +12 -8
  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 +60 -54
  48. package/src/resources/beta/findall.ts +170 -520
  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 +12 -7
  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
@@ -9,7 +9,7 @@ import { buildHeaders } from '../../internal/headers';
9
9
  import { RequestOptions } from '../../internal/request-options';
10
10
  import { path } from '../../internal/utils/path';
11
11
 
12
- export class Findall extends APIResource {
12
+ export class FindAll extends APIResource {
13
13
  /**
14
14
  * Starts a FindAll run.
15
15
  *
@@ -24,13 +24,13 @@ export class Findall extends APIResource {
24
24
  * - Or specifying a webhook with relevant event types during run creation to
25
25
  * receive notifications.
26
26
  */
27
- create(params: FindallCreateParams, options?: RequestOptions): APIPromise<FindallRun> {
27
+ create(params: FindAllCreateParams, options?: RequestOptions): APIPromise<FindAllRun> {
28
28
  const { betas, ...body } = params;
29
29
  return this._client.post('/v1beta/findall/runs', {
30
30
  body,
31
31
  ...options,
32
32
  headers: buildHeaders([
33
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-02-01'].toString() },
33
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString() },
34
34
  options?.headers,
35
35
  ]),
36
36
  });
@@ -41,14 +41,14 @@ export class Findall extends APIResource {
41
41
  */
42
42
  retrieve(
43
43
  findallID: string,
44
- params: FindallRetrieveParams | null | undefined = {},
44
+ params: FindAllRetrieveParams | null | undefined = {},
45
45
  options?: RequestOptions,
46
- ): APIPromise<FindallRetrieveResponse> {
46
+ ): APIPromise<FindAllRun> {
47
47
  const { betas } = params ?? {};
48
48
  return this._client.get(path`/v1beta/findall/runs/${findallID}`, {
49
49
  ...options,
50
50
  headers: buildHeaders([
51
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-02-01'].toString() },
51
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString() },
52
52
  options?.headers,
53
53
  ]),
54
54
  });
@@ -59,14 +59,14 @@ export class Findall extends APIResource {
59
59
  */
60
60
  cancel(
61
61
  findallID: string,
62
- params: FindallCancelParams | null | undefined = {},
62
+ params: FindAllCancelParams | null | undefined = {},
63
63
  options?: RequestOptions,
64
64
  ): APIPromise<unknown> {
65
65
  const { betas } = params ?? {};
66
66
  return this._client.post(path`/v1beta/findall/runs/${findallID}/cancel`, {
67
67
  ...options,
68
68
  headers: buildHeaders([
69
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-02-01'].toString() },
69
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString() },
70
70
  options?.headers,
71
71
  ]),
72
72
  });
@@ -77,15 +77,15 @@ export class Findall extends APIResource {
77
77
  */
78
78
  enrich(
79
79
  findallID: string,
80
- params: FindallEnrichParams,
80
+ params: FindAllEnrichParams,
81
81
  options?: RequestOptions,
82
- ): APIPromise<FindallSchema> {
82
+ ): APIPromise<FindAllSchema> {
83
83
  const { betas, ...body } = params;
84
84
  return this._client.post(path`/v1beta/findall/runs/${findallID}/enrich`, {
85
85
  body,
86
86
  ...options,
87
87
  headers: buildHeaders([
88
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-02-01'].toString() },
88
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString() },
89
89
  options?.headers,
90
90
  ]),
91
91
  });
@@ -101,19 +101,19 @@ export class Findall extends APIResource {
101
101
  */
102
102
  events(
103
103
  findallID: string,
104
- params: FindallEventsParams | undefined = {},
104
+ params: FindAllEventsParams | undefined = {},
105
105
  options?: RequestOptions,
106
- ): APIPromise<Stream<FindallEventsResponse>> {
106
+ ): APIPromise<Stream<FindAllEventsResponse>> {
107
107
  const { betas, ...query } = params ?? {};
108
108
  return this._client.get(path`/v1beta/findall/runs/${findallID}/events`, {
109
109
  query,
110
110
  ...options,
111
111
  headers: buildHeaders([
112
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-02-01'].toString(), Accept: 'text/event-stream' },
112
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString(), Accept: 'text/event-stream' },
113
113
  options?.headers,
114
114
  ]),
115
115
  stream: true,
116
- }) as APIPromise<Stream<FindallEventsResponse>>;
116
+ }) as APIPromise<Stream<FindAllEventsResponse>>;
117
117
  }
118
118
 
119
119
  /**
@@ -121,15 +121,15 @@ export class Findall extends APIResource {
121
121
  */
122
122
  extend(
123
123
  findallID: string,
124
- params: FindallExtendParams,
124
+ params: FindAllExtendParams,
125
125
  options?: RequestOptions,
126
- ): APIPromise<FindallSchema> {
126
+ ): APIPromise<FindAllSchema> {
127
127
  const { betas, ...body } = params;
128
128
  return this._client.post(path`/v1beta/findall/runs/${findallID}/extend`, {
129
129
  body,
130
130
  ...options,
131
131
  headers: buildHeaders([
132
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-02-01'].toString() },
132
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString() },
133
133
  options?.headers,
134
134
  ]),
135
135
  });
@@ -143,13 +143,13 @@ export class Findall extends APIResource {
143
143
  * The generated specification serves as a suggested starting point and can be
144
144
  * further customized by the user.
145
145
  */
146
- ingest(params: FindallIngestParams, options?: RequestOptions): APIPromise<FindallSchema> {
146
+ ingest(params: FindAllIngestParams, options?: RequestOptions): APIPromise<FindAllSchema> {
147
147
  const { betas, ...body } = params;
148
148
  return this._client.post('/v1beta/findall/ingest', {
149
149
  body,
150
150
  ...options,
151
151
  headers: buildHeaders([
152
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-02-01'].toString() },
152
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString() },
153
153
  options?.headers,
154
154
  ]),
155
155
  });
@@ -160,14 +160,14 @@ export class Findall extends APIResource {
160
160
  */
161
161
  result(
162
162
  findallID: string,
163
- params: FindallResultParams | null | undefined = {},
163
+ params: FindAllResultParams | null | undefined = {},
164
164
  options?: RequestOptions,
165
- ): APIPromise<FindallRunResult> {
165
+ ): APIPromise<FindAllRunResult> {
166
166
  const { betas } = params ?? {};
167
167
  return this._client.get(path`/v1beta/findall/runs/${findallID}/result`, {
168
168
  ...options,
169
169
  headers: buildHeaders([
170
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-02-01'].toString() },
170
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString() },
171
171
  options?.headers,
172
172
  ]),
173
173
  });
@@ -178,14 +178,14 @@ export class Findall extends APIResource {
178
178
  */
179
179
  schema(
180
180
  findallID: string,
181
- params: FindallSchemaParams | null | undefined = {},
181
+ params: FindAllSchemaParams | null | undefined = {},
182
182
  options?: RequestOptions,
183
- ): APIPromise<FindallSchema> {
183
+ ): APIPromise<FindAllSchema> {
184
184
  const { betas } = params ?? {};
185
185
  return this._client.get(path`/v1beta/findall/runs/${findallID}/schema`, {
186
186
  ...options,
187
187
  headers: buildHeaders([
188
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-02-01'].toString() },
188
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString() },
189
189
  options?.headers,
190
190
  ]),
191
191
  });
@@ -195,14 +195,11 @@ export class Findall extends APIResource {
195
195
  /**
196
196
  * Event containing a candidate whose match status has changed.
197
197
  */
198
- export interface FindallCandidateMatchStatusEvent {
198
+ export interface FindAllCandidateMatchStatusEvent {
199
199
  /**
200
- * Candidate for a find all run that may end up as a match.
201
- *
202
- * Contains all the candidate's metadata and the output of the match conditions. A
203
- * candidate is a match if all match conditions are satisfied.
200
+ * The candidate whose match status has been updated.
204
201
  */
205
- data: FindallCandidateMatchStatusEvent.Data;
202
+ data: FindAllCandidateMatchStatusEvent.Data;
206
203
 
207
204
  /**
208
205
  * Unique event identifier for the event.
@@ -227,12 +224,9 @@ export interface FindallCandidateMatchStatusEvent {
227
224
  | 'findall.candidate.enriched';
228
225
  }
229
226
 
230
- export namespace FindallCandidateMatchStatusEvent {
227
+ export namespace FindAllCandidateMatchStatusEvent {
231
228
  /**
232
- * Candidate for a find all run that may end up as a match.
233
- *
234
- * Contains all the candidate's metadata and the output of the match conditions. A
235
- * candidate is a match if all match conditions are satisfied.
229
+ * The candidate whose match status has been updated.
236
230
  */
237
231
  export interface Data {
238
232
  /**
@@ -278,9 +272,9 @@ export namespace FindallCandidateMatchStatusEvent {
278
272
  /**
279
273
  * Input model for FindAll enrich.
280
274
  */
281
- export interface FindallEnrichInput {
275
+ export interface FindAllEnrichInput {
282
276
  /**
283
- * JSON schema for a task input or output.
277
+ * JSON schema for the enrichment output schema for the FindAll run.
284
278
  */
285
279
  output_schema: TaskRunAPI.JsonSchema;
286
280
 
@@ -298,7 +292,7 @@ export interface FindallEnrichInput {
298
292
  /**
299
293
  * Input model for FindAll extend.
300
294
  */
301
- export interface FindallExtendInput {
295
+ export interface FindAllExtendInput {
302
296
  /**
303
297
  * Additional number of matches to find for this FindAll run. This value will be
304
298
  * added to the current match limit to determine the new total match limit. Must be
@@ -310,7 +304,7 @@ export interface FindallExtendInput {
310
304
  /**
311
305
  * FindAll run object with status and metadata.
312
306
  */
313
- export interface FindallRun {
307
+ export interface FindAllRun {
314
308
  /**
315
309
  * ID of the FindAll run.
316
310
  */
@@ -322,9 +316,9 @@ export interface FindallRun {
322
316
  generator: 'base' | 'core' | 'pro' | 'preview';
323
317
 
324
318
  /**
325
- * Status object for FindAll run.
319
+ * Status object for the FindAll run.
326
320
  */
327
- status: FindallRun.Status;
321
+ status: FindAllRun.Status;
328
322
 
329
323
  /**
330
324
  * Timestamp of the creation of the run, in RFC 3339 format.
@@ -343,9 +337,9 @@ export interface FindallRun {
343
337
  modified_at?: string | null;
344
338
  }
345
339
 
346
- export namespace FindallRun {
340
+ export namespace FindAllRun {
347
341
  /**
348
- * Status object for FindAll run.
342
+ * Status object for the FindAll run.
349
343
  */
350
344
  export interface Status {
351
345
  /**
@@ -354,7 +348,7 @@ export namespace FindallRun {
354
348
  is_active: boolean;
355
349
 
356
350
  /**
357
- * Metrics object for FindAll run.
351
+ * Candidate metrics for the FindAll run.
358
352
  */
359
353
  metrics: Status.Metrics;
360
354
 
@@ -366,12 +360,19 @@ export namespace FindallRun {
366
360
  /**
367
361
  * Reason for termination when FindAll run is in terminal status.
368
362
  */
369
- termination_reason?: string | null;
363
+ termination_reason?:
364
+ | 'low_match_rate'
365
+ | 'match_limit_met'
366
+ | 'candidates_exhausted'
367
+ | 'user_cancelled'
368
+ | 'error_occurred'
369
+ | 'timeout'
370
+ | null;
370
371
  }
371
372
 
372
373
  export namespace Status {
373
374
  /**
374
- * Metrics object for FindAll run.
375
+ * Candidate metrics for the FindAll run.
375
376
  */
376
377
  export interface Metrics {
377
378
  /**
@@ -390,24 +391,25 @@ export namespace FindallRun {
390
391
  /**
391
392
  * Input model for FindAll run.
392
393
  */
393
- export interface FindallRunInput {
394
+ export interface FindAllRunInput {
394
395
  /**
395
396
  * Type of the entity for the FindAll run.
396
397
  */
397
398
  entity_type: string;
398
399
 
399
400
  /**
400
- * Generator for the FindAll run.
401
+ * Generator for the FindAll run. One of base, core, pro, preview.
401
402
  */
402
403
  generator: 'base' | 'core' | 'pro' | 'preview';
403
404
 
404
405
  /**
405
406
  * List of match conditions for the FindAll run.
406
407
  */
407
- match_conditions: Array<FindallRunInput.MatchCondition>;
408
+ match_conditions: Array<FindAllRunInput.MatchCondition>;
408
409
 
409
410
  /**
410
- * Maximum number of matches to find for this FindAll run.
411
+ * Maximum number of matches to find for this FindAll run. Must be between 5 and
412
+ * 1000 (inclusive).
411
413
  */
412
414
  match_limit: number;
413
415
 
@@ -419,7 +421,7 @@ export interface FindallRunInput {
419
421
  /**
420
422
  * List of entity names/IDs to exclude from results.
421
423
  */
422
- exclude_list?: Array<FindallRunInput.ExcludeList> | null;
424
+ exclude_list?: Array<FindAllRunInput.ExcludeList> | null;
423
425
 
424
426
  /**
425
427
  * Metadata for the FindAll run.
@@ -432,7 +434,7 @@ export interface FindallRunInput {
432
434
  webhook?: BetaTaskRunAPI.Webhook | null;
433
435
  }
434
436
 
435
- export namespace FindallRunInput {
437
+ export namespace FindAllRunInput {
436
438
  /**
437
439
  * Match condition model for FindAll ingest.
438
440
  */
@@ -473,16 +475,16 @@ export namespace FindallRunInput {
473
475
  * candidate entities with their match status and details at the time the snapshot
474
476
  * was taken.
475
477
  */
476
- export interface FindallRunResult {
478
+ export interface FindAllRunResult {
477
479
  /**
478
480
  * All evaluated candidates at the time of the snapshot.
479
481
  */
480
- candidates: Array<FindallRunResult.Candidate>;
482
+ candidates: Array<FindAllRunResult.Candidate>;
481
483
 
482
484
  /**
483
- * FindAll run object with status and metadata.
485
+ * FindAll run object.
484
486
  */
485
- run: FindallRun;
487
+ run: FindAllRun;
486
488
 
487
489
  /**
488
490
  * ID of the last event of the run at the time of the request. This can be used to
@@ -491,7 +493,7 @@ export interface FindallRunResult {
491
493
  last_event_id?: string | null;
492
494
  }
493
495
 
494
- export namespace FindallRunResult {
496
+ export namespace FindAllRunResult {
495
497
  /**
496
498
  * Candidate for a find all run that may end up as a match.
497
499
  *
@@ -542,11 +544,11 @@ export namespace FindallRunResult {
542
544
  /**
543
545
  * Event containing status update for FindAll run.
544
546
  */
545
- export interface FindallRunStatusEvent {
547
+ export interface FindAllRunStatusEvent {
546
548
  /**
547
- * FindAll run object with status and metadata.
549
+ * Updated FindAll run information.
548
550
  */
549
- data: FindallRun;
551
+ data: FindAllRun;
550
552
 
551
553
  /**
552
554
  * Unique event identifier for the event.
@@ -567,7 +569,7 @@ export interface FindallRunStatusEvent {
567
569
  /**
568
570
  * Response model for FindAll ingest.
569
571
  */
570
- export interface FindallSchema {
572
+ export interface FindAllSchema {
571
573
  /**
572
574
  * Type of the entity for the FindAll run.
573
575
  */
@@ -576,7 +578,7 @@ export interface FindallSchema {
576
578
  /**
577
579
  * List of match conditions for the FindAll run.
578
580
  */
579
- match_conditions: Array<FindallSchema.MatchCondition>;
581
+ match_conditions: Array<FindAllSchema.MatchCondition>;
580
582
 
581
583
  /**
582
584
  * Natural language objective of the FindAll run.
@@ -586,7 +588,7 @@ export interface FindallSchema {
586
588
  /**
587
589
  * List of enrichment inputs for the FindAll run.
588
590
  */
589
- enrichments?: Array<FindallEnrichInput> | null;
591
+ enrichments?: Array<FindAllEnrichInput> | null;
590
592
 
591
593
  /**
592
594
  * The generator of the FindAll run.
@@ -599,7 +601,7 @@ export interface FindallSchema {
599
601
  match_limit?: number | null;
600
602
  }
601
603
 
602
- export namespace FindallSchema {
604
+ export namespace FindAllSchema {
603
605
  /**
604
606
  * Match condition model for FindAll ingest.
605
607
  */
@@ -621,11 +623,11 @@ export namespace FindallSchema {
621
623
  /**
622
624
  * Event containing full snapshot of FindAll run state.
623
625
  */
624
- export interface FindallSchemaUpdatedEvent {
626
+ export interface FindAllSchemaUpdatedEvent {
625
627
  /**
626
- * Response model for FindAll ingest.
628
+ * Updated FindAll schema.
627
629
  */
628
- data: FindallSchema;
630
+ data: FindAllSchema;
629
631
 
630
632
  /**
631
633
  * Unique event identifier for the event.
@@ -653,464 +655,36 @@ export interface IngestInput {
653
655
  objective: string;
654
656
  }
655
657
 
656
- /**
657
- * FindAll run object with status and metadata.
658
- */
659
- export type FindallRetrieveResponse = FindallRun | FindallRetrieveResponse.FindAllPollResponse;
660
-
661
- export namespace FindallRetrieveResponse {
662
- /**
663
- * Response format for polling a FindAll run status.
664
- */
665
- export interface FindAllPollResponse {
666
- /**
667
- * Billing metrics for the run.
668
- */
669
- billing_metrics: FindAllPollResponse.BillingMetrics;
670
-
671
- /**
672
- * List of candidates being processed
673
- */
674
- candidates: Array<FindAllPollResponse.Candidate>;
675
-
676
- /**
677
- * List of enrichments derived from the query
678
- */
679
- enrichments: Array<FindAllPollResponse.Enrichment>;
680
-
681
- /**
682
- * List of filters derived from the query
683
- */
684
- filters: Array<FindAllPollResponse.Filter>;
685
-
686
- /**
687
- * True if the run is still processing candidates
688
- */
689
- is_active: boolean;
690
-
691
- /**
692
- * Max results processed for the run
693
- */
694
- max_results: number;
695
-
696
- /**
697
- * Query for the run
698
- */
699
- query: string;
700
-
701
- /**
702
- * List of entities which are fully processed
703
- */
704
- results: Array<FindAllPollResponse.Result>;
705
-
706
- /**
707
- * View model for the run.
708
- */
709
- spec: FindAllPollResponse.Spec;
710
-
711
- /**
712
- * Derived overall status (e.g., 'running', 'completed', 'failed')
713
- */
714
- status: string;
715
-
716
- /**
717
- * List of processing steps undertaken with their status
718
- */
719
- steps: Array<FindAllPollResponse.Step>;
720
-
721
- /**
722
- * Title of the run
723
- */
724
- title: string;
725
-
726
- /**
727
- * True if enrichments are still being processed
728
- */
729
- are_enrichments_active?: boolean;
730
-
731
- /**
732
- * Timestamp of the request
733
- */
734
- created_at?: string | null;
735
-
736
- /**
737
- * List of recommended enrichments that could be added
738
- */
739
- enrichment_recommendations?: Array<FindAllPollResponse.EnrichmentRecommendation>;
740
-
741
- /**
742
- * Timestamp of the last status update
743
- */
744
- modified_at?: string | null;
745
-
746
- /**
747
- * Number of web pages considered for this entity
748
- */
749
- pages_considered?: number | null;
750
-
751
- /**
752
- * Number of web pages read for this entity
753
- */
754
- pages_read?: number | null;
755
- }
756
-
757
- export namespace FindAllPollResponse {
758
- /**
759
- * Billing metrics for the run.
760
- */
761
- export interface BillingMetrics {
762
- /**
763
- * Number of enrichment cells processed
764
- */
765
- enrichment_cells: number;
766
-
767
- /**
768
- * Number of rows processed
769
- */
770
- rows_processed: number;
771
-
772
- cost_mode?: 'lite' | 'base' | 'pro' | 'preview';
773
- }
774
-
775
- /**
776
- * Simplified entity model for candidates.
777
- */
778
- export interface Candidate {
779
- /**
780
- * Unique entity identifier
781
- */
782
- entity_id: string;
783
-
784
- /**
785
- * Entity name
786
- */
787
- name: string;
788
- }
789
-
790
- /**
791
- * Column model for filters and enrichments.
792
- */
793
- export interface Enrichment {
794
- /**
795
- * Human-readable description of the column
796
- */
797
- description: string;
798
-
799
- /**
800
- * Column identifier
801
- */
802
- name: string;
803
-
804
- /**
805
- * Column type ('enrichment' or 'filter')
806
- */
807
- type: string;
808
-
809
- /**
810
- * Status of the column ('running', 'done', 'failed')
811
- */
812
- status?: string | null;
813
- }
814
-
815
- /**
816
- * Column model for filters and enrichments.
817
- */
818
- export interface Filter {
819
- /**
820
- * Human-readable description of the column
821
- */
822
- description: string;
823
-
824
- /**
825
- * Column identifier
826
- */
827
- name: string;
828
-
829
- /**
830
- * Column type ('enrichment' or 'filter')
831
- */
832
- type: string;
833
-
834
- /**
835
- * Status of the column ('running', 'done', 'failed')
836
- */
837
- status?: string | null;
838
- }
839
-
840
- /**
841
- * Entity model for results and candidates.
842
- */
843
- export interface Result {
844
- /**
845
- * Unique entity identifier
846
- */
847
- entity_id: string;
848
-
849
- /**
850
- * Entity name
851
- */
852
- name: string;
853
-
854
- /**
855
- * Entity description if available
856
- */
857
- description?: string | null;
858
-
859
- /**
860
- * List of enrichment results
861
- */
862
- enrichment_results?: Array<Result.EnrichmentResult>;
863
-
864
- /**
865
- * List of filter results
866
- */
867
- filter_results?: Array<Result.FilterResult>;
868
-
869
- /**
870
- * Confidence score (positive real number)
871
- */
872
- score?: number | null;
873
-
874
- /**
875
- * Entity URL if available
876
- */
877
- url?: string | null;
878
- }
879
-
880
- export namespace Result {
881
- /**
882
- * Result model for filter and enrichment results.
883
- */
884
- export interface EnrichmentResult {
885
- /**
886
- * Name of column
887
- */
888
- key: string;
889
-
890
- /**
891
- * Result of column
892
- */
893
- value: string;
894
-
895
- /**
896
- * Space separated list of citation urls
897
- */
898
- citations?: string | null;
899
-
900
- /**
901
- * Confidence score (e.g. 'high', 'medium', 'low')
902
- */
903
- confidence?: string | null;
904
-
905
- /**
906
- * List of enhanced citations with title and excerpts
907
- */
908
- enhanced_citations?: Array<EnrichmentResult.EnhancedCitation>;
909
-
910
- /**
911
- * Reasoning behind the value
912
- */
913
- reasoning?: string | null;
914
- }
915
-
916
- export namespace EnrichmentResult {
917
- /**
918
- * Enhanced citation model with title, excerpts, and URL for UI.
919
- */
920
- export interface EnhancedCitation {
921
- /**
922
- * Citation URL
923
- */
924
- url: string;
925
-
926
- /**
927
- * List of relevant excerpts from the cited page
928
- */
929
- excerpts?: Array<string>;
930
-
931
- /**
932
- * Title of the cited page
933
- */
934
- title?: string | null;
935
- }
936
- }
937
-
938
- /**
939
- * Result model for filter and enrichment results.
940
- */
941
- export interface FilterResult {
942
- /**
943
- * Name of column
944
- */
945
- key: string;
946
-
947
- /**
948
- * Result of column
949
- */
950
- value: string;
951
-
952
- /**
953
- * Space separated list of citation urls
954
- */
955
- citations?: string | null;
956
-
957
- /**
958
- * Confidence score (e.g. 'high', 'medium', 'low')
959
- */
960
- confidence?: string | null;
961
-
962
- /**
963
- * List of enhanced citations with title and excerpts
964
- */
965
- enhanced_citations?: Array<FilterResult.EnhancedCitation>;
966
-
967
- /**
968
- * Reasoning behind the value
969
- */
970
- reasoning?: string | null;
971
- }
972
-
973
- export namespace FilterResult {
974
- /**
975
- * Enhanced citation model with title, excerpts, and URL for UI.
976
- */
977
- export interface EnhancedCitation {
978
- /**
979
- * Citation URL
980
- */
981
- url: string;
982
-
983
- /**
984
- * List of relevant excerpts from the cited page
985
- */
986
- excerpts?: Array<string>;
987
-
988
- /**
989
- * Title of the cited page
990
- */
991
- title?: string | null;
992
- }
993
- }
994
- }
995
-
996
- /**
997
- * View model for the run.
998
- */
999
- export interface Spec {
1000
- /**
1001
- * List of columns in the view
1002
- */
1003
- columns: Array<Spec.Column>;
1004
-
1005
- /**
1006
- * Name of the view
1007
- */
1008
- name: string;
1009
- }
1010
-
1011
- export namespace Spec {
1012
- /**
1013
- * Column model for filters and enrichments.
1014
- */
1015
- export interface Column {
1016
- /**
1017
- * Human-readable description of the column
1018
- */
1019
- description: string;
1020
-
1021
- /**
1022
- * Column identifier
1023
- */
1024
- name: string;
1025
-
1026
- /**
1027
- * Column type ('enrichment' or 'filter')
1028
- */
1029
- type: string;
1030
-
1031
- /**
1032
- * Status of the column ('running', 'done', 'failed')
1033
- */
1034
- status?: string | null;
1035
- }
1036
- }
1037
-
1038
- /**
1039
- * Step model for tracking progress of FindAll operations.
1040
- */
1041
- export interface Step {
1042
- /**
1043
- * Human-readable description of the step
1044
- */
1045
- description: string;
1046
-
1047
- /**
1048
- * Step identifier
1049
- */
1050
- name: string;
1051
-
1052
- /**
1053
- * Current status of the step
1054
- */
1055
- status: string;
1056
- }
1057
-
1058
- /**
1059
- * Enrichment recommendation model.
1060
- */
1061
- export interface EnrichmentRecommendation {
1062
- /**
1063
- * Recommended column name
1064
- */
1065
- column_name: string;
1066
-
1067
- /**
1068
- * Description of the recommended enrichment
1069
- */
1070
- description: string;
1071
-
1072
- /**
1073
- * Run ID that generated this recommendation
1074
- */
1075
- recommendation_run_id: string;
1076
-
1077
- /**
1078
- * Task ID that generated this recommendation
1079
- */
1080
- recommendation_task_id: string;
1081
- }
1082
- }
1083
- }
1084
-
1085
- export type FindallCancelResponse = unknown;
658
+ export type FindAllCancelResponse = unknown;
1086
659
 
1087
660
  /**
1088
661
  * Event containing full snapshot of FindAll run state.
1089
662
  */
1090
- export type FindallEventsResponse =
1091
- | FindallSchemaUpdatedEvent
1092
- | FindallRunStatusEvent
1093
- | FindallCandidateMatchStatusEvent
663
+ export type FindAllEventsResponse =
664
+ | FindAllSchemaUpdatedEvent
665
+ | FindAllRunStatusEvent
666
+ | FindAllCandidateMatchStatusEvent
1094
667
  | BetaTaskRunAPI.ErrorEvent;
1095
668
 
1096
- export interface FindallCreateParams {
669
+ export interface FindAllCreateParams {
1097
670
  /**
1098
671
  * Body param: Type of the entity for the FindAll run.
1099
672
  */
1100
673
  entity_type: string;
1101
674
 
1102
675
  /**
1103
- * Body param: Generator for the FindAll run.
676
+ * Body param: Generator for the FindAll run. One of base, core, pro, preview.
1104
677
  */
1105
678
  generator: 'base' | 'core' | 'pro' | 'preview';
1106
679
 
1107
680
  /**
1108
681
  * Body param: List of match conditions for the FindAll run.
1109
682
  */
1110
- match_conditions: Array<FindallCreateParams.MatchCondition>;
683
+ match_conditions: Array<FindAllCreateParams.MatchCondition>;
1111
684
 
1112
685
  /**
1113
- * Body param: Maximum number of matches to find for this FindAll run.
686
+ * Body param: Maximum number of matches to find for this FindAll run. Must be
687
+ * between 5 and 1000 (inclusive).
1114
688
  */
1115
689
  match_limit: number;
1116
690
 
@@ -1122,7 +696,7 @@ export interface FindallCreateParams {
1122
696
  /**
1123
697
  * Body param: List of entity names/IDs to exclude from results.
1124
698
  */
1125
- exclude_list?: Array<FindallCreateParams.ExcludeList> | null;
699
+ exclude_list?: Array<FindAllCreateParams.ExcludeList> | null;
1126
700
 
1127
701
  /**
1128
702
  * Body param: Metadata for the FindAll run.
@@ -1140,7 +714,7 @@ export interface FindallCreateParams {
1140
714
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
1141
715
  }
1142
716
 
1143
- export namespace FindallCreateParams {
717
+ export namespace FindAllCreateParams {
1144
718
  /**
1145
719
  * Match condition model for FindAll ingest.
1146
720
  */
@@ -1174,23 +748,23 @@ export namespace FindallCreateParams {
1174
748
  }
1175
749
  }
1176
750
 
1177
- export interface FindallRetrieveParams {
751
+ export interface FindAllRetrieveParams {
1178
752
  /**
1179
753
  * Optional header to specify the beta version(s) to enable.
1180
754
  */
1181
755
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
1182
756
  }
1183
757
 
1184
- export interface FindallCancelParams {
758
+ export interface FindAllCancelParams {
1185
759
  /**
1186
760
  * Optional header to specify the beta version(s) to enable.
1187
761
  */
1188
762
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
1189
763
  }
1190
764
 
1191
- export interface FindallEnrichParams {
765
+ export interface FindAllEnrichParams {
1192
766
  /**
1193
- * Body param: JSON schema for a task input or output.
767
+ * Body param: JSON schema for the enrichment output schema for the FindAll run.
1194
768
  */
1195
769
  output_schema: TaskRunAPI.JsonSchema;
1196
770
 
@@ -1210,7 +784,7 @@ export interface FindallEnrichParams {
1210
784
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
1211
785
  }
1212
786
 
1213
- export interface FindallEventsParams {
787
+ export interface FindAllEventsParams {
1214
788
  /**
1215
789
  * Query param:
1216
790
  */
@@ -1227,7 +801,7 @@ export interface FindallEventsParams {
1227
801
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
1228
802
  }
1229
803
 
1230
- export interface FindallExtendParams {
804
+ export interface FindAllExtendParams {
1231
805
  /**
1232
806
  * Body param: Additional number of matches to find for this FindAll run. This
1233
807
  * value will be added to the current match limit to determine the new total match
@@ -1241,7 +815,7 @@ export interface FindallExtendParams {
1241
815
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
1242
816
  }
1243
817
 
1244
- export interface FindallIngestParams {
818
+ export interface FindAllIngestParams {
1245
819
  /**
1246
820
  * Body param: Natural language objective to create a FindAll run spec.
1247
821
  */
@@ -1253,20 +827,97 @@ export interface FindallIngestParams {
1253
827
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
1254
828
  }
1255
829
 
1256
- export interface FindallResultParams {
830
+ export interface FindAllResultParams {
1257
831
  /**
1258
832
  * Optional header to specify the beta version(s) to enable.
1259
833
  */
1260
834
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
1261
835
  }
1262
836
 
1263
- export interface FindallSchemaParams {
837
+ export interface FindAllSchemaParams {
1264
838
  /**
1265
839
  * Optional header to specify the beta version(s) to enable.
1266
840
  */
1267
841
  betas?: Array<BetaTaskRunAPI.ParallelBeta>;
1268
842
  }
1269
843
 
844
+ export declare namespace FindAll {
845
+ export {
846
+ type FindAllCandidateMatchStatusEvent as FindAllCandidateMatchStatusEvent,
847
+ type FindAllEnrichInput as FindAllEnrichInput,
848
+ type FindAllExtendInput as FindAllExtendInput,
849
+ type FindAllRun as FindAllRun,
850
+ type FindAllRunInput as FindAllRunInput,
851
+ type FindAllRunResult as FindAllRunResult,
852
+ type FindAllRunStatusEvent as FindAllRunStatusEvent,
853
+ type FindAllSchema as FindAllSchema,
854
+ type FindAllSchemaUpdatedEvent as FindAllSchemaUpdatedEvent,
855
+ type IngestInput as IngestInput,
856
+ type FindAllCancelResponse as FindAllCancelResponse,
857
+ type FindAllEventsResponse as FindAllEventsResponse,
858
+ type FindAllCreateParams as FindAllCreateParams,
859
+ type FindAllRetrieveParams as FindAllRetrieveParams,
860
+ type FindAllCancelParams as FindAllCancelParams,
861
+ type FindAllEnrichParams as FindAllEnrichParams,
862
+ type FindAllEventsParams as FindAllEventsParams,
863
+ type FindAllExtendParams as FindAllExtendParams,
864
+ type FindAllIngestParams as FindAllIngestParams,
865
+ type FindAllResultParams as FindAllResultParams,
866
+ type FindAllSchemaParams as FindAllSchemaParams,
867
+ };
868
+ }
869
+
870
+ /**
871
+ * Backwards-compatible aliases (deprecated).
872
+ *
873
+ * Historically these types/resources were exported as `Findall*` (lowercase "a").
874
+ * The canonical names are now `FindAll*`.
875
+ */
876
+ export class Findall extends FindAll {}
877
+
878
+ /** @deprecated Use `FindAllCandidateMatchStatusEvent` instead. */
879
+ export type FindallCandidateMatchStatusEvent = FindAllCandidateMatchStatusEvent;
880
+ /** @deprecated Use `FindAllEnrichInput` instead. */
881
+ export type FindallEnrichInput = FindAllEnrichInput;
882
+ /** @deprecated Use `FindAllExtendInput` instead. */
883
+ export type FindallExtendInput = FindAllExtendInput;
884
+ /** @deprecated Use `FindAllRun` instead. */
885
+ export type FindallRun = FindAllRun;
886
+ /** @deprecated Use `FindAllRunInput` instead. */
887
+ export type FindallRunInput = FindAllRunInput;
888
+ /** @deprecated Use `FindAllRunResult` instead. */
889
+ export type FindallRunResult = FindAllRunResult;
890
+ /** @deprecated Use `FindAllRunStatusEvent` instead. */
891
+ export type FindallRunStatusEvent = FindAllRunStatusEvent;
892
+ /** @deprecated Use `FindAllSchema` instead. */
893
+ export type FindallSchema = FindAllSchema;
894
+ /** @deprecated Use `FindAllSchemaUpdatedEvent` instead. */
895
+ export type FindallSchemaUpdatedEvent = FindAllSchemaUpdatedEvent;
896
+ /** @deprecated Use `IngestInput` instead. */
897
+ export type FindallIngestInput = IngestInput;
898
+ /** @deprecated Use `FindAllCancelResponse` instead. */
899
+ export type FindallCancelResponse = FindAllCancelResponse;
900
+ /** @deprecated Use `FindAllEventsResponse` instead. */
901
+ export type FindallEventsResponse = FindAllEventsResponse;
902
+ /** @deprecated Use `FindAllCreateParams` instead. */
903
+ export type FindallCreateParams = FindAllCreateParams;
904
+ /** @deprecated Use `FindAllRetrieveParams` instead. */
905
+ export type FindallRetrieveParams = FindAllRetrieveParams;
906
+ /** @deprecated Use `FindAllCancelParams` instead. */
907
+ export type FindallCancelParams = FindAllCancelParams;
908
+ /** @deprecated Use `FindAllEnrichParams` instead. */
909
+ export type FindallEnrichParams = FindAllEnrichParams;
910
+ /** @deprecated Use `FindAllEventsParams` instead. */
911
+ export type FindallEventsParams = FindAllEventsParams;
912
+ /** @deprecated Use `FindAllExtendParams` instead. */
913
+ export type FindallExtendParams = FindAllExtendParams;
914
+ /** @deprecated Use `FindAllIngestParams` instead. */
915
+ export type FindallIngestParams = FindAllIngestParams;
916
+ /** @deprecated Use `FindAllResultParams` instead. */
917
+ export type FindallResultParams = FindAllResultParams;
918
+ /** @deprecated Use `FindAllSchemaParams` instead. */
919
+ export type FindallSchemaParams = FindAllSchemaParams;
920
+
1270
921
  export declare namespace Findall {
1271
922
  export {
1272
923
  type FindallCandidateMatchStatusEvent as FindallCandidateMatchStatusEvent,
@@ -1278,8 +929,7 @@ export declare namespace Findall {
1278
929
  type FindallRunStatusEvent as FindallRunStatusEvent,
1279
930
  type FindallSchema as FindallSchema,
1280
931
  type FindallSchemaUpdatedEvent as FindallSchemaUpdatedEvent,
1281
- type IngestInput as IngestInput,
1282
- type FindallRetrieveResponse as FindallRetrieveResponse,
932
+ type FindallIngestInput as FindallIngestInput,
1283
933
  type FindallCancelResponse as FindallCancelResponse,
1284
934
  type FindallEventsResponse as FindallEventsResponse,
1285
935
  type FindallCreateParams as FindallCreateParams,