parallel-web 0.4.1 → 1.0.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 (241) hide show
  1. package/CHANGELOG.md +54 -0
  2. package/api-promise.d.mts +1 -0
  3. package/api-promise.d.mts.map +1 -1
  4. package/api-promise.d.ts +1 -0
  5. package/api-promise.d.ts.map +1 -1
  6. package/api-promise.mjs +1 -0
  7. package/api-promise.mjs.map +1 -1
  8. package/client.d.mts +29 -8
  9. package/client.d.mts.map +1 -1
  10. package/client.d.ts +29 -8
  11. package/client.d.ts.map +1 -1
  12. package/client.js +34 -4
  13. package/client.js.map +1 -1
  14. package/client.mjs +34 -4
  15. package/client.mjs.map +1 -1
  16. package/core/api-promise.d.mts.map +1 -1
  17. package/core/api-promise.d.ts.map +1 -1
  18. package/core/api-promise.mjs.map +1 -1
  19. package/core/error.mjs.map +1 -1
  20. package/core/resource.d.mts.map +1 -1
  21. package/core/resource.d.ts.map +1 -1
  22. package/core/streaming.d.mts.map +1 -1
  23. package/core/streaming.d.ts.map +1 -1
  24. package/core/streaming.mjs.map +1 -1
  25. package/core/uploads.d.mts.map +1 -1
  26. package/core/uploads.d.ts.map +1 -1
  27. package/core/uploads.mjs.map +1 -1
  28. package/error.d.mts +1 -0
  29. package/error.d.mts.map +1 -1
  30. package/error.d.ts +1 -0
  31. package/error.d.ts.map +1 -1
  32. package/error.mjs +1 -0
  33. package/error.mjs.map +1 -1
  34. package/index.d.mts.map +1 -1
  35. package/index.d.ts.map +1 -1
  36. package/index.mjs.map +1 -1
  37. package/internal/decoders/line.mjs.map +1 -1
  38. package/internal/detect-platform.mjs.map +1 -1
  39. package/internal/headers.mjs.map +1 -1
  40. package/internal/parse.d.mts.map +1 -1
  41. package/internal/parse.d.ts.map +1 -1
  42. package/internal/parse.mjs.map +1 -1
  43. package/internal/qs/formats.d.mts +7 -0
  44. package/internal/qs/formats.d.mts.map +1 -0
  45. package/internal/qs/formats.d.ts +7 -0
  46. package/internal/qs/formats.d.ts.map +1 -0
  47. package/internal/qs/formats.js +13 -0
  48. package/internal/qs/formats.js.map +1 -0
  49. package/internal/qs/formats.mjs +9 -0
  50. package/internal/qs/formats.mjs.map +1 -0
  51. package/internal/qs/index.d.mts +10 -0
  52. package/internal/qs/index.d.mts.map +1 -0
  53. package/internal/qs/index.d.ts +10 -0
  54. package/internal/qs/index.d.ts.map +1 -0
  55. package/internal/qs/index.js +14 -0
  56. package/internal/qs/index.js.map +1 -0
  57. package/internal/qs/index.mjs +10 -0
  58. package/internal/qs/index.mjs.map +1 -0
  59. package/internal/qs/stringify.d.mts +3 -0
  60. package/internal/qs/stringify.d.mts.map +1 -0
  61. package/internal/qs/stringify.d.ts +3 -0
  62. package/internal/qs/stringify.d.ts.map +1 -0
  63. package/internal/qs/stringify.js +277 -0
  64. package/internal/qs/stringify.js.map +1 -0
  65. package/internal/qs/stringify.mjs +274 -0
  66. package/internal/qs/stringify.mjs.map +1 -0
  67. package/internal/qs/types.d.mts +57 -0
  68. package/internal/qs/types.d.mts.map +1 -0
  69. package/internal/qs/types.d.ts +57 -0
  70. package/internal/qs/types.d.ts.map +1 -0
  71. package/internal/qs/types.js +3 -0
  72. package/internal/qs/types.js.map +1 -0
  73. package/internal/qs/types.mjs +2 -0
  74. package/internal/qs/types.mjs.map +1 -0
  75. package/internal/qs/utils.d.mts +15 -0
  76. package/internal/qs/utils.d.mts.map +1 -0
  77. package/internal/qs/utils.d.ts +15 -0
  78. package/internal/qs/utils.d.ts.map +1 -0
  79. package/internal/qs/utils.js +230 -0
  80. package/internal/qs/utils.js.map +1 -0
  81. package/internal/qs/utils.mjs +217 -0
  82. package/internal/qs/utils.mjs.map +1 -0
  83. package/internal/request-options.d.mts.map +1 -1
  84. package/internal/request-options.d.ts.map +1 -1
  85. package/internal/shims.d.mts +6 -0
  86. package/internal/shims.d.mts.map +1 -1
  87. package/internal/shims.d.ts +6 -0
  88. package/internal/shims.d.ts.map +1 -1
  89. package/internal/to-file.d.mts.map +1 -1
  90. package/internal/to-file.d.ts.map +1 -1
  91. package/internal/to-file.mjs.map +1 -1
  92. package/internal/types.d.mts +10 -10
  93. package/internal/types.d.mts.map +1 -1
  94. package/internal/types.d.ts +10 -10
  95. package/internal/types.d.ts.map +1 -1
  96. package/internal/uploads.d.mts.map +1 -1
  97. package/internal/uploads.d.ts.map +1 -1
  98. package/internal/uploads.mjs.map +1 -1
  99. package/internal/utils/base64.mjs.map +1 -1
  100. package/internal/utils/log.d.mts.map +1 -1
  101. package/internal/utils/log.d.ts.map +1 -1
  102. package/internal/utils/log.js +3 -2
  103. package/internal/utils/log.js.map +1 -1
  104. package/internal/utils/log.mjs +3 -2
  105. package/internal/utils/log.mjs.map +1 -1
  106. package/internal/utils/path.mjs.map +1 -1
  107. package/internal/utils/query.d.mts +0 -3
  108. package/internal/utils/query.d.mts.map +1 -1
  109. package/internal/utils/query.d.ts +0 -3
  110. package/internal/utils/query.d.ts.map +1 -1
  111. package/internal/utils/query.js +3 -16
  112. package/internal/utils/query.js.map +1 -1
  113. package/internal/utils/query.mjs +2 -16
  114. package/internal/utils/query.mjs.map +1 -1
  115. package/internal/utils/values.mjs.map +1 -1
  116. package/internal/utils.d.mts.map +1 -1
  117. package/internal/utils.d.ts.map +1 -1
  118. package/internal/utils.mjs.map +1 -1
  119. package/package.json +1 -1
  120. package/resource.d.mts +1 -0
  121. package/resource.d.mts.map +1 -1
  122. package/resource.d.ts +1 -0
  123. package/resource.d.ts.map +1 -1
  124. package/resource.mjs +1 -0
  125. package/resource.mjs.map +1 -1
  126. package/resources/beta/beta.d.mts +2 -270
  127. package/resources/beta/beta.d.mts.map +1 -1
  128. package/resources/beta/beta.d.ts +2 -270
  129. package/resources/beta/beta.d.ts.map +1 -1
  130. package/resources/beta/beta.js +0 -39
  131. package/resources/beta/beta.js.map +1 -1
  132. package/resources/beta/beta.mjs +0 -39
  133. package/resources/beta/beta.mjs.map +1 -1
  134. package/resources/beta/findall.d.mts +202 -247
  135. package/resources/beta/findall.d.mts.map +1 -1
  136. package/resources/beta/findall.d.ts +202 -247
  137. package/resources/beta/findall.d.ts.map +1 -1
  138. package/resources/beta/findall.js +28 -27
  139. package/resources/beta/findall.js.map +1 -1
  140. package/resources/beta/findall.mjs +28 -27
  141. package/resources/beta/findall.mjs.map +1 -1
  142. package/resources/beta/index.d.mts +1 -3
  143. package/resources/beta/index.d.mts.map +1 -1
  144. package/resources/beta/index.d.ts +1 -3
  145. package/resources/beta/index.d.ts.map +1 -1
  146. package/resources/beta/index.js +1 -5
  147. package/resources/beta/index.js.map +1 -1
  148. package/resources/beta/index.mjs +0 -2
  149. package/resources/beta/index.mjs.map +1 -1
  150. package/resources/beta.d.mts.map +1 -1
  151. package/resources/beta.d.ts.map +1 -1
  152. package/resources/beta.mjs.map +1 -1
  153. package/resources/index.d.mts +4 -2
  154. package/resources/index.d.mts.map +1 -1
  155. package/resources/index.d.ts +4 -2
  156. package/resources/index.d.ts.map +1 -1
  157. package/resources/index.js +5 -1
  158. package/resources/index.js.map +1 -1
  159. package/resources/index.mjs +2 -0
  160. package/resources/index.mjs.map +1 -1
  161. package/resources/monitor.d.mts +625 -0
  162. package/resources/monitor.d.mts.map +1 -0
  163. package/resources/monitor.d.ts +625 -0
  164. package/resources/monitor.d.ts.map +1 -0
  165. package/resources/monitor.js +140 -0
  166. package/resources/monitor.js.map +1 -0
  167. package/resources/monitor.mjs +136 -0
  168. package/resources/monitor.mjs.map +1 -0
  169. package/resources/{beta/task-group.d.mts → task-group.d.mts} +38 -68
  170. package/resources/task-group.d.mts.map +1 -0
  171. package/resources/{beta/task-group.d.ts → task-group.d.ts} +38 -68
  172. package/resources/task-group.d.ts.map +1 -0
  173. package/resources/{beta/task-group.js → task-group.js} +24 -64
  174. package/resources/task-group.js.map +1 -0
  175. package/resources/{beta/task-group.mjs → task-group.mjs} +24 -64
  176. package/resources/task-group.mjs.map +1 -0
  177. package/resources/task-run.d.mts +100 -83
  178. package/resources/task-run.d.mts.map +1 -1
  179. package/resources/task-run.d.ts +100 -83
  180. package/resources/task-run.d.ts.map +1 -1
  181. package/resources/task-run.js +14 -1
  182. package/resources/task-run.js.map +1 -1
  183. package/resources/task-run.mjs +14 -1
  184. package/resources/task-run.mjs.map +1 -1
  185. package/resources/top-level.d.mts +20 -16
  186. package/resources/top-level.d.mts.map +1 -1
  187. package/resources/top-level.d.ts +20 -16
  188. package/resources/top-level.d.ts.map +1 -1
  189. package/resources.d.mts.map +1 -1
  190. package/resources.d.ts.map +1 -1
  191. package/resources.mjs.map +1 -1
  192. package/src/client.ts +120 -4
  193. package/src/internal/qs/LICENSE.md +13 -0
  194. package/src/internal/qs/README.md +3 -0
  195. package/src/internal/qs/formats.ts +10 -0
  196. package/src/internal/qs/index.ts +13 -0
  197. package/src/internal/qs/stringify.ts +385 -0
  198. package/src/internal/qs/types.ts +71 -0
  199. package/src/internal/qs/utils.ts +265 -0
  200. package/src/internal/types.ts +6 -8
  201. package/src/internal/utils/log.ts +2 -1
  202. package/src/internal/utils/query.ts +2 -18
  203. package/src/resources/beta/api.md +9 -59
  204. package/src/resources/beta/beta.ts +16 -406
  205. package/src/resources/beta/findall.ts +252 -284
  206. package/src/resources/beta/index.ts +8 -30
  207. package/src/resources/index.ts +42 -0
  208. package/src/resources/monitor.ts +752 -0
  209. package/src/resources/{beta/task-group.ts → task-group.ts} +58 -93
  210. package/src/resources/task-run.ts +125 -98
  211. package/src/resources/top-level.ts +24 -16
  212. package/src/version.ts +1 -1
  213. package/streaming.d.mts +1 -0
  214. package/streaming.d.mts.map +1 -1
  215. package/streaming.d.ts +1 -0
  216. package/streaming.d.ts.map +1 -1
  217. package/streaming.mjs +1 -0
  218. package/streaming.mjs.map +1 -1
  219. package/uploads.d.mts +1 -0
  220. package/uploads.d.mts.map +1 -1
  221. package/uploads.d.ts +1 -0
  222. package/uploads.d.ts.map +1 -1
  223. package/uploads.mjs +1 -0
  224. package/uploads.mjs.map +1 -1
  225. package/version.d.mts +1 -1
  226. package/version.d.ts +1 -1
  227. package/version.js +1 -1
  228. package/version.mjs +1 -1
  229. package/resources/beta/task-group.d.mts.map +0 -1
  230. package/resources/beta/task-group.d.ts.map +0 -1
  231. package/resources/beta/task-group.js.map +0 -1
  232. package/resources/beta/task-group.mjs.map +0 -1
  233. package/resources/beta/task-run.d.mts +0 -239
  234. package/resources/beta/task-run.d.mts.map +0 -1
  235. package/resources/beta/task-run.d.ts +0 -239
  236. package/resources/beta/task-run.d.ts.map +0 -1
  237. package/resources/beta/task-run.js +0 -81
  238. package/resources/beta/task-run.js.map +0 -1
  239. package/resources/beta/task-run.mjs +0 -77
  240. package/resources/beta/task-run.mjs.map +0 -1
  241. package/src/resources/beta/task-run.ts +0 -336
@@ -2,7 +2,6 @@
2
2
 
3
3
  import { APIResource } from '../../core/resource';
4
4
  import * as TaskRunAPI from '../task-run';
5
- import * as BetaTaskRunAPI from './task-run';
6
5
  import { APIPromise } from '../../core/api-promise';
7
6
  import { Stream } from '../../core/streaming';
8
7
  import { buildHeaders } from '../../internal/headers';
@@ -86,50 +85,24 @@ export class FindAll extends APIResource {
86
85
  *
87
86
  * @example
88
87
  * ```ts
89
- * const response = await client.beta.findall.cancel(
90
- * 'findall_id',
91
- * );
88
+ * await client.beta.findall.cancel('findall_id');
92
89
  * ```
93
90
  */
94
91
  cancel(
95
92
  findallID: string,
96
93
  params: FindAllCancelParams | null | undefined = {},
97
94
  options?: RequestOptions,
98
- ): APIPromise<unknown> {
95
+ ): APIPromise<void> {
99
96
  const { betas } = params ?? {};
100
97
  return this._client.post(path`/v1beta/findall/runs/${findallID}/cancel`, {
101
98
  ...options,
102
99
  headers: buildHeaders([
103
- { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString() },
100
+ { 'parallel-beta': [...(betas ?? []), 'findall-2025-09-15'].toString(), Accept: '*/*' },
104
101
  options?.headers,
105
102
  ]),
106
103
  });
107
104
  }
108
105
 
109
- /**
110
- * Return ranked entity candidates matching a natural language objective.
111
- *
112
- * This endpoint performs a best-effort search optimised for low latency. For
113
- * comprehensive match evaluation and enrichment, use the
114
- * [FindAll API](https://docs.parallel.ai/findall-api/findall-quickstart).
115
- *
116
- * @example
117
- * ```ts
118
- * const findallCandidatesResponse =
119
- * await client.beta.findall.candidates({
120
- * entity_type: 'company',
121
- * objective: 'objective',
122
- * });
123
- * ```
124
- */
125
- candidates(body: FindAllCandidatesParams, options?: RequestOptions): APIPromise<FindAllCandidatesResponse> {
126
- return this._client.post('/v1beta/findall/candidates', {
127
- body,
128
- ...options,
129
- headers: buildHeaders([{ 'parallel-beta': 'findall-2025-09-15' }, options?.headers]),
130
- });
131
- }
132
-
133
106
  /**
134
107
  * Add an enrichment to a FindAll run.
135
108
  *
@@ -166,6 +139,36 @@ export class FindAll extends APIResource {
166
139
  });
167
140
  }
168
141
 
142
+ /**
143
+ * Return ranked entities matching a natural language objective.
144
+ *
145
+ * This endpoint performs a best-effort search optimized for low latency. To keep
146
+ * responses fast, it returns a fixed set of attributes and supports queries of
147
+ * limited complexity.
148
+ *
149
+ * For comprehensive match evaluation and enrichment, use the
150
+ * [FindAll API](https://docs.parallel.ai/findall-api/findall-quickstart).
151
+ *
152
+ * @example
153
+ * ```ts
154
+ * const findallEntitySearchResponse =
155
+ * await client.beta.findall.entitySearch({
156
+ * entity_type: 'people',
157
+ * objective: 'objective',
158
+ * });
159
+ * ```
160
+ */
161
+ entitySearch(
162
+ body: FindAllEntitySearchParams,
163
+ options?: RequestOptions,
164
+ ): APIPromise<FindAllEntitySearchResponse> {
165
+ return this._client.post('/v1beta/findall/entity-search', {
166
+ body,
167
+ ...options,
168
+ headers: buildHeaders([{ 'parallel-beta': 'findall-2025-09-15' }, options?.headers]),
169
+ });
170
+ }
171
+
169
172
  /**
170
173
  * Stream events from a FindAll run.
171
174
  *
@@ -304,6 +307,52 @@ export class FindAll extends APIResource {
304
307
  }
305
308
  }
306
309
 
310
+ /**
311
+ * Candidate for a find all run that may end up as a match.
312
+ *
313
+ * Contains all the candidate's metadata and the output of the match conditions. A
314
+ * candidate is a match if all match conditions are satisfied.
315
+ */
316
+ export interface FindAllCandidate {
317
+ /**
318
+ * ID of the candidate.
319
+ */
320
+ candidate_id: string;
321
+
322
+ /**
323
+ * Status of the candidate. One of generated, matched, unmatched, discarded.
324
+ */
325
+ match_status: 'generated' | 'matched' | 'unmatched' | 'discarded';
326
+
327
+ /**
328
+ * Name of the candidate.
329
+ */
330
+ name: string;
331
+
332
+ /**
333
+ * URL that provides context or details of the entity for disambiguation.
334
+ */
335
+ url: string;
336
+
337
+ /**
338
+ * List of FieldBasis objects supporting the output.
339
+ */
340
+ basis?: Array<TaskRunAPI.FieldBasis> | null;
341
+
342
+ /**
343
+ * Brief description of the entity that can help answer whether entity satisfies
344
+ * the query.
345
+ */
346
+ description?: string | null;
347
+
348
+ /**
349
+ * Results of the match condition evaluations for this candidate. This object
350
+ * contains the structured output that determines whether the candidate matches the
351
+ * overall FindAll objective.
352
+ */
353
+ output?: { [key: string]: unknown } | null;
354
+ }
355
+
307
356
  /**
308
357
  * Event containing a candidate whose match status has changed.
309
358
  */
@@ -311,7 +360,7 @@ export interface FindAllCandidateMatchStatusEvent {
311
360
  /**
312
361
  * The candidate whose match status has been updated.
313
362
  */
314
- data: FindAllCandidateMatchStatusEvent.Data;
363
+ data: FindAllCandidate;
315
364
 
316
365
  /**
317
366
  * Unique event identifier for the event.
@@ -336,56 +385,46 @@ export interface FindAllCandidateMatchStatusEvent {
336
385
  | 'findall.candidate.enriched';
337
386
  }
338
387
 
339
- export namespace FindAllCandidateMatchStatusEvent {
388
+ /**
389
+ * Metrics object for FindAll run.
390
+ */
391
+ export interface FindAllCandidateMetrics {
340
392
  /**
341
- * The candidate whose match status has been updated.
393
+ * Number of candidates that were selected.
342
394
  */
343
- export interface Data {
344
- /**
345
- * ID of the candidate.
346
- */
347
- candidate_id: string;
395
+ generated_candidates_count?: number;
348
396
 
349
- /**
350
- * Status of the candidate. One of generated, matched, unmatched, discarded.
351
- */
352
- match_status: 'generated' | 'matched' | 'unmatched' | 'discarded';
353
-
354
- /**
355
- * Name of the candidate.
356
- */
357
- name: string;
358
-
359
- /**
360
- * URL that provides context or details of the entity for disambiguation.
361
- */
362
- url: string;
397
+ /**
398
+ * Number of candidates that evaluated to matched.
399
+ */
400
+ matched_candidates_count?: number;
401
+ }
363
402
 
364
- /**
365
- * List of FieldBasis objects supporting the output.
366
- */
367
- basis?: Array<TaskRunAPI.FieldBasis> | null;
403
+ /**
404
+ * Input model for FindAll enrich.
405
+ */
406
+ export interface FindAllEnrichInput {
407
+ /**
408
+ * JSON schema for the enrichment output schema for the FindAll run.
409
+ */
410
+ output_schema: TaskRunAPI.JsonSchema;
368
411
 
369
- /**
370
- * Brief description of the entity that can help answer whether entity satisfies
371
- * the query.
372
- */
373
- description?: string | null;
412
+ /**
413
+ * List of MCP servers to use for the task.
414
+ */
415
+ mcp_servers?: Array<TaskRunAPI.McpServer> | null;
374
416
 
375
- /**
376
- * Results of the match condition evaluations for this candidate. This object
377
- * contains the structured output that determines whether the candidate matches the
378
- * overall FindAll objective.
379
- */
380
- output?: { [key: string]: unknown } | null;
381
- }
417
+ /**
418
+ * Processor to use for the task.
419
+ */
420
+ processor?: string;
382
421
  }
383
422
 
384
- export interface FindAllCandidatesRequest {
423
+ export interface FindAllEntitySearchRequest {
385
424
  /**
386
425
  * Type of entity to search for.
387
426
  */
388
- entity_type: 'company' | 'people';
427
+ entity_type: 'people' | 'companies';
389
428
 
390
429
  /**
391
430
  * Natural language description of target entities.
@@ -393,27 +432,26 @@ export interface FindAllCandidatesRequest {
393
432
  objective: string;
394
433
 
395
434
  /**
396
- * Maximum number of candidates to return. Must be between 5 and 1000 (inclusive).
435
+ * Maximum number of entities to return. Must be between 5 and 1000 (inclusive).
397
436
  * May return fewer results. Defaults to 100.
398
437
  */
399
438
  match_limit?: number;
400
439
  }
401
440
 
402
- export interface FindAllCandidatesResponse {
441
+ export interface FindAllEntitySearchResponse {
403
442
  /**
404
- * Candidate set request ID. Example:
405
- * `candidate_set_cad0a6d2dec046bd95ae900527d880e7`
443
+ * Ranked list of entities.
406
444
  */
407
- candidate_set_id: string;
445
+ entities: Array<FindAllEntitySearchResponse.Entity>;
408
446
 
409
447
  /**
410
- * Ranked list of entity candidates.
448
+ * Entity set request ID. Example: `entity_set_cad0a6d2dec046bd95ae900527d880e7`
411
449
  */
412
- candidates: Array<FindAllCandidatesResponse.Candidate>;
450
+ entity_set_id: string;
413
451
  }
414
452
 
415
- export namespace FindAllCandidatesResponse {
416
- export interface Candidate {
453
+ export namespace FindAllEntitySearchResponse {
454
+ export interface Entity {
417
455
  /**
418
456
  * Descriptive text about the entity.
419
457
  */
@@ -431,26 +469,6 @@ export namespace FindAllCandidatesResponse {
431
469
  }
432
470
  }
433
471
 
434
- /**
435
- * Input model for FindAll enrich.
436
- */
437
- export interface FindAllEnrichInput {
438
- /**
439
- * JSON schema for the enrichment output schema for the FindAll run.
440
- */
441
- output_schema: TaskRunAPI.JsonSchema;
442
-
443
- /**
444
- * List of MCP servers to use for the task.
445
- */
446
- mcp_servers?: Array<TaskRunAPI.McpServer> | null;
447
-
448
- /**
449
- * Processor to use for the task.
450
- */
451
- processor?: string;
452
- }
453
-
454
472
  /**
455
473
  * Input model for FindAll extend.
456
474
  */
@@ -480,7 +498,7 @@ export interface FindAllRun {
480
498
  /**
481
499
  * Status object for the FindAll run.
482
500
  */
483
- status: FindAllRun.Status;
501
+ status: FindAllRunStatus;
484
502
 
485
503
  /**
486
504
  * Timestamp of the creation of the run, in RFC 3339 format.
@@ -499,58 +517,6 @@ export interface FindAllRun {
499
517
  modified_at?: string | null;
500
518
  }
501
519
 
502
- export namespace FindAllRun {
503
- /**
504
- * Status object for the FindAll run.
505
- */
506
- export interface Status {
507
- /**
508
- * Whether the FindAll run is active
509
- */
510
- is_active: boolean;
511
-
512
- /**
513
- * Candidate metrics for the FindAll run.
514
- */
515
- metrics: Status.Metrics;
516
-
517
- /**
518
- * Status of the FindAll run.
519
- */
520
- status: 'queued' | 'action_required' | 'running' | 'completed' | 'failed' | 'cancelling' | 'cancelled';
521
-
522
- /**
523
- * Reason for termination when FindAll run is in terminal status.
524
- */
525
- termination_reason?:
526
- | 'low_match_rate'
527
- | 'match_limit_met'
528
- | 'candidates_exhausted'
529
- | 'user_cancelled'
530
- | 'error_occurred'
531
- | 'timeout'
532
- | 'insufficient_funds'
533
- | null;
534
- }
535
-
536
- export namespace Status {
537
- /**
538
- * Candidate metrics for the FindAll run.
539
- */
540
- export interface Metrics {
541
- /**
542
- * Number of candidates that were selected.
543
- */
544
- generated_candidates_count?: number;
545
-
546
- /**
547
- * Number of candidates that evaluated to matched.
548
- */
549
- matched_candidates_count?: number;
550
- }
551
- }
552
- }
553
-
554
520
  /**
555
521
  * Input model for FindAll run.
556
522
  */
@@ -568,7 +534,7 @@ export interface FindAllRunInput {
568
534
  /**
569
535
  * List of match conditions for the FindAll run.
570
536
  */
571
- match_conditions: Array<FindAllRunInput.MatchCondition>;
537
+ match_conditions: Array<MatchCondition>;
572
538
 
573
539
  /**
574
540
  * Maximum number of matches to find for this FindAll run. Must be between 5 and
@@ -598,23 +564,6 @@ export interface FindAllRunInput {
598
564
  }
599
565
 
600
566
  export namespace FindAllRunInput {
601
- /**
602
- * Match condition model for FindAll ingest.
603
- */
604
- export interface MatchCondition {
605
- /**
606
- * Detailed description of the match condition. Include as much specific
607
- * information as possible to help improve the quality and accuracy of Find All run
608
- * results.
609
- */
610
- description: string;
611
-
612
- /**
613
- * Name of the match condition.
614
- */
615
- name: string;
616
- }
617
-
618
567
  /**
619
568
  * Exclude candidate input model for FindAll run.
620
569
  */
@@ -642,7 +591,7 @@ export interface FindAllRunResult {
642
591
  /**
643
592
  * All evaluated candidates at the time of the snapshot.
644
593
  */
645
- candidates: Array<FindAllRunResult.Candidate>;
594
+ candidates: Array<FindAllCandidate>;
646
595
 
647
596
  /**
648
597
  * FindAll run object.
@@ -656,52 +605,37 @@ export interface FindAllRunResult {
656
605
  last_event_id?: string | null;
657
606
  }
658
607
 
659
- export namespace FindAllRunResult {
608
+ /**
609
+ * Status object for FindAll run.
610
+ */
611
+ export interface FindAllRunStatus {
660
612
  /**
661
- * Candidate for a find all run that may end up as a match.
662
- *
663
- * Contains all the candidate's metadata and the output of the match conditions. A
664
- * candidate is a match if all match conditions are satisfied.
613
+ * Whether the FindAll run is active
665
614
  */
666
- export interface Candidate {
667
- /**
668
- * ID of the candidate.
669
- */
670
- candidate_id: string;
671
-
672
- /**
673
- * Status of the candidate. One of generated, matched, unmatched, discarded.
674
- */
675
- match_status: 'generated' | 'matched' | 'unmatched' | 'discarded';
615
+ is_active: boolean;
676
616
 
677
- /**
678
- * Name of the candidate.
679
- */
680
- name: string;
681
-
682
- /**
683
- * URL that provides context or details of the entity for disambiguation.
684
- */
685
- url: string;
686
-
687
- /**
688
- * List of FieldBasis objects supporting the output.
689
- */
690
- basis?: Array<TaskRunAPI.FieldBasis> | null;
617
+ /**
618
+ * Candidate metrics for the FindAll run.
619
+ */
620
+ metrics: FindAllCandidateMetrics;
691
621
 
692
- /**
693
- * Brief description of the entity that can help answer whether entity satisfies
694
- * the query.
695
- */
696
- description?: string | null;
622
+ /**
623
+ * Status of the FindAll run.
624
+ */
625
+ status: 'queued' | 'action_required' | 'running' | 'completed' | 'failed' | 'cancelling' | 'cancelled';
697
626
 
698
- /**
699
- * Results of the match condition evaluations for this candidate. This object
700
- * contains the structured output that determines whether the candidate matches the
701
- * overall FindAll objective.
702
- */
703
- output?: { [key: string]: unknown } | null;
704
- }
627
+ /**
628
+ * Reason for termination when FindAll run is in terminal status.
629
+ */
630
+ termination_reason?:
631
+ | 'low_match_rate'
632
+ | 'match_limit_met'
633
+ | 'candidates_exhausted'
634
+ | 'user_cancelled'
635
+ | 'error_occurred'
636
+ | 'timeout'
637
+ | 'insufficient_funds'
638
+ | null;
705
639
  }
706
640
 
707
641
  /**
@@ -741,7 +675,7 @@ export interface FindAllSchema {
741
675
  /**
742
676
  * List of match conditions for the FindAll run.
743
677
  */
744
- match_conditions: Array<FindAllSchema.MatchCondition>;
678
+ match_conditions: Array<MatchCondition>;
745
679
 
746
680
  /**
747
681
  * Natural language objective of the FindAll run.
@@ -764,25 +698,6 @@ export interface FindAllSchema {
764
698
  match_limit?: number | null;
765
699
  }
766
700
 
767
- export namespace FindAllSchema {
768
- /**
769
- * Match condition model for FindAll ingest.
770
- */
771
- export interface MatchCondition {
772
- /**
773
- * Detailed description of the match condition. Include as much specific
774
- * information as possible to help improve the quality and accuracy of Find All run
775
- * results.
776
- */
777
- description: string;
778
-
779
- /**
780
- * Name of the match condition.
781
- */
782
- name: string;
783
- }
784
- }
785
-
786
701
  /**
787
702
  * Event containing full snapshot of FindAll run state.
788
703
  */
@@ -818,7 +733,34 @@ export interface IngestInput {
818
733
  objective: string;
819
734
  }
820
735
 
821
- export type FindAllCancelResponse = unknown;
736
+ /**
737
+ * Match condition model for FindAll ingest.
738
+ */
739
+ export interface MatchCondition {
740
+ /**
741
+ * Detailed description of the match condition. Include as much specific
742
+ * information as possible to help improve the quality and accuracy of Find All run
743
+ * results.
744
+ */
745
+ description: string;
746
+
747
+ /**
748
+ * Name of the match condition.
749
+ */
750
+ name: string;
751
+ }
752
+
753
+ /**
754
+ * Model for the parallel-beta header.
755
+ */
756
+ export type ParallelBeta =
757
+ | 'mcp-server-2025-07-17'
758
+ | 'events-sse-2025-07-24'
759
+ | 'webhook-2025-08-12'
760
+ | 'findall-2025-09-15'
761
+ | 'search-extract-2025-10-10'
762
+ | 'field-basis-2025-11-25'
763
+ | (string & {});
822
764
 
823
765
  /**
824
766
  * Event containing full snapshot of FindAll run state.
@@ -843,7 +785,7 @@ export interface FindAllCreateParams {
843
785
  /**
844
786
  * Body param: List of match conditions for the FindAll run.
845
787
  */
846
- match_conditions: Array<FindAllCreateParams.MatchCondition>;
788
+ match_conditions: Array<MatchCondition>;
847
789
 
848
790
  /**
849
791
  * Body param: Maximum number of matches to find for this FindAll run. Must be
@@ -874,27 +816,10 @@ export interface FindAllCreateParams {
874
816
  /**
875
817
  * Header param: Optional header to specify the beta version(s) to enable.
876
818
  */
877
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
819
+ betas?: Array<ParallelBeta>;
878
820
  }
879
821
 
880
822
  export namespace FindAllCreateParams {
881
- /**
882
- * Match condition model for FindAll ingest.
883
- */
884
- export interface MatchCondition {
885
- /**
886
- * Detailed description of the match condition. Include as much specific
887
- * information as possible to help improve the quality and accuracy of Find All run
888
- * results.
889
- */
890
- description: string;
891
-
892
- /**
893
- * Name of the match condition.
894
- */
895
- name: string;
896
- }
897
-
898
823
  /**
899
824
  * Exclude candidate input model for FindAll run.
900
825
  */
@@ -915,54 +840,54 @@ export interface FindAllRetrieveParams {
915
840
  /**
916
841
  * Optional header to specify the beta version(s) to enable.
917
842
  */
918
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
843
+ betas?: Array<ParallelBeta>;
919
844
  }
920
845
 
921
846
  export interface FindAllCancelParams {
922
847
  /**
923
848
  * Optional header to specify the beta version(s) to enable.
924
849
  */
925
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
850
+ betas?: Array<ParallelBeta>;
926
851
  }
927
852
 
928
- export interface FindAllCandidatesParams {
853
+ export interface FindAllEnrichParams {
929
854
  /**
930
- * Type of entity to search for.
855
+ * Body param: JSON schema for the enrichment output schema for the FindAll run.
931
856
  */
932
- entity_type: 'company' | 'people';
857
+ output_schema: TaskRunAPI.JsonSchema;
933
858
 
934
859
  /**
935
- * Natural language description of target entities.
860
+ * Body param: List of MCP servers to use for the task.
936
861
  */
937
- objective: string;
862
+ mcp_servers?: Array<TaskRunAPI.McpServer> | null;
938
863
 
939
864
  /**
940
- * Maximum number of candidates to return. Must be between 5 and 1000 (inclusive).
941
- * May return fewer results. Defaults to 100.
865
+ * Body param: Processor to use for the task.
942
866
  */
943
- match_limit?: number;
944
- }
867
+ processor?: string;
945
868
 
946
- export interface FindAllEnrichParams {
947
869
  /**
948
- * Body param: JSON schema for the enrichment output schema for the FindAll run.
870
+ * Header param: Optional header to specify the beta version(s) to enable.
949
871
  */
950
- output_schema: TaskRunAPI.JsonSchema;
872
+ betas?: Array<ParallelBeta>;
873
+ }
951
874
 
875
+ export interface FindAllEntitySearchParams {
952
876
  /**
953
- * Body param: List of MCP servers to use for the task.
877
+ * Type of entity to search for.
954
878
  */
955
- mcp_servers?: Array<TaskRunAPI.McpServer> | null;
879
+ entity_type: 'people' | 'companies';
956
880
 
957
881
  /**
958
- * Body param: Processor to use for the task.
882
+ * Natural language description of target entities.
959
883
  */
960
- processor?: string;
884
+ objective: string;
961
885
 
962
886
  /**
963
- * Header param: Optional header to specify the beta version(s) to enable.
887
+ * Maximum number of entities to return. Must be between 5 and 1000 (inclusive).
888
+ * May return fewer results. Defaults to 100.
964
889
  */
965
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
890
+ match_limit?: number;
966
891
  }
967
892
 
968
893
  export interface FindAllEventsParams {
@@ -979,7 +904,7 @@ export interface FindAllEventsParams {
979
904
  /**
980
905
  * Header param: Optional header to specify the beta version(s) to enable.
981
906
  */
982
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
907
+ betas?: Array<ParallelBeta>;
983
908
  }
984
909
 
985
910
  export interface FindAllExtendParams {
@@ -993,7 +918,7 @@ export interface FindAllExtendParams {
993
918
  /**
994
919
  * Header param: Optional header to specify the beta version(s) to enable.
995
920
  */
996
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
921
+ betas?: Array<ParallelBeta>;
997
922
  }
998
923
 
999
924
  export interface FindAllIngestParams {
@@ -1005,44 +930,48 @@ export interface FindAllIngestParams {
1005
930
  /**
1006
931
  * Header param: Optional header to specify the beta version(s) to enable.
1007
932
  */
1008
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
933
+ betas?: Array<ParallelBeta>;
1009
934
  }
1010
935
 
1011
936
  export interface FindAllResultParams {
1012
937
  /**
1013
938
  * Optional header to specify the beta version(s) to enable.
1014
939
  */
1015
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
940
+ betas?: Array<ParallelBeta>;
1016
941
  }
1017
942
 
1018
943
  export interface FindAllSchemaParams {
1019
944
  /**
1020
945
  * Optional header to specify the beta version(s) to enable.
1021
946
  */
1022
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
947
+ betas?: Array<ParallelBeta>;
1023
948
  }
1024
949
 
1025
950
  export declare namespace FindAll {
1026
951
  export {
952
+ type FindAllCandidate as FindAllCandidate,
1027
953
  type FindAllCandidateMatchStatusEvent as FindAllCandidateMatchStatusEvent,
1028
- type FindAllCandidatesRequest as FindAllCandidatesRequest,
1029
- type FindAllCandidatesResponse as FindAllCandidatesResponse,
954
+ type FindAllCandidateMetrics as FindAllCandidateMetrics,
1030
955
  type FindAllEnrichInput as FindAllEnrichInput,
956
+ type FindAllEntitySearchRequest as FindAllEntitySearchRequest,
957
+ type FindAllEntitySearchResponse as FindAllEntitySearchResponse,
1031
958
  type FindAllExtendInput as FindAllExtendInput,
1032
959
  type FindAllRun as FindAllRun,
1033
960
  type FindAllRunInput as FindAllRunInput,
1034
961
  type FindAllRunResult as FindAllRunResult,
962
+ type FindAllRunStatus as FindAllRunStatus,
1035
963
  type FindAllRunStatusEvent as FindAllRunStatusEvent,
1036
964
  type FindAllSchema as FindAllSchema,
1037
965
  type FindAllSchemaUpdatedEvent as FindAllSchemaUpdatedEvent,
1038
966
  type IngestInput as IngestInput,
1039
- type FindAllCancelResponse as FindAllCancelResponse,
967
+ type MatchCondition as MatchCondition,
968
+ type ParallelBeta as ParallelBeta,
1040
969
  type FindAllEventsResponse as FindAllEventsResponse,
1041
970
  type FindAllCreateParams as FindAllCreateParams,
1042
971
  type FindAllRetrieveParams as FindAllRetrieveParams,
1043
972
  type FindAllCancelParams as FindAllCancelParams,
1044
- type FindAllCandidatesParams as FindAllCandidatesParams,
1045
973
  type FindAllEnrichParams as FindAllEnrichParams,
974
+ type FindAllEntitySearchParams as FindAllEntitySearchParams,
1046
975
  type FindAllEventsParams as FindAllEventsParams,
1047
976
  type FindAllExtendParams as FindAllExtendParams,
1048
977
  type FindAllIngestParams as FindAllIngestParams,
@@ -1079,8 +1008,6 @@ export type FindallSchema = FindAllSchema;
1079
1008
  export type FindallSchemaUpdatedEvent = FindAllSchemaUpdatedEvent;
1080
1009
  /** @deprecated Use `IngestInput` instead. */
1081
1010
  export type FindallIngestInput = IngestInput;
1082
- /** @deprecated Use `FindAllCancelResponse` instead. */
1083
- export type FindallCancelResponse = FindAllCancelResponse;
1084
1011
  /** @deprecated Use `FindAllEventsResponse` instead. */
1085
1012
  export type FindallEventsResponse = FindAllEventsResponse;
1086
1013
  /** @deprecated Use `FindAllCreateParams` instead. */
@@ -1114,7 +1041,6 @@ export declare namespace Findall {
1114
1041
  type FindallSchema as FindallSchema,
1115
1042
  type FindallSchemaUpdatedEvent as FindallSchemaUpdatedEvent,
1116
1043
  type FindallIngestInput as FindallIngestInput,
1117
- type FindallCancelResponse as FindallCancelResponse,
1118
1044
  type FindallEventsResponse as FindallEventsResponse,
1119
1045
  type FindallCreateParams as FindallCreateParams,
1120
1046
  type FindallRetrieveParams as FindallRetrieveParams,
@@ -1127,3 +1053,45 @@ export declare namespace Findall {
1127
1053
  type FindallSchemaParams as FindallSchemaParams,
1128
1054
  };
1129
1055
  }
1056
+
1057
+ // Backwards-compat namespace members (deprecated). Previously these types
1058
+ // existed as nested interfaces under their parent's namespace; they've since
1059
+ // moved to top-level model types. Declaration merging here preserves the old
1060
+ // `Parent.Member` import paths.
1061
+ type _FindAllCandidate = FindAllCandidate;
1062
+ type _FindAllRunStatus = FindAllRunStatus;
1063
+ type _FindAllCandidateMetrics = FindAllCandidateMetrics;
1064
+ type _MatchCondition = MatchCondition;
1065
+ export namespace FindAllCandidateMatchStatusEvent {
1066
+ /** @deprecated Use the top-level `FindAllCandidate` instead. */
1067
+ export type Data = _FindAllCandidate;
1068
+ }
1069
+ export namespace FindAllCreateParams {
1070
+ /** @deprecated Use the top-level `MatchCondition` instead. */
1071
+ export type MatchCondition = _MatchCondition;
1072
+ }
1073
+ // FindAllRunInput and FindAllSchema already declare `export namespace`s above;
1074
+ // these additional `export namespace` blocks merge with them via TS declaration
1075
+ // merging, augmenting the existing namespaces with the deprecated `MatchCondition`
1076
+ // member. (`declare module` would not work here — it's for ambient module
1077
+ // augmentation, not same-file declaration merging.)
1078
+ export namespace FindAllRunInput {
1079
+ /** @deprecated Use the top-level `MatchCondition` instead. */
1080
+ export type MatchCondition = _MatchCondition;
1081
+ }
1082
+ export namespace FindAllSchema {
1083
+ /** @deprecated Use the top-level `MatchCondition` instead. */
1084
+ export type MatchCondition = _MatchCondition;
1085
+ }
1086
+ export namespace FindAllRun {
1087
+ /** @deprecated Use the top-level `FindAllRunStatus` instead. */
1088
+ export type Status = _FindAllRunStatus;
1089
+ export namespace Status {
1090
+ /** @deprecated Use the top-level `FindAllCandidateMetrics` instead. */
1091
+ export type Metrics = _FindAllCandidateMetrics;
1092
+ }
1093
+ }
1094
+ export namespace FindAllRunResult {
1095
+ /** @deprecated Use the top-level `FindAllCandidate` instead. */
1096
+ export type Candidate = _FindAllCandidate;
1097
+ }