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.
- package/CHANGELOG.md +54 -0
- package/api-promise.d.mts +1 -0
- package/api-promise.d.mts.map +1 -1
- package/api-promise.d.ts +1 -0
- package/api-promise.d.ts.map +1 -1
- package/api-promise.mjs +1 -0
- package/api-promise.mjs.map +1 -1
- package/client.d.mts +29 -8
- package/client.d.mts.map +1 -1
- package/client.d.ts +29 -8
- package/client.d.ts.map +1 -1
- package/client.js +34 -4
- package/client.js.map +1 -1
- package/client.mjs +34 -4
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.mjs.map +1 -1
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts.map +1 -1
- package/core/streaming.d.mts.map +1 -1
- package/core/streaming.d.ts.map +1 -1
- package/core/streaming.mjs.map +1 -1
- package/core/uploads.d.mts.map +1 -1
- package/core/uploads.d.ts.map +1 -1
- package/core/uploads.mjs.map +1 -1
- package/error.d.mts +1 -0
- package/error.d.mts.map +1 -1
- package/error.d.ts +1 -0
- package/error.d.ts.map +1 -1
- package/error.mjs +1 -0
- package/error.mjs.map +1 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts.map +1 -1
- package/index.mjs.map +1 -1
- package/internal/decoders/line.mjs.map +1 -1
- package/internal/detect-platform.mjs.map +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +7 -0
- package/internal/qs/formats.d.ts.map +1 -0
- package/internal/qs/formats.js +13 -0
- package/internal/qs/formats.js.map +1 -0
- package/internal/qs/formats.mjs +9 -0
- package/internal/qs/formats.mjs.map +1 -0
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts +10 -0
- package/internal/qs/index.d.ts.map +1 -0
- package/internal/qs/index.js +14 -0
- package/internal/qs/index.js.map +1 -0
- package/internal/qs/index.mjs +10 -0
- package/internal/qs/index.mjs.map +1 -0
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts +3 -0
- package/internal/qs/stringify.d.ts.map +1 -0
- package/internal/qs/stringify.js +277 -0
- package/internal/qs/stringify.js.map +1 -0
- package/internal/qs/stringify.mjs +274 -0
- package/internal/qs/stringify.mjs.map +1 -0
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/types.d.ts +57 -0
- package/internal/qs/types.d.ts.map +1 -0
- package/internal/qs/types.js +3 -0
- package/internal/qs/types.js.map +1 -0
- package/internal/qs/types.mjs +2 -0
- package/internal/qs/types.mjs.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +15 -0
- package/internal/qs/utils.d.ts.map +1 -0
- package/internal/qs/utils.js +230 -0
- package/internal/qs/utils.js.map +1 -0
- package/internal/qs/utils.mjs +217 -0
- package/internal/qs/utils.mjs.map +1 -0
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts.map +1 -1
- package/internal/shims.d.mts +6 -0
- package/internal/shims.d.mts.map +1 -1
- package/internal/shims.d.ts +6 -0
- package/internal/shims.d.ts.map +1 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.mjs.map +1 -1
- package/internal/types.d.mts +10 -10
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +10 -10
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +3 -2
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +3 -2
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/query.d.mts +0 -3
- package/internal/utils/query.d.mts.map +1 -1
- package/internal/utils/query.d.ts +0 -3
- package/internal/utils/query.d.ts.map +1 -1
- package/internal/utils/query.js +3 -16
- package/internal/utils/query.js.map +1 -1
- package/internal/utils/query.mjs +2 -16
- package/internal/utils/query.mjs.map +1 -1
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.d.mts.map +1 -1
- package/internal/utils.d.ts.map +1 -1
- package/internal/utils.mjs.map +1 -1
- package/package.json +1 -1
- package/resource.d.mts +1 -0
- package/resource.d.mts.map +1 -1
- package/resource.d.ts +1 -0
- package/resource.d.ts.map +1 -1
- package/resource.mjs +1 -0
- package/resource.mjs.map +1 -1
- package/resources/beta/beta.d.mts +2 -270
- package/resources/beta/beta.d.mts.map +1 -1
- package/resources/beta/beta.d.ts +2 -270
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/beta.js +0 -39
- package/resources/beta/beta.js.map +1 -1
- package/resources/beta/beta.mjs +0 -39
- package/resources/beta/beta.mjs.map +1 -1
- package/resources/beta/findall.d.mts +202 -247
- package/resources/beta/findall.d.mts.map +1 -1
- package/resources/beta/findall.d.ts +202 -247
- package/resources/beta/findall.d.ts.map +1 -1
- package/resources/beta/findall.js +28 -27
- package/resources/beta/findall.js.map +1 -1
- package/resources/beta/findall.mjs +28 -27
- package/resources/beta/findall.mjs.map +1 -1
- package/resources/beta/index.d.mts +1 -3
- package/resources/beta/index.d.mts.map +1 -1
- package/resources/beta/index.d.ts +1 -3
- package/resources/beta/index.d.ts.map +1 -1
- package/resources/beta/index.js +1 -5
- package/resources/beta/index.js.map +1 -1
- package/resources/beta/index.mjs +0 -2
- package/resources/beta/index.mjs.map +1 -1
- package/resources/beta.d.mts.map +1 -1
- package/resources/beta.d.ts.map +1 -1
- package/resources/beta.mjs.map +1 -1
- package/resources/index.d.mts +4 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -0
- package/resources/index.mjs.map +1 -1
- package/resources/monitor.d.mts +625 -0
- package/resources/monitor.d.mts.map +1 -0
- package/resources/monitor.d.ts +625 -0
- package/resources/monitor.d.ts.map +1 -0
- package/resources/monitor.js +140 -0
- package/resources/monitor.js.map +1 -0
- package/resources/monitor.mjs +136 -0
- package/resources/monitor.mjs.map +1 -0
- package/resources/{beta/task-group.d.mts → task-group.d.mts} +38 -68
- package/resources/task-group.d.mts.map +1 -0
- package/resources/{beta/task-group.d.ts → task-group.d.ts} +38 -68
- package/resources/task-group.d.ts.map +1 -0
- package/resources/{beta/task-group.js → task-group.js} +24 -64
- package/resources/task-group.js.map +1 -0
- package/resources/{beta/task-group.mjs → task-group.mjs} +24 -64
- package/resources/task-group.mjs.map +1 -0
- package/resources/task-run.d.mts +100 -83
- package/resources/task-run.d.mts.map +1 -1
- package/resources/task-run.d.ts +100 -83
- package/resources/task-run.d.ts.map +1 -1
- package/resources/task-run.js +14 -1
- package/resources/task-run.js.map +1 -1
- package/resources/task-run.mjs +14 -1
- package/resources/task-run.mjs.map +1 -1
- package/resources/top-level.d.mts +20 -16
- package/resources/top-level.d.mts.map +1 -1
- package/resources/top-level.d.ts +20 -16
- package/resources/top-level.d.ts.map +1 -1
- package/resources.d.mts.map +1 -1
- package/resources.d.ts.map +1 -1
- package/resources.mjs.map +1 -1
- package/src/client.ts +120 -4
- package/src/internal/qs/LICENSE.md +13 -0
- package/src/internal/qs/README.md +3 -0
- package/src/internal/qs/formats.ts +10 -0
- package/src/internal/qs/index.ts +13 -0
- package/src/internal/qs/stringify.ts +385 -0
- package/src/internal/qs/types.ts +71 -0
- package/src/internal/qs/utils.ts +265 -0
- package/src/internal/types.ts +6 -8
- package/src/internal/utils/log.ts +2 -1
- package/src/internal/utils/query.ts +2 -18
- package/src/resources/beta/api.md +9 -59
- package/src/resources/beta/beta.ts +16 -406
- package/src/resources/beta/findall.ts +252 -284
- package/src/resources/beta/index.ts +8 -30
- package/src/resources/index.ts +42 -0
- package/src/resources/monitor.ts +752 -0
- package/src/resources/{beta/task-group.ts → task-group.ts} +58 -93
- package/src/resources/task-run.ts +125 -98
- package/src/resources/top-level.ts +24 -16
- package/src/version.ts +1 -1
- package/streaming.d.mts +1 -0
- package/streaming.d.mts.map +1 -1
- package/streaming.d.ts +1 -0
- package/streaming.d.ts.map +1 -1
- package/streaming.mjs +1 -0
- package/streaming.mjs.map +1 -1
- package/uploads.d.mts +1 -0
- package/uploads.d.mts.map +1 -1
- package/uploads.d.ts +1 -0
- package/uploads.d.ts.map +1 -1
- package/uploads.mjs +1 -0
- package/uploads.mjs.map +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/beta/task-group.d.mts.map +0 -1
- package/resources/beta/task-group.d.ts.map +0 -1
- package/resources/beta/task-group.js.map +0 -1
- package/resources/beta/task-group.mjs.map +0 -1
- package/resources/beta/task-run.d.mts +0 -239
- package/resources/beta/task-run.d.mts.map +0 -1
- package/resources/beta/task-run.d.ts +0 -239
- package/resources/beta/task-run.d.ts.map +0 -1
- package/resources/beta/task-run.js +0 -81
- package/resources/beta/task-run.js.map +0 -1
- package/resources/beta/task-run.mjs +0 -77
- package/resources/beta/task-run.mjs.map +0 -1
- package/src/resources/beta/task-run.ts +0 -336
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
2
|
import * as TaskRunAPI from "../task-run.mjs";
|
|
3
|
-
import * as BetaTaskRunAPI from "./task-run.mjs";
|
|
4
3
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
5
4
|
import { Stream } from "../../core/streaming.mjs";
|
|
6
5
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
@@ -56,29 +55,10 @@ export declare class FindAll extends APIResource {
|
|
|
56
55
|
*
|
|
57
56
|
* @example
|
|
58
57
|
* ```ts
|
|
59
|
-
*
|
|
60
|
-
* 'findall_id',
|
|
61
|
-
* );
|
|
62
|
-
* ```
|
|
63
|
-
*/
|
|
64
|
-
cancel(findallID: string, params?: FindAllCancelParams | null | undefined, options?: RequestOptions): APIPromise<unknown>;
|
|
65
|
-
/**
|
|
66
|
-
* Return ranked entity candidates matching a natural language objective.
|
|
67
|
-
*
|
|
68
|
-
* This endpoint performs a best-effort search optimised for low latency. For
|
|
69
|
-
* comprehensive match evaluation and enrichment, use the
|
|
70
|
-
* [FindAll API](https://docs.parallel.ai/findall-api/findall-quickstart).
|
|
71
|
-
*
|
|
72
|
-
* @example
|
|
73
|
-
* ```ts
|
|
74
|
-
* const findallCandidatesResponse =
|
|
75
|
-
* await client.beta.findall.candidates({
|
|
76
|
-
* entity_type: 'company',
|
|
77
|
-
* objective: 'objective',
|
|
78
|
-
* });
|
|
58
|
+
* await client.beta.findall.cancel('findall_id');
|
|
79
59
|
* ```
|
|
80
60
|
*/
|
|
81
|
-
|
|
61
|
+
cancel(findallID: string, params?: FindAllCancelParams | null | undefined, options?: RequestOptions): APIPromise<void>;
|
|
82
62
|
/**
|
|
83
63
|
* Add an enrichment to a FindAll run.
|
|
84
64
|
*
|
|
@@ -100,6 +80,26 @@ export declare class FindAll extends APIResource {
|
|
|
100
80
|
* ```
|
|
101
81
|
*/
|
|
102
82
|
enrich(findallID: string, params: FindAllEnrichParams, options?: RequestOptions): APIPromise<FindAllSchema>;
|
|
83
|
+
/**
|
|
84
|
+
* Return ranked entities matching a natural language objective.
|
|
85
|
+
*
|
|
86
|
+
* This endpoint performs a best-effort search optimized for low latency. To keep
|
|
87
|
+
* responses fast, it returns a fixed set of attributes and supports queries of
|
|
88
|
+
* limited complexity.
|
|
89
|
+
*
|
|
90
|
+
* For comprehensive match evaluation and enrichment, use the
|
|
91
|
+
* [FindAll API](https://docs.parallel.ai/findall-api/findall-quickstart).
|
|
92
|
+
*
|
|
93
|
+
* @example
|
|
94
|
+
* ```ts
|
|
95
|
+
* const findallEntitySearchResponse =
|
|
96
|
+
* await client.beta.findall.entitySearch({
|
|
97
|
+
* entity_type: 'people',
|
|
98
|
+
* objective: 'objective',
|
|
99
|
+
* });
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
entitySearch(body: FindAllEntitySearchParams, options?: RequestOptions): APIPromise<FindAllEntitySearchResponse>;
|
|
103
103
|
/**
|
|
104
104
|
* Stream events from a FindAll run.
|
|
105
105
|
*
|
|
@@ -168,6 +168,47 @@ export declare class FindAll extends APIResource {
|
|
|
168
168
|
*/
|
|
169
169
|
schema(findallID: string, params?: FindAllSchemaParams | null | undefined, options?: RequestOptions): APIPromise<FindAllSchema>;
|
|
170
170
|
}
|
|
171
|
+
/**
|
|
172
|
+
* Candidate for a find all run that may end up as a match.
|
|
173
|
+
*
|
|
174
|
+
* Contains all the candidate's metadata and the output of the match conditions. A
|
|
175
|
+
* candidate is a match if all match conditions are satisfied.
|
|
176
|
+
*/
|
|
177
|
+
export interface FindAllCandidate {
|
|
178
|
+
/**
|
|
179
|
+
* ID of the candidate.
|
|
180
|
+
*/
|
|
181
|
+
candidate_id: string;
|
|
182
|
+
/**
|
|
183
|
+
* Status of the candidate. One of generated, matched, unmatched, discarded.
|
|
184
|
+
*/
|
|
185
|
+
match_status: 'generated' | 'matched' | 'unmatched' | 'discarded';
|
|
186
|
+
/**
|
|
187
|
+
* Name of the candidate.
|
|
188
|
+
*/
|
|
189
|
+
name: string;
|
|
190
|
+
/**
|
|
191
|
+
* URL that provides context or details of the entity for disambiguation.
|
|
192
|
+
*/
|
|
193
|
+
url: string;
|
|
194
|
+
/**
|
|
195
|
+
* List of FieldBasis objects supporting the output.
|
|
196
|
+
*/
|
|
197
|
+
basis?: Array<TaskRunAPI.FieldBasis> | null;
|
|
198
|
+
/**
|
|
199
|
+
* Brief description of the entity that can help answer whether entity satisfies
|
|
200
|
+
* the query.
|
|
201
|
+
*/
|
|
202
|
+
description?: string | null;
|
|
203
|
+
/**
|
|
204
|
+
* Results of the match condition evaluations for this candidate. This object
|
|
205
|
+
* contains the structured output that determines whether the candidate matches the
|
|
206
|
+
* overall FindAll objective.
|
|
207
|
+
*/
|
|
208
|
+
output?: {
|
|
209
|
+
[key: string]: unknown;
|
|
210
|
+
} | null;
|
|
211
|
+
}
|
|
171
212
|
/**
|
|
172
213
|
* Event containing a candidate whose match status has changed.
|
|
173
214
|
*/
|
|
@@ -175,7 +216,7 @@ export interface FindAllCandidateMatchStatusEvent {
|
|
|
175
216
|
/**
|
|
176
217
|
* The candidate whose match status has been updated.
|
|
177
218
|
*/
|
|
178
|
-
data:
|
|
219
|
+
data: FindAllCandidate;
|
|
179
220
|
/**
|
|
180
221
|
* Unique event identifier for the event.
|
|
181
222
|
*/
|
|
@@ -191,74 +232,63 @@ export interface FindAllCandidateMatchStatusEvent {
|
|
|
191
232
|
*/
|
|
192
233
|
type: 'findall.candidate.generated' | 'findall.candidate.matched' | 'findall.candidate.unmatched' | 'findall.candidate.discarded' | 'findall.candidate.enriched';
|
|
193
234
|
}
|
|
194
|
-
|
|
235
|
+
/**
|
|
236
|
+
* Metrics object for FindAll run.
|
|
237
|
+
*/
|
|
238
|
+
export interface FindAllCandidateMetrics {
|
|
195
239
|
/**
|
|
196
|
-
*
|
|
240
|
+
* Number of candidates that were selected.
|
|
197
241
|
*/
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
* Brief description of the entity that can help answer whether entity satisfies
|
|
221
|
-
* the query.
|
|
222
|
-
*/
|
|
223
|
-
description?: string | null;
|
|
224
|
-
/**
|
|
225
|
-
* Results of the match condition evaluations for this candidate. This object
|
|
226
|
-
* contains the structured output that determines whether the candidate matches the
|
|
227
|
-
* overall FindAll objective.
|
|
228
|
-
*/
|
|
229
|
-
output?: {
|
|
230
|
-
[key: string]: unknown;
|
|
231
|
-
} | null;
|
|
232
|
-
}
|
|
242
|
+
generated_candidates_count?: number;
|
|
243
|
+
/**
|
|
244
|
+
* Number of candidates that evaluated to matched.
|
|
245
|
+
*/
|
|
246
|
+
matched_candidates_count?: number;
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* Input model for FindAll enrich.
|
|
250
|
+
*/
|
|
251
|
+
export interface FindAllEnrichInput {
|
|
252
|
+
/**
|
|
253
|
+
* JSON schema for the enrichment output schema for the FindAll run.
|
|
254
|
+
*/
|
|
255
|
+
output_schema: TaskRunAPI.JsonSchema;
|
|
256
|
+
/**
|
|
257
|
+
* List of MCP servers to use for the task.
|
|
258
|
+
*/
|
|
259
|
+
mcp_servers?: Array<TaskRunAPI.McpServer> | null;
|
|
260
|
+
/**
|
|
261
|
+
* Processor to use for the task.
|
|
262
|
+
*/
|
|
263
|
+
processor?: string;
|
|
233
264
|
}
|
|
234
|
-
export interface
|
|
265
|
+
export interface FindAllEntitySearchRequest {
|
|
235
266
|
/**
|
|
236
267
|
* Type of entity to search for.
|
|
237
268
|
*/
|
|
238
|
-
entity_type: '
|
|
269
|
+
entity_type: 'people' | 'companies';
|
|
239
270
|
/**
|
|
240
271
|
* Natural language description of target entities.
|
|
241
272
|
*/
|
|
242
273
|
objective: string;
|
|
243
274
|
/**
|
|
244
|
-
* Maximum number of
|
|
275
|
+
* Maximum number of entities to return. Must be between 5 and 1000 (inclusive).
|
|
245
276
|
* May return fewer results. Defaults to 100.
|
|
246
277
|
*/
|
|
247
278
|
match_limit?: number;
|
|
248
279
|
}
|
|
249
|
-
export interface
|
|
280
|
+
export interface FindAllEntitySearchResponse {
|
|
250
281
|
/**
|
|
251
|
-
*
|
|
252
|
-
* `candidate_set_cad0a6d2dec046bd95ae900527d880e7`
|
|
282
|
+
* Ranked list of entities.
|
|
253
283
|
*/
|
|
254
|
-
|
|
284
|
+
entities: Array<FindAllEntitySearchResponse.Entity>;
|
|
255
285
|
/**
|
|
256
|
-
*
|
|
286
|
+
* Entity set request ID. Example: `entity_set_cad0a6d2dec046bd95ae900527d880e7`
|
|
257
287
|
*/
|
|
258
|
-
|
|
288
|
+
entity_set_id: string;
|
|
259
289
|
}
|
|
260
|
-
export declare namespace
|
|
261
|
-
interface
|
|
290
|
+
export declare namespace FindAllEntitySearchResponse {
|
|
291
|
+
interface Entity {
|
|
262
292
|
/**
|
|
263
293
|
* Descriptive text about the entity.
|
|
264
294
|
*/
|
|
@@ -273,23 +303,6 @@ export declare namespace FindAllCandidatesResponse {
|
|
|
273
303
|
url: string;
|
|
274
304
|
}
|
|
275
305
|
}
|
|
276
|
-
/**
|
|
277
|
-
* Input model for FindAll enrich.
|
|
278
|
-
*/
|
|
279
|
-
export interface FindAllEnrichInput {
|
|
280
|
-
/**
|
|
281
|
-
* JSON schema for the enrichment output schema for the FindAll run.
|
|
282
|
-
*/
|
|
283
|
-
output_schema: TaskRunAPI.JsonSchema;
|
|
284
|
-
/**
|
|
285
|
-
* List of MCP servers to use for the task.
|
|
286
|
-
*/
|
|
287
|
-
mcp_servers?: Array<TaskRunAPI.McpServer> | null;
|
|
288
|
-
/**
|
|
289
|
-
* Processor to use for the task.
|
|
290
|
-
*/
|
|
291
|
-
processor?: string;
|
|
292
|
-
}
|
|
293
306
|
/**
|
|
294
307
|
* Input model for FindAll extend.
|
|
295
308
|
*/
|
|
@@ -316,7 +329,7 @@ export interface FindAllRun {
|
|
|
316
329
|
/**
|
|
317
330
|
* Status object for the FindAll run.
|
|
318
331
|
*/
|
|
319
|
-
status:
|
|
332
|
+
status: FindAllRunStatus;
|
|
320
333
|
/**
|
|
321
334
|
* Timestamp of the creation of the run, in RFC 3339 format.
|
|
322
335
|
*/
|
|
@@ -333,44 +346,6 @@ export interface FindAllRun {
|
|
|
333
346
|
*/
|
|
334
347
|
modified_at?: string | null;
|
|
335
348
|
}
|
|
336
|
-
export declare namespace FindAllRun {
|
|
337
|
-
/**
|
|
338
|
-
* Status object for the FindAll run.
|
|
339
|
-
*/
|
|
340
|
-
interface Status {
|
|
341
|
-
/**
|
|
342
|
-
* Whether the FindAll run is active
|
|
343
|
-
*/
|
|
344
|
-
is_active: boolean;
|
|
345
|
-
/**
|
|
346
|
-
* Candidate metrics for the FindAll run.
|
|
347
|
-
*/
|
|
348
|
-
metrics: Status.Metrics;
|
|
349
|
-
/**
|
|
350
|
-
* Status of the FindAll run.
|
|
351
|
-
*/
|
|
352
|
-
status: 'queued' | 'action_required' | 'running' | 'completed' | 'failed' | 'cancelling' | 'cancelled';
|
|
353
|
-
/**
|
|
354
|
-
* Reason for termination when FindAll run is in terminal status.
|
|
355
|
-
*/
|
|
356
|
-
termination_reason?: 'low_match_rate' | 'match_limit_met' | 'candidates_exhausted' | 'user_cancelled' | 'error_occurred' | 'timeout' | 'insufficient_funds' | null;
|
|
357
|
-
}
|
|
358
|
-
namespace Status {
|
|
359
|
-
/**
|
|
360
|
-
* Candidate metrics for the FindAll run.
|
|
361
|
-
*/
|
|
362
|
-
interface Metrics {
|
|
363
|
-
/**
|
|
364
|
-
* Number of candidates that were selected.
|
|
365
|
-
*/
|
|
366
|
-
generated_candidates_count?: number;
|
|
367
|
-
/**
|
|
368
|
-
* Number of candidates that evaluated to matched.
|
|
369
|
-
*/
|
|
370
|
-
matched_candidates_count?: number;
|
|
371
|
-
}
|
|
372
|
-
}
|
|
373
|
-
}
|
|
374
349
|
/**
|
|
375
350
|
* Input model for FindAll run.
|
|
376
351
|
*/
|
|
@@ -386,7 +361,7 @@ export interface FindAllRunInput {
|
|
|
386
361
|
/**
|
|
387
362
|
* List of match conditions for the FindAll run.
|
|
388
363
|
*/
|
|
389
|
-
match_conditions: Array<
|
|
364
|
+
match_conditions: Array<MatchCondition>;
|
|
390
365
|
/**
|
|
391
366
|
* Maximum number of matches to find for this FindAll run. Must be between 5 and
|
|
392
367
|
* 1000 (inclusive). May return fewer results.
|
|
@@ -412,21 +387,6 @@ export interface FindAllRunInput {
|
|
|
412
387
|
webhook?: TaskRunAPI.Webhook | null;
|
|
413
388
|
}
|
|
414
389
|
export declare namespace FindAllRunInput {
|
|
415
|
-
/**
|
|
416
|
-
* Match condition model for FindAll ingest.
|
|
417
|
-
*/
|
|
418
|
-
interface MatchCondition {
|
|
419
|
-
/**
|
|
420
|
-
* Detailed description of the match condition. Include as much specific
|
|
421
|
-
* information as possible to help improve the quality and accuracy of Find All run
|
|
422
|
-
* results.
|
|
423
|
-
*/
|
|
424
|
-
description: string;
|
|
425
|
-
/**
|
|
426
|
-
* Name of the match condition.
|
|
427
|
-
*/
|
|
428
|
-
name: string;
|
|
429
|
-
}
|
|
430
390
|
/**
|
|
431
391
|
* Exclude candidate input model for FindAll run.
|
|
432
392
|
*/
|
|
@@ -452,7 +412,7 @@ export interface FindAllRunResult {
|
|
|
452
412
|
/**
|
|
453
413
|
* All evaluated candidates at the time of the snapshot.
|
|
454
414
|
*/
|
|
455
|
-
candidates: Array<
|
|
415
|
+
candidates: Array<FindAllCandidate>;
|
|
456
416
|
/**
|
|
457
417
|
* FindAll run object.
|
|
458
418
|
*/
|
|
@@ -463,48 +423,26 @@ export interface FindAllRunResult {
|
|
|
463
423
|
*/
|
|
464
424
|
last_event_id?: string | null;
|
|
465
425
|
}
|
|
466
|
-
|
|
426
|
+
/**
|
|
427
|
+
* Status object for FindAll run.
|
|
428
|
+
*/
|
|
429
|
+
export interface FindAllRunStatus {
|
|
467
430
|
/**
|
|
468
|
-
*
|
|
469
|
-
*
|
|
470
|
-
* Contains all the candidate's metadata and the output of the match conditions. A
|
|
471
|
-
* candidate is a match if all match conditions are satisfied.
|
|
431
|
+
* Whether the FindAll run is active
|
|
472
432
|
*/
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
/**
|
|
487
|
-
* URL that provides context or details of the entity for disambiguation.
|
|
488
|
-
*/
|
|
489
|
-
url: string;
|
|
490
|
-
/**
|
|
491
|
-
* List of FieldBasis objects supporting the output.
|
|
492
|
-
*/
|
|
493
|
-
basis?: Array<TaskRunAPI.FieldBasis> | null;
|
|
494
|
-
/**
|
|
495
|
-
* Brief description of the entity that can help answer whether entity satisfies
|
|
496
|
-
* the query.
|
|
497
|
-
*/
|
|
498
|
-
description?: string | null;
|
|
499
|
-
/**
|
|
500
|
-
* Results of the match condition evaluations for this candidate. This object
|
|
501
|
-
* contains the structured output that determines whether the candidate matches the
|
|
502
|
-
* overall FindAll objective.
|
|
503
|
-
*/
|
|
504
|
-
output?: {
|
|
505
|
-
[key: string]: unknown;
|
|
506
|
-
} | null;
|
|
507
|
-
}
|
|
433
|
+
is_active: boolean;
|
|
434
|
+
/**
|
|
435
|
+
* Candidate metrics for the FindAll run.
|
|
436
|
+
*/
|
|
437
|
+
metrics: FindAllCandidateMetrics;
|
|
438
|
+
/**
|
|
439
|
+
* Status of the FindAll run.
|
|
440
|
+
*/
|
|
441
|
+
status: 'queued' | 'action_required' | 'running' | 'completed' | 'failed' | 'cancelling' | 'cancelled';
|
|
442
|
+
/**
|
|
443
|
+
* Reason for termination when FindAll run is in terminal status.
|
|
444
|
+
*/
|
|
445
|
+
termination_reason?: 'low_match_rate' | 'match_limit_met' | 'candidates_exhausted' | 'user_cancelled' | 'error_occurred' | 'timeout' | 'insufficient_funds' | null;
|
|
508
446
|
}
|
|
509
447
|
/**
|
|
510
448
|
* Event containing status update for FindAll run.
|
|
@@ -538,7 +476,7 @@ export interface FindAllSchema {
|
|
|
538
476
|
/**
|
|
539
477
|
* List of match conditions for the FindAll run.
|
|
540
478
|
*/
|
|
541
|
-
match_conditions: Array<
|
|
479
|
+
match_conditions: Array<MatchCondition>;
|
|
542
480
|
/**
|
|
543
481
|
* Natural language objective of the FindAll run.
|
|
544
482
|
*/
|
|
@@ -556,23 +494,6 @@ export interface FindAllSchema {
|
|
|
556
494
|
*/
|
|
557
495
|
match_limit?: number | null;
|
|
558
496
|
}
|
|
559
|
-
export declare namespace FindAllSchema {
|
|
560
|
-
/**
|
|
561
|
-
* Match condition model for FindAll ingest.
|
|
562
|
-
*/
|
|
563
|
-
interface MatchCondition {
|
|
564
|
-
/**
|
|
565
|
-
* Detailed description of the match condition. Include as much specific
|
|
566
|
-
* information as possible to help improve the quality and accuracy of Find All run
|
|
567
|
-
* results.
|
|
568
|
-
*/
|
|
569
|
-
description: string;
|
|
570
|
-
/**
|
|
571
|
-
* Name of the match condition.
|
|
572
|
-
*/
|
|
573
|
-
name: string;
|
|
574
|
-
}
|
|
575
|
-
}
|
|
576
497
|
/**
|
|
577
498
|
* Event containing full snapshot of FindAll run state.
|
|
578
499
|
*/
|
|
@@ -603,7 +524,25 @@ export interface IngestInput {
|
|
|
603
524
|
*/
|
|
604
525
|
objective: string;
|
|
605
526
|
}
|
|
606
|
-
|
|
527
|
+
/**
|
|
528
|
+
* Match condition model for FindAll ingest.
|
|
529
|
+
*/
|
|
530
|
+
export interface MatchCondition {
|
|
531
|
+
/**
|
|
532
|
+
* Detailed description of the match condition. Include as much specific
|
|
533
|
+
* information as possible to help improve the quality and accuracy of Find All run
|
|
534
|
+
* results.
|
|
535
|
+
*/
|
|
536
|
+
description: string;
|
|
537
|
+
/**
|
|
538
|
+
* Name of the match condition.
|
|
539
|
+
*/
|
|
540
|
+
name: string;
|
|
541
|
+
}
|
|
542
|
+
/**
|
|
543
|
+
* Model for the parallel-beta header.
|
|
544
|
+
*/
|
|
545
|
+
export type ParallelBeta = 'mcp-server-2025-07-17' | 'events-sse-2025-07-24' | 'webhook-2025-08-12' | 'findall-2025-09-15' | 'search-extract-2025-10-10' | 'field-basis-2025-11-25' | (string & {});
|
|
607
546
|
/**
|
|
608
547
|
* Event containing full snapshot of FindAll run state.
|
|
609
548
|
*/
|
|
@@ -620,7 +559,7 @@ export interface FindAllCreateParams {
|
|
|
620
559
|
/**
|
|
621
560
|
* Body param: List of match conditions for the FindAll run.
|
|
622
561
|
*/
|
|
623
|
-
match_conditions: Array<
|
|
562
|
+
match_conditions: Array<MatchCondition>;
|
|
624
563
|
/**
|
|
625
564
|
* Body param: Maximum number of matches to find for this FindAll run. Must be
|
|
626
565
|
* between 5 and 1000 (inclusive). May return fewer results.
|
|
@@ -647,24 +586,9 @@ export interface FindAllCreateParams {
|
|
|
647
586
|
/**
|
|
648
587
|
* Header param: Optional header to specify the beta version(s) to enable.
|
|
649
588
|
*/
|
|
650
|
-
betas?: Array<
|
|
589
|
+
betas?: Array<ParallelBeta>;
|
|
651
590
|
}
|
|
652
591
|
export declare namespace FindAllCreateParams {
|
|
653
|
-
/**
|
|
654
|
-
* Match condition model for FindAll ingest.
|
|
655
|
-
*/
|
|
656
|
-
interface MatchCondition {
|
|
657
|
-
/**
|
|
658
|
-
* Detailed description of the match condition. Include as much specific
|
|
659
|
-
* information as possible to help improve the quality and accuracy of Find All run
|
|
660
|
-
* results.
|
|
661
|
-
*/
|
|
662
|
-
description: string;
|
|
663
|
-
/**
|
|
664
|
-
* Name of the match condition.
|
|
665
|
-
*/
|
|
666
|
-
name: string;
|
|
667
|
-
}
|
|
668
592
|
/**
|
|
669
593
|
* Exclude candidate input model for FindAll run.
|
|
670
594
|
*/
|
|
@@ -683,28 +607,13 @@ export interface FindAllRetrieveParams {
|
|
|
683
607
|
/**
|
|
684
608
|
* Optional header to specify the beta version(s) to enable.
|
|
685
609
|
*/
|
|
686
|
-
betas?: Array<
|
|
610
|
+
betas?: Array<ParallelBeta>;
|
|
687
611
|
}
|
|
688
612
|
export interface FindAllCancelParams {
|
|
689
613
|
/**
|
|
690
614
|
* Optional header to specify the beta version(s) to enable.
|
|
691
615
|
*/
|
|
692
|
-
betas?: Array<
|
|
693
|
-
}
|
|
694
|
-
export interface FindAllCandidatesParams {
|
|
695
|
-
/**
|
|
696
|
-
* Type of entity to search for.
|
|
697
|
-
*/
|
|
698
|
-
entity_type: 'company' | 'people';
|
|
699
|
-
/**
|
|
700
|
-
* Natural language description of target entities.
|
|
701
|
-
*/
|
|
702
|
-
objective: string;
|
|
703
|
-
/**
|
|
704
|
-
* Maximum number of candidates to return. Must be between 5 and 1000 (inclusive).
|
|
705
|
-
* May return fewer results. Defaults to 100.
|
|
706
|
-
*/
|
|
707
|
-
match_limit?: number;
|
|
616
|
+
betas?: Array<ParallelBeta>;
|
|
708
617
|
}
|
|
709
618
|
export interface FindAllEnrichParams {
|
|
710
619
|
/**
|
|
@@ -722,7 +631,22 @@ export interface FindAllEnrichParams {
|
|
|
722
631
|
/**
|
|
723
632
|
* Header param: Optional header to specify the beta version(s) to enable.
|
|
724
633
|
*/
|
|
725
|
-
betas?: Array<
|
|
634
|
+
betas?: Array<ParallelBeta>;
|
|
635
|
+
}
|
|
636
|
+
export interface FindAllEntitySearchParams {
|
|
637
|
+
/**
|
|
638
|
+
* Type of entity to search for.
|
|
639
|
+
*/
|
|
640
|
+
entity_type: 'people' | 'companies';
|
|
641
|
+
/**
|
|
642
|
+
* Natural language description of target entities.
|
|
643
|
+
*/
|
|
644
|
+
objective: string;
|
|
645
|
+
/**
|
|
646
|
+
* Maximum number of entities to return. Must be between 5 and 1000 (inclusive).
|
|
647
|
+
* May return fewer results. Defaults to 100.
|
|
648
|
+
*/
|
|
649
|
+
match_limit?: number;
|
|
726
650
|
}
|
|
727
651
|
export interface FindAllEventsParams {
|
|
728
652
|
/**
|
|
@@ -736,7 +660,7 @@ export interface FindAllEventsParams {
|
|
|
736
660
|
/**
|
|
737
661
|
* Header param: Optional header to specify the beta version(s) to enable.
|
|
738
662
|
*/
|
|
739
|
-
betas?: Array<
|
|
663
|
+
betas?: Array<ParallelBeta>;
|
|
740
664
|
}
|
|
741
665
|
export interface FindAllExtendParams {
|
|
742
666
|
/**
|
|
@@ -748,7 +672,7 @@ export interface FindAllExtendParams {
|
|
|
748
672
|
/**
|
|
749
673
|
* Header param: Optional header to specify the beta version(s) to enable.
|
|
750
674
|
*/
|
|
751
|
-
betas?: Array<
|
|
675
|
+
betas?: Array<ParallelBeta>;
|
|
752
676
|
}
|
|
753
677
|
export interface FindAllIngestParams {
|
|
754
678
|
/**
|
|
@@ -758,22 +682,22 @@ export interface FindAllIngestParams {
|
|
|
758
682
|
/**
|
|
759
683
|
* Header param: Optional header to specify the beta version(s) to enable.
|
|
760
684
|
*/
|
|
761
|
-
betas?: Array<
|
|
685
|
+
betas?: Array<ParallelBeta>;
|
|
762
686
|
}
|
|
763
687
|
export interface FindAllResultParams {
|
|
764
688
|
/**
|
|
765
689
|
* Optional header to specify the beta version(s) to enable.
|
|
766
690
|
*/
|
|
767
|
-
betas?: Array<
|
|
691
|
+
betas?: Array<ParallelBeta>;
|
|
768
692
|
}
|
|
769
693
|
export interface FindAllSchemaParams {
|
|
770
694
|
/**
|
|
771
695
|
* Optional header to specify the beta version(s) to enable.
|
|
772
696
|
*/
|
|
773
|
-
betas?: Array<
|
|
697
|
+
betas?: Array<ParallelBeta>;
|
|
774
698
|
}
|
|
775
699
|
export declare namespace FindAll {
|
|
776
|
-
export { type
|
|
700
|
+
export { type FindAllCandidate as FindAllCandidate, type FindAllCandidateMatchStatusEvent as FindAllCandidateMatchStatusEvent, type FindAllCandidateMetrics as FindAllCandidateMetrics, type FindAllEnrichInput as FindAllEnrichInput, type FindAllEntitySearchRequest as FindAllEntitySearchRequest, type FindAllEntitySearchResponse as FindAllEntitySearchResponse, type FindAllExtendInput as FindAllExtendInput, type FindAllRun as FindAllRun, type FindAllRunInput as FindAllRunInput, type FindAllRunResult as FindAllRunResult, type FindAllRunStatus as FindAllRunStatus, type FindAllRunStatusEvent as FindAllRunStatusEvent, type FindAllSchema as FindAllSchema, type FindAllSchemaUpdatedEvent as FindAllSchemaUpdatedEvent, type IngestInput as IngestInput, type MatchCondition as MatchCondition, type ParallelBeta as ParallelBeta, type FindAllEventsResponse as FindAllEventsResponse, type FindAllCreateParams as FindAllCreateParams, type FindAllRetrieveParams as FindAllRetrieveParams, type FindAllCancelParams as FindAllCancelParams, type FindAllEnrichParams as FindAllEnrichParams, type FindAllEntitySearchParams as FindAllEntitySearchParams, type FindAllEventsParams as FindAllEventsParams, type FindAllExtendParams as FindAllExtendParams, type FindAllIngestParams as FindAllIngestParams, type FindAllResultParams as FindAllResultParams, type FindAllSchemaParams as FindAllSchemaParams, };
|
|
777
701
|
}
|
|
778
702
|
/**
|
|
779
703
|
* Backwards-compatible aliases (deprecated).
|
|
@@ -803,8 +727,6 @@ export type FindallSchema = FindAllSchema;
|
|
|
803
727
|
export type FindallSchemaUpdatedEvent = FindAllSchemaUpdatedEvent;
|
|
804
728
|
/** @deprecated Use `IngestInput` instead. */
|
|
805
729
|
export type FindallIngestInput = IngestInput;
|
|
806
|
-
/** @deprecated Use `FindAllCancelResponse` instead. */
|
|
807
|
-
export type FindallCancelResponse = FindAllCancelResponse;
|
|
808
730
|
/** @deprecated Use `FindAllEventsResponse` instead. */
|
|
809
731
|
export type FindallEventsResponse = FindAllEventsResponse;
|
|
810
732
|
/** @deprecated Use `FindAllCreateParams` instead. */
|
|
@@ -826,6 +748,39 @@ export type FindallResultParams = FindAllResultParams;
|
|
|
826
748
|
/** @deprecated Use `FindAllSchemaParams` instead. */
|
|
827
749
|
export type FindallSchemaParams = FindAllSchemaParams;
|
|
828
750
|
export declare namespace Findall {
|
|
829
|
-
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
|
|
751
|
+
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 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, };
|
|
752
|
+
}
|
|
753
|
+
type _FindAllCandidate = FindAllCandidate;
|
|
754
|
+
type _FindAllRunStatus = FindAllRunStatus;
|
|
755
|
+
type _FindAllCandidateMetrics = FindAllCandidateMetrics;
|
|
756
|
+
type _MatchCondition = MatchCondition;
|
|
757
|
+
export declare namespace FindAllCandidateMatchStatusEvent {
|
|
758
|
+
/** @deprecated Use the top-level `FindAllCandidate` instead. */
|
|
759
|
+
type Data = _FindAllCandidate;
|
|
760
|
+
}
|
|
761
|
+
export declare namespace FindAllCreateParams {
|
|
762
|
+
/** @deprecated Use the top-level `MatchCondition` instead. */
|
|
763
|
+
type MatchCondition = _MatchCondition;
|
|
764
|
+
}
|
|
765
|
+
export declare namespace FindAllRunInput {
|
|
766
|
+
/** @deprecated Use the top-level `MatchCondition` instead. */
|
|
767
|
+
type MatchCondition = _MatchCondition;
|
|
768
|
+
}
|
|
769
|
+
export declare namespace FindAllSchema {
|
|
770
|
+
/** @deprecated Use the top-level `MatchCondition` instead. */
|
|
771
|
+
type MatchCondition = _MatchCondition;
|
|
772
|
+
}
|
|
773
|
+
export declare namespace FindAllRun {
|
|
774
|
+
/** @deprecated Use the top-level `FindAllRunStatus` instead. */
|
|
775
|
+
type Status = _FindAllRunStatus;
|
|
776
|
+
namespace Status {
|
|
777
|
+
/** @deprecated Use the top-level `FindAllCandidateMetrics` instead. */
|
|
778
|
+
type Metrics = _FindAllCandidateMetrics;
|
|
779
|
+
}
|
|
780
|
+
}
|
|
781
|
+
export declare namespace FindAllRunResult {
|
|
782
|
+
/** @deprecated Use the top-level `FindAllCandidate` instead. */
|
|
783
|
+
type Candidate = _FindAllCandidate;
|
|
830
784
|
}
|
|
785
|
+
export {};
|
|
831
786
|
//# sourceMappingURL=findall.d.mts.map
|