exa-js 1.8.11 → 1.8.13
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/dist/index.d.mts +947 -189
- package/dist/index.d.ts +947 -189
- package/dist/index.js +325 -160
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +318 -158
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -55,6 +55,22 @@ declare class WebsetsBaseClient {
|
|
|
55
55
|
|
|
56
56
|
interface components$1 {
|
|
57
57
|
schemas: {
|
|
58
|
+
/** Article */
|
|
59
|
+
ArticleEntity: {
|
|
60
|
+
/**
|
|
61
|
+
* @default article
|
|
62
|
+
* @constant
|
|
63
|
+
*/
|
|
64
|
+
type: "article";
|
|
65
|
+
};
|
|
66
|
+
/** Company */
|
|
67
|
+
CompanyEntity: {
|
|
68
|
+
/**
|
|
69
|
+
* @default company
|
|
70
|
+
* @constant
|
|
71
|
+
*/
|
|
72
|
+
type: "company";
|
|
73
|
+
};
|
|
58
74
|
CreateCriterionParameters: {
|
|
59
75
|
/** @description The description of the criterion */
|
|
60
76
|
description: string;
|
|
@@ -79,9 +95,119 @@ interface components$1 {
|
|
|
79
95
|
label: string;
|
|
80
96
|
}[];
|
|
81
97
|
};
|
|
98
|
+
CreateImportParameters: {
|
|
99
|
+
/** @description The number of records to import */
|
|
100
|
+
count: number;
|
|
101
|
+
/** @description When format is `csv`, these are the specific import parameters. */
|
|
102
|
+
csv?: {
|
|
103
|
+
/** @description Column containing the key identifier for the entity (e.g. URL, Name, etc.). If not provided, we will try to infer it from the file. */
|
|
104
|
+
identifier?: number;
|
|
105
|
+
};
|
|
106
|
+
/** @description What type of entity the import contains (e.g. People, Companies, etc.), and thus should be attempted to be resolved as. */
|
|
107
|
+
entity: components$1["schemas"]["CompanyEntity"] | components$1["schemas"]["PersonEntity"] | components$1["schemas"]["ArticleEntity"] | components$1["schemas"]["ResearchPaperEntity"] | components$1["schemas"]["CustomEntity"];
|
|
108
|
+
/**
|
|
109
|
+
* @description When the import is in CSV format, we expect a column containing the key identifier for the entity - for now URL. If not provided, import will fail to be processed.
|
|
110
|
+
* @enum {string}
|
|
111
|
+
*/
|
|
112
|
+
format: CreateImportParametersFormat;
|
|
113
|
+
/** @description Set of key-value pairs you want to associate with this object. */
|
|
114
|
+
metadata?: {
|
|
115
|
+
[key: string]: string;
|
|
116
|
+
};
|
|
117
|
+
/** @description The size of the file in megabytes. Maximum size is 50 MB. */
|
|
118
|
+
size: number;
|
|
119
|
+
/** @description The title of the import */
|
|
120
|
+
title?: string;
|
|
121
|
+
};
|
|
122
|
+
/** @description The response to a successful import. Includes the upload URL and the upload valid until date. */
|
|
123
|
+
CreateImportResponse: {
|
|
124
|
+
/** @description The number of entities in the import */
|
|
125
|
+
count: number;
|
|
126
|
+
/**
|
|
127
|
+
* Format: date-time
|
|
128
|
+
* @description When the import was created
|
|
129
|
+
*/
|
|
130
|
+
createdAt: string;
|
|
131
|
+
/** @description The type of entity the import contains. */
|
|
132
|
+
entity: components$1["schemas"]["Entity"];
|
|
133
|
+
/**
|
|
134
|
+
* Format: date-time
|
|
135
|
+
* @description When the import failed
|
|
136
|
+
*/
|
|
137
|
+
failedAt: string | null;
|
|
138
|
+
/** @description A human readable message of the import failure */
|
|
139
|
+
failedMessage: string | null;
|
|
140
|
+
/**
|
|
141
|
+
* @description The reason the import failed
|
|
142
|
+
* @enum {string|null}
|
|
143
|
+
*/
|
|
144
|
+
failedReason: CreateImportResponseFailedReason;
|
|
145
|
+
/**
|
|
146
|
+
* @description The format of the import.
|
|
147
|
+
* @enum {string}
|
|
148
|
+
*/
|
|
149
|
+
format: CreateImportResponseFormat;
|
|
150
|
+
/** @description The unique identifier for the Import */
|
|
151
|
+
id: string;
|
|
152
|
+
/** @description Set of key-value pairs you want to associate with this object. */
|
|
153
|
+
metadata: {
|
|
154
|
+
[key: string]: string;
|
|
155
|
+
};
|
|
156
|
+
/**
|
|
157
|
+
* @description The type of object
|
|
158
|
+
* @enum {string}
|
|
159
|
+
*/
|
|
160
|
+
object: CreateImportResponseObject;
|
|
161
|
+
/**
|
|
162
|
+
* @description The status of the Import
|
|
163
|
+
* @enum {string}
|
|
164
|
+
*/
|
|
165
|
+
status: CreateImportResponseStatus;
|
|
166
|
+
/** @description The title of the import */
|
|
167
|
+
title: string;
|
|
168
|
+
/**
|
|
169
|
+
* Format: date-time
|
|
170
|
+
* @description When the import was last updated
|
|
171
|
+
*/
|
|
172
|
+
updatedAt: string;
|
|
173
|
+
/** @description The URL to upload the file to */
|
|
174
|
+
uploadUrl: string;
|
|
175
|
+
/** @description The date and time until the upload URL is valid. The upload URL will be valid for 1 hour. */
|
|
176
|
+
uploadValidUntil: string;
|
|
177
|
+
};
|
|
82
178
|
CreateMonitorParameters: {
|
|
83
179
|
/** @description Behavior to perform when monitor runs */
|
|
84
|
-
behavior:
|
|
180
|
+
behavior: {
|
|
181
|
+
/** @description Specify the search parameters for the Monitor.
|
|
182
|
+
*
|
|
183
|
+
* By default, the search parameters (query, entity and criteria) from the last search are used when no parameters are provided. */
|
|
184
|
+
config: {
|
|
185
|
+
/**
|
|
186
|
+
* @description The behaviour of the Search when it is added to a Webset.
|
|
187
|
+
* @default append
|
|
188
|
+
* @enum {string}
|
|
189
|
+
*/
|
|
190
|
+
behavior: WebsetSearchBehavior;
|
|
191
|
+
/** @description The maximum number of results to find */
|
|
192
|
+
count: number;
|
|
193
|
+
/** @description The criteria to search for. By default, the criteria from the last search is used. */
|
|
194
|
+
criteria?: {
|
|
195
|
+
description: string;
|
|
196
|
+
}[];
|
|
197
|
+
/**
|
|
198
|
+
* Entity
|
|
199
|
+
* @description The entity to search for. By default, the entity from the last search/import is used.
|
|
200
|
+
*/
|
|
201
|
+
entity?: components$1["schemas"]["Entity"];
|
|
202
|
+
/** @description The query to search for. By default, the query from the last search is used. */
|
|
203
|
+
query?: string;
|
|
204
|
+
};
|
|
205
|
+
/**
|
|
206
|
+
* @default search
|
|
207
|
+
* @constant
|
|
208
|
+
*/
|
|
209
|
+
type: "search";
|
|
210
|
+
};
|
|
85
211
|
/** @description How often the monitor will run */
|
|
86
212
|
cadence: {
|
|
87
213
|
/** @description Cron expression for monitor cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day. */
|
|
@@ -100,7 +226,7 @@ interface components$1 {
|
|
|
100
226
|
};
|
|
101
227
|
CreateWebhookParameters: {
|
|
102
228
|
/** @description The events to trigger the webhook */
|
|
103
|
-
events:
|
|
229
|
+
events: EventType[];
|
|
104
230
|
/** @description Set of key-value pairs you want to associate with this object. */
|
|
105
231
|
metadata?: {
|
|
106
232
|
[key: string]: string;
|
|
@@ -112,18 +238,27 @@ interface components$1 {
|
|
|
112
238
|
url: string;
|
|
113
239
|
};
|
|
114
240
|
CreateWebsetParameters: {
|
|
115
|
-
/** @description Add
|
|
241
|
+
/** @description Add enrichments to extract additional data from found items.
|
|
242
|
+
*
|
|
243
|
+
* Enrichments automatically search for and extract specific information (like contact details, funding data, employee counts, etc.) from each item added to your Webset. */
|
|
116
244
|
enrichments?: components$1["schemas"]["CreateEnrichmentParameters"][];
|
|
117
245
|
/** @description The external identifier for the webset.
|
|
118
246
|
*
|
|
119
247
|
* You can use this to reference the Webset by your own internal identifiers. */
|
|
120
248
|
externalId?: string;
|
|
249
|
+
/** @description Import data from existing Websets and Imports into this Webset. */
|
|
250
|
+
import?: {
|
|
251
|
+
/** @description The ID of the source to search. */
|
|
252
|
+
id: string;
|
|
253
|
+
/** @enum {string} */
|
|
254
|
+
source: CreateWebsetParametersImportSource;
|
|
255
|
+
}[];
|
|
121
256
|
/** @description Set of key-value pairs you want to associate with this object. */
|
|
122
257
|
metadata?: {
|
|
123
258
|
[key: string]: string;
|
|
124
259
|
};
|
|
125
260
|
/** @description Create initial search for the Webset. */
|
|
126
|
-
search
|
|
261
|
+
search?: {
|
|
127
262
|
/**
|
|
128
263
|
* @description Number of Items the Webset will attempt to find.
|
|
129
264
|
*
|
|
@@ -138,21 +273,28 @@ interface components$1 {
|
|
|
138
273
|
/** @description Entity the Webset will return results for.
|
|
139
274
|
*
|
|
140
275
|
* It is not required to provide it, we automatically detect the entity from all the information provided in the query. Only use this when you need more fine control. */
|
|
141
|
-
entity?: components$1["schemas"]["
|
|
142
|
-
/** @description
|
|
276
|
+
entity?: components$1["schemas"]["Entity"];
|
|
277
|
+
/** @description Sources (existing imports or websets) to exclude from search results. Any results found within these sources will be omitted to prevent finding them during search. */
|
|
278
|
+
exclude?: {
|
|
279
|
+
/** @description The ID of the source to exclude. */
|
|
280
|
+
id: string;
|
|
281
|
+
/** @enum {string} */
|
|
282
|
+
source: CreateWebsetParametersSearchExcludeSource;
|
|
283
|
+
}[];
|
|
284
|
+
/** @description Natural language search query describing what you are looking for.
|
|
143
285
|
*
|
|
144
|
-
*
|
|
286
|
+
* Be specific and descriptive about your requirements, characteristics, and any constraints that help narrow down the results.
|
|
145
287
|
*
|
|
146
|
-
* Any
|
|
288
|
+
* Any URLs provided will be crawled and used as additional context for the search. */
|
|
147
289
|
query: string;
|
|
148
290
|
};
|
|
149
291
|
};
|
|
150
292
|
CreateWebsetSearchParameters: {
|
|
151
293
|
/**
|
|
152
|
-
* @description
|
|
294
|
+
* @description How this search interacts with existing items in the Webset:
|
|
153
295
|
*
|
|
154
|
-
* -
|
|
155
|
-
* -
|
|
296
|
+
* - **override**: Replace existing items and evaluate all items against new criteria
|
|
297
|
+
* - **append**: Add new items to existing ones, keeping items that match the new criteria
|
|
156
298
|
* @default override
|
|
157
299
|
*/
|
|
158
300
|
behavior: components$1["schemas"]["WebsetSearchBehavior"];
|
|
@@ -162,25 +304,46 @@ interface components$1 {
|
|
|
162
304
|
count: number;
|
|
163
305
|
/** @description Criteria every item is evaluated against.
|
|
164
306
|
*
|
|
165
|
-
* It's not required to provide your own criteria, we automatically detect the criteria from all the information provided in the query. */
|
|
307
|
+
* It's not required to provide your own criteria, we automatically detect the criteria from all the information provided in the query. Only use this when you need more fine control. */
|
|
166
308
|
criteria?: components$1["schemas"]["CreateCriterionParameters"][];
|
|
167
|
-
/** @description Entity the
|
|
309
|
+
/** @description Entity the search will return results for.
|
|
168
310
|
*
|
|
169
|
-
* It is not required to provide it, we automatically detect the entity from all the information provided in the query. */
|
|
170
|
-
entity?: components$1["schemas"]["
|
|
311
|
+
* It is not required to provide it, we automatically detect the entity from all the information provided in the query. Only use this when you need more fine control. */
|
|
312
|
+
entity?: components$1["schemas"]["Entity"];
|
|
313
|
+
/** @description Sources (existing imports or websets) to exclude from search results. Any results found within these sources will be omitted to prevent finding them during search. */
|
|
314
|
+
exclude?: {
|
|
315
|
+
/** @description The ID of the source to exclude. */
|
|
316
|
+
id: string;
|
|
317
|
+
/** @enum {string} */
|
|
318
|
+
source: CreateWebsetSearchParametersExcludeSource;
|
|
319
|
+
}[];
|
|
171
320
|
/** @description Set of key-value pairs you want to associate with this object. */
|
|
172
321
|
metadata?: {
|
|
173
322
|
[key: string]: string;
|
|
174
323
|
};
|
|
175
|
-
/** @description
|
|
324
|
+
/** @description Natural language search query describing what you are looking for.
|
|
325
|
+
*
|
|
326
|
+
* Be specific and descriptive about your requirements, characteristics, and any constraints that help narrow down the results.
|
|
176
327
|
*
|
|
177
|
-
* Any
|
|
328
|
+
* Any URLs provided will be crawled and used as additional context for the search. */
|
|
178
329
|
query: string;
|
|
179
330
|
};
|
|
331
|
+
/** Custom */
|
|
332
|
+
CustomEntity: {
|
|
333
|
+
/** @description When you decide to use a custom entity, this is the description of the entity.
|
|
334
|
+
*
|
|
335
|
+
* The entity represents what type of results the will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
|
|
336
|
+
description: string;
|
|
337
|
+
/**
|
|
338
|
+
* @default custom
|
|
339
|
+
* @constant
|
|
340
|
+
*/
|
|
341
|
+
type: "custom";
|
|
342
|
+
};
|
|
180
343
|
EnrichmentResult: {
|
|
181
344
|
/** @description The id of the Enrichment that generated the result */
|
|
182
345
|
enrichmentId: string;
|
|
183
|
-
format: WebsetEnrichmentFormat;
|
|
346
|
+
format: components$1["schemas"]["WebsetEnrichmentFormat"];
|
|
184
347
|
/**
|
|
185
348
|
* @default enrichment_result
|
|
186
349
|
* @constant
|
|
@@ -200,6 +363,7 @@ interface components$1 {
|
|
|
200
363
|
/** @description The result of the enrichment. */
|
|
201
364
|
result: string[] | null;
|
|
202
365
|
};
|
|
366
|
+
Entity: components$1["schemas"]["CompanyEntity"] | components$1["schemas"]["PersonEntity"] | components$1["schemas"]["ArticleEntity"] | components$1["schemas"]["ResearchPaperEntity"] | components$1["schemas"]["CustomEntity"];
|
|
203
367
|
/** Event */
|
|
204
368
|
Event: {
|
|
205
369
|
/**
|
|
@@ -393,11 +557,61 @@ interface components$1 {
|
|
|
393
557
|
type: "webset.search.completed";
|
|
394
558
|
};
|
|
395
559
|
/** @enum {string} */
|
|
396
|
-
EventType: EventType;
|
|
397
560
|
GetWebsetResponse: components$1["schemas"]["Webset"] & {
|
|
398
561
|
/** @description When expand query parameter contains `items`, this will contain the items in the webset */
|
|
399
562
|
items?: components$1["schemas"]["WebsetItem"][];
|
|
400
563
|
};
|
|
564
|
+
Import: {
|
|
565
|
+
/** @description The number of entities in the import */
|
|
566
|
+
count: number;
|
|
567
|
+
/**
|
|
568
|
+
* Format: date-time
|
|
569
|
+
* @description When the import was created
|
|
570
|
+
*/
|
|
571
|
+
createdAt: string;
|
|
572
|
+
/** @description The type of entity the import contains. */
|
|
573
|
+
entity: components$1["schemas"]["Entity"];
|
|
574
|
+
/**
|
|
575
|
+
* Format: date-time
|
|
576
|
+
* @description When the import failed
|
|
577
|
+
*/
|
|
578
|
+
failedAt: string | null;
|
|
579
|
+
/** @description A human readable message of the import failure */
|
|
580
|
+
failedMessage: string | null;
|
|
581
|
+
/**
|
|
582
|
+
* @description The reason the import failed
|
|
583
|
+
* @enum {string|null}
|
|
584
|
+
*/
|
|
585
|
+
failedReason: ImportFailedReason;
|
|
586
|
+
/**
|
|
587
|
+
* @description The format of the import.
|
|
588
|
+
* @enum {string}
|
|
589
|
+
*/
|
|
590
|
+
format: ImportFormat;
|
|
591
|
+
/** @description The unique identifier for the Import */
|
|
592
|
+
id: string;
|
|
593
|
+
/** @description Set of key-value pairs you want to associate with this object. */
|
|
594
|
+
metadata: {
|
|
595
|
+
[key: string]: string;
|
|
596
|
+
};
|
|
597
|
+
/**
|
|
598
|
+
* @description The type of object
|
|
599
|
+
* @enum {string}
|
|
600
|
+
*/
|
|
601
|
+
object: ImportObject;
|
|
602
|
+
/**
|
|
603
|
+
* @description The status of the Import
|
|
604
|
+
* @enum {string}
|
|
605
|
+
*/
|
|
606
|
+
status: ImportStatus;
|
|
607
|
+
/** @description The title of the import */
|
|
608
|
+
title: string;
|
|
609
|
+
/**
|
|
610
|
+
* Format: date-time
|
|
611
|
+
* @description When the import was last updated
|
|
612
|
+
*/
|
|
613
|
+
updatedAt: string;
|
|
614
|
+
};
|
|
401
615
|
ListEventsResponse: {
|
|
402
616
|
/** @description The list of events */
|
|
403
617
|
data: components$1["schemas"]["Event"][];
|
|
@@ -406,6 +620,14 @@ interface components$1 {
|
|
|
406
620
|
/** @description The cursor to paginate through the next set of results */
|
|
407
621
|
nextCursor: string | null;
|
|
408
622
|
};
|
|
623
|
+
ListImportsResponse: {
|
|
624
|
+
/** @description The list of imports */
|
|
625
|
+
data: components$1["schemas"]["Import"][];
|
|
626
|
+
/** @description Whether there are more results to paginate through */
|
|
627
|
+
hasMore: boolean;
|
|
628
|
+
/** @description The cursor to paginate through the next set of results */
|
|
629
|
+
nextCursor: string | null;
|
|
630
|
+
};
|
|
409
631
|
ListMonitorRunsResponse: {
|
|
410
632
|
/** @description The list of monitor runs */
|
|
411
633
|
data: components$1["schemas"]["MonitorRun"][];
|
|
@@ -456,7 +678,37 @@ interface components$1 {
|
|
|
456
678
|
};
|
|
457
679
|
Monitor: {
|
|
458
680
|
/** @description Behavior to perform when monitor runs */
|
|
459
|
-
behavior:
|
|
681
|
+
behavior: {
|
|
682
|
+
/** @description Specify the search parameters for the Monitor.
|
|
683
|
+
*
|
|
684
|
+
* By default, the search parameters (query, entity and criteria) from the last search are used when no parameters are provided. */
|
|
685
|
+
config: {
|
|
686
|
+
/**
|
|
687
|
+
* @description The behaviour of the Search when it is added to a Webset.
|
|
688
|
+
* @default append
|
|
689
|
+
* @enum {string}
|
|
690
|
+
*/
|
|
691
|
+
behavior: MonitorBehaviorConfigBehavior;
|
|
692
|
+
/** @description The maximum number of results to find */
|
|
693
|
+
count: number;
|
|
694
|
+
/** @description The criteria to search for. By default, the criteria from the last search is used. */
|
|
695
|
+
criteria?: {
|
|
696
|
+
description: string;
|
|
697
|
+
}[];
|
|
698
|
+
/**
|
|
699
|
+
* Entity
|
|
700
|
+
* @description The entity to search for. By default, the entity from the last search/import is used.
|
|
701
|
+
*/
|
|
702
|
+
entity?: components$1["schemas"]["Entity"];
|
|
703
|
+
/** @description The query to search for. By default, the query from the last search is used. */
|
|
704
|
+
query?: string;
|
|
705
|
+
};
|
|
706
|
+
/**
|
|
707
|
+
* @default search
|
|
708
|
+
* @constant
|
|
709
|
+
*/
|
|
710
|
+
type: "search";
|
|
711
|
+
};
|
|
460
712
|
/** @description How often the monitor will run */
|
|
461
713
|
cadence: {
|
|
462
714
|
/** @description Cron expression for monitor cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day. */
|
|
@@ -485,7 +737,7 @@ interface components$1 {
|
|
|
485
737
|
};
|
|
486
738
|
/**
|
|
487
739
|
* Format: date-time
|
|
488
|
-
* @description
|
|
740
|
+
* @description Date and time when the next run will occur in
|
|
489
741
|
*/
|
|
490
742
|
nextRunAt: string | null;
|
|
491
743
|
/**
|
|
@@ -506,30 +758,30 @@ interface components$1 {
|
|
|
506
758
|
/** @description The id of the Webset the Monitor belongs to */
|
|
507
759
|
websetId: string;
|
|
508
760
|
};
|
|
509
|
-
|
|
510
|
-
/** @description Specify the
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
* @default refresh
|
|
514
|
-
* @constant
|
|
515
|
-
*/
|
|
516
|
-
type: "refresh";
|
|
517
|
-
};
|
|
518
|
-
MonitorBehaviorSearch: {
|
|
761
|
+
MonitorBehavior: {
|
|
762
|
+
/** @description Specify the search parameters for the Monitor.
|
|
763
|
+
*
|
|
764
|
+
* By default, the search parameters (query, entity and criteria) from the last search are used when no parameters are provided. */
|
|
519
765
|
config: {
|
|
520
766
|
/**
|
|
521
767
|
* @description The behaviour of the Search when it is added to a Webset.
|
|
522
768
|
* @default append
|
|
769
|
+
* @enum {string}
|
|
523
770
|
*/
|
|
524
|
-
behavior:
|
|
771
|
+
behavior: MonitorBehaviorConfigBehavior;
|
|
525
772
|
/** @description The maximum number of results to find */
|
|
526
773
|
count: number;
|
|
527
|
-
criteria
|
|
774
|
+
/** @description The criteria to search for. By default, the criteria from the last search is used. */
|
|
775
|
+
criteria?: {
|
|
528
776
|
description: string;
|
|
529
777
|
}[];
|
|
530
|
-
/**
|
|
531
|
-
|
|
532
|
-
|
|
778
|
+
/**
|
|
779
|
+
* Entity
|
|
780
|
+
* @description The entity to search for. By default, the entity from the last search/import is used.
|
|
781
|
+
*/
|
|
782
|
+
entity?: components$1["schemas"]["Entity"];
|
|
783
|
+
/** @description The query to search for. By default, the query from the last search is used. */
|
|
784
|
+
query?: string;
|
|
533
785
|
};
|
|
534
786
|
/**
|
|
535
787
|
* @default search
|
|
@@ -546,24 +798,6 @@ interface components$1 {
|
|
|
546
798
|
*/
|
|
547
799
|
timezone: string;
|
|
548
800
|
};
|
|
549
|
-
MonitorRefreshBehaviorContentsConfig: {
|
|
550
|
-
/**
|
|
551
|
-
* @default contents
|
|
552
|
-
* @constant
|
|
553
|
-
*/
|
|
554
|
-
target: "contents";
|
|
555
|
-
};
|
|
556
|
-
MonitorRefreshBehaviorEnrichmentsConfig: {
|
|
557
|
-
/** @description Only refresh specific enrichments */
|
|
558
|
-
enrichments?: {
|
|
559
|
-
ids?: string[];
|
|
560
|
-
};
|
|
561
|
-
/**
|
|
562
|
-
* @default enrichments
|
|
563
|
-
* @constant
|
|
564
|
-
*/
|
|
565
|
-
target: "enrichments";
|
|
566
|
-
};
|
|
567
801
|
MonitorRun: {
|
|
568
802
|
/**
|
|
569
803
|
* Format: date-time
|
|
@@ -610,7 +844,31 @@ interface components$1 {
|
|
|
610
844
|
*/
|
|
611
845
|
updatedAt: string;
|
|
612
846
|
};
|
|
847
|
+
/** Person */
|
|
848
|
+
PersonEntity: {
|
|
849
|
+
/**
|
|
850
|
+
* @default person
|
|
851
|
+
* @constant
|
|
852
|
+
*/
|
|
853
|
+
type: "person";
|
|
854
|
+
};
|
|
855
|
+
/** Research Paper */
|
|
856
|
+
ResearchPaperEntity: {
|
|
857
|
+
/**
|
|
858
|
+
* @default research_paper
|
|
859
|
+
* @constant
|
|
860
|
+
*/
|
|
861
|
+
type: "research_paper";
|
|
862
|
+
};
|
|
863
|
+
UpdateImport: {
|
|
864
|
+
metadata?: {
|
|
865
|
+
[key: string]: string;
|
|
866
|
+
};
|
|
867
|
+
title?: string;
|
|
868
|
+
};
|
|
613
869
|
UpdateMonitor: {
|
|
870
|
+
behavior?: components$1["schemas"]["MonitorBehavior"];
|
|
871
|
+
cadence?: components$1["schemas"]["MonitorCadence"];
|
|
614
872
|
metadata?: {
|
|
615
873
|
[key: string]: string;
|
|
616
874
|
};
|
|
@@ -622,7 +880,7 @@ interface components$1 {
|
|
|
622
880
|
};
|
|
623
881
|
UpdateWebhookParameters: {
|
|
624
882
|
/** @description The events to trigger the webhook */
|
|
625
|
-
events?:
|
|
883
|
+
events?: EventType[];
|
|
626
884
|
/** @description Set of key-value pairs you want to associate with this object. */
|
|
627
885
|
metadata?: {
|
|
628
886
|
[key: string]: string;
|
|
@@ -646,7 +904,7 @@ interface components$1 {
|
|
|
646
904
|
*/
|
|
647
905
|
createdAt: string;
|
|
648
906
|
/** @description The events to trigger the webhook */
|
|
649
|
-
events:
|
|
907
|
+
events: EventType[];
|
|
650
908
|
/** @description The unique identifier for the webhook */
|
|
651
909
|
id: string;
|
|
652
910
|
/**
|
|
@@ -729,6 +987,388 @@ interface components$1 {
|
|
|
729
987
|
externalId: string | null;
|
|
730
988
|
/** @description The unique identifier for the webset */
|
|
731
989
|
id: string;
|
|
990
|
+
/** @description Imports that have been performed on the webset. */
|
|
991
|
+
imports?: ({
|
|
992
|
+
count: number;
|
|
993
|
+
/** Format: date-time */
|
|
994
|
+
createdAt: string;
|
|
995
|
+
entity?: {
|
|
996
|
+
/**
|
|
997
|
+
* @default A homepage of a company
|
|
998
|
+
* @constant
|
|
999
|
+
*/
|
|
1000
|
+
description: "A homepage of a company";
|
|
1001
|
+
/**
|
|
1002
|
+
* @default company
|
|
1003
|
+
* @constant
|
|
1004
|
+
*/
|
|
1005
|
+
type: "company";
|
|
1006
|
+
} | {
|
|
1007
|
+
/**
|
|
1008
|
+
* @default A LinkedIn profile
|
|
1009
|
+
* @constant
|
|
1010
|
+
*/
|
|
1011
|
+
description: "A LinkedIn profile";
|
|
1012
|
+
/**
|
|
1013
|
+
* @default person
|
|
1014
|
+
* @constant
|
|
1015
|
+
*/
|
|
1016
|
+
type: "person";
|
|
1017
|
+
} | {
|
|
1018
|
+
/**
|
|
1019
|
+
* @default A blog post or article
|
|
1020
|
+
* @constant
|
|
1021
|
+
*/
|
|
1022
|
+
description: "A blog post or article";
|
|
1023
|
+
/**
|
|
1024
|
+
* @default article
|
|
1025
|
+
* @constant
|
|
1026
|
+
*/
|
|
1027
|
+
type: "article";
|
|
1028
|
+
} | {
|
|
1029
|
+
/**
|
|
1030
|
+
* @default A research paper
|
|
1031
|
+
* @constant
|
|
1032
|
+
*/
|
|
1033
|
+
description: "A research paper";
|
|
1034
|
+
/**
|
|
1035
|
+
* @default research_paper
|
|
1036
|
+
* @constant
|
|
1037
|
+
*/
|
|
1038
|
+
type: "research_paper";
|
|
1039
|
+
} | {
|
|
1040
|
+
/** @description When you decide to use a custom entity, this is the description of the entity.
|
|
1041
|
+
*
|
|
1042
|
+
* The entity represents what type of results the will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
|
|
1043
|
+
description: string;
|
|
1044
|
+
/**
|
|
1045
|
+
* @default custom
|
|
1046
|
+
* @constant
|
|
1047
|
+
*/
|
|
1048
|
+
type: "custom";
|
|
1049
|
+
};
|
|
1050
|
+
/** @enum {string} */
|
|
1051
|
+
format: WebsetImportsFormat;
|
|
1052
|
+
id: string;
|
|
1053
|
+
metadata?: {
|
|
1054
|
+
[key: string]: string;
|
|
1055
|
+
};
|
|
1056
|
+
/** @enum {string} */
|
|
1057
|
+
status: WebsetImportsStatus;
|
|
1058
|
+
teamId: string;
|
|
1059
|
+
title: string;
|
|
1060
|
+
/** Format: date-time */
|
|
1061
|
+
updatedAt: string;
|
|
1062
|
+
/** @description The URI of the import when format is CSV */
|
|
1063
|
+
uri?: string;
|
|
1064
|
+
/** @description The ID of the webset when format is WEBSET */
|
|
1065
|
+
websetId?: string;
|
|
1066
|
+
} | {
|
|
1067
|
+
count: number;
|
|
1068
|
+
/** Format: date-time */
|
|
1069
|
+
createdAt: string;
|
|
1070
|
+
entity: {
|
|
1071
|
+
/**
|
|
1072
|
+
* @default A homepage of a company
|
|
1073
|
+
* @constant
|
|
1074
|
+
*/
|
|
1075
|
+
description: "A homepage of a company";
|
|
1076
|
+
/**
|
|
1077
|
+
* @default company
|
|
1078
|
+
* @constant
|
|
1079
|
+
*/
|
|
1080
|
+
type: "company";
|
|
1081
|
+
} | {
|
|
1082
|
+
/**
|
|
1083
|
+
* @default A LinkedIn profile
|
|
1084
|
+
* @constant
|
|
1085
|
+
*/
|
|
1086
|
+
description: "A LinkedIn profile";
|
|
1087
|
+
/**
|
|
1088
|
+
* @default person
|
|
1089
|
+
* @constant
|
|
1090
|
+
*/
|
|
1091
|
+
type: "person";
|
|
1092
|
+
} | {
|
|
1093
|
+
/**
|
|
1094
|
+
* @default A blog post or article
|
|
1095
|
+
* @constant
|
|
1096
|
+
*/
|
|
1097
|
+
description: "A blog post or article";
|
|
1098
|
+
/**
|
|
1099
|
+
* @default article
|
|
1100
|
+
* @constant
|
|
1101
|
+
*/
|
|
1102
|
+
type: "article";
|
|
1103
|
+
} | {
|
|
1104
|
+
/**
|
|
1105
|
+
* @default A research paper
|
|
1106
|
+
* @constant
|
|
1107
|
+
*/
|
|
1108
|
+
description: "A research paper";
|
|
1109
|
+
/**
|
|
1110
|
+
* @default research_paper
|
|
1111
|
+
* @constant
|
|
1112
|
+
*/
|
|
1113
|
+
type: "research_paper";
|
|
1114
|
+
} | {
|
|
1115
|
+
/** @description When you decide to use a custom entity, this is the description of the entity.
|
|
1116
|
+
*
|
|
1117
|
+
* The entity represents what type of results the will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
|
|
1118
|
+
description: string;
|
|
1119
|
+
/**
|
|
1120
|
+
* @default custom
|
|
1121
|
+
* @constant
|
|
1122
|
+
*/
|
|
1123
|
+
type: "custom";
|
|
1124
|
+
};
|
|
1125
|
+
/** @enum {string} */
|
|
1126
|
+
format: WebsetImportsFormat;
|
|
1127
|
+
id: string;
|
|
1128
|
+
metadata?: {
|
|
1129
|
+
[key: string]: string;
|
|
1130
|
+
};
|
|
1131
|
+
/** @enum {string} */
|
|
1132
|
+
status: WebsetImportsStatus;
|
|
1133
|
+
teamId: string;
|
|
1134
|
+
title: string;
|
|
1135
|
+
/** Format: date-time */
|
|
1136
|
+
updatedAt: string;
|
|
1137
|
+
/** @description The URI of the import when format is CSV */
|
|
1138
|
+
uri?: string;
|
|
1139
|
+
/** @description The ID of the webset when format is WEBSET */
|
|
1140
|
+
websetId?: string;
|
|
1141
|
+
} | {
|
|
1142
|
+
count: number;
|
|
1143
|
+
/** Format: date-time */
|
|
1144
|
+
createdAt: string;
|
|
1145
|
+
entity: {
|
|
1146
|
+
/**
|
|
1147
|
+
* @default A homepage of a company
|
|
1148
|
+
* @constant
|
|
1149
|
+
*/
|
|
1150
|
+
description: "A homepage of a company";
|
|
1151
|
+
/**
|
|
1152
|
+
* @default company
|
|
1153
|
+
* @constant
|
|
1154
|
+
*/
|
|
1155
|
+
type: "company";
|
|
1156
|
+
} | {
|
|
1157
|
+
/**
|
|
1158
|
+
* @default A LinkedIn profile
|
|
1159
|
+
* @constant
|
|
1160
|
+
*/
|
|
1161
|
+
description: "A LinkedIn profile";
|
|
1162
|
+
/**
|
|
1163
|
+
* @default person
|
|
1164
|
+
* @constant
|
|
1165
|
+
*/
|
|
1166
|
+
type: "person";
|
|
1167
|
+
} | {
|
|
1168
|
+
/**
|
|
1169
|
+
* @default A blog post or article
|
|
1170
|
+
* @constant
|
|
1171
|
+
*/
|
|
1172
|
+
description: "A blog post or article";
|
|
1173
|
+
/**
|
|
1174
|
+
* @default article
|
|
1175
|
+
* @constant
|
|
1176
|
+
*/
|
|
1177
|
+
type: "article";
|
|
1178
|
+
} | {
|
|
1179
|
+
/**
|
|
1180
|
+
* @default A research paper
|
|
1181
|
+
* @constant
|
|
1182
|
+
*/
|
|
1183
|
+
description: "A research paper";
|
|
1184
|
+
/**
|
|
1185
|
+
* @default research_paper
|
|
1186
|
+
* @constant
|
|
1187
|
+
*/
|
|
1188
|
+
type: "research_paper";
|
|
1189
|
+
} | {
|
|
1190
|
+
/** @description When you decide to use a custom entity, this is the description of the entity.
|
|
1191
|
+
*
|
|
1192
|
+
* The entity represents what type of results the will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
|
|
1193
|
+
description: string;
|
|
1194
|
+
/**
|
|
1195
|
+
* @default custom
|
|
1196
|
+
* @constant
|
|
1197
|
+
*/
|
|
1198
|
+
type: "custom";
|
|
1199
|
+
};
|
|
1200
|
+
/** @enum {string} */
|
|
1201
|
+
format: WebsetImportsFormat;
|
|
1202
|
+
id: string;
|
|
1203
|
+
metadata?: {
|
|
1204
|
+
[key: string]: string;
|
|
1205
|
+
};
|
|
1206
|
+
/** @enum {string} */
|
|
1207
|
+
status: WebsetImportsStatus;
|
|
1208
|
+
teamId: string;
|
|
1209
|
+
title: string;
|
|
1210
|
+
/** Format: date-time */
|
|
1211
|
+
updatedAt: string;
|
|
1212
|
+
/** @description The URI of the import when format is CSV */
|
|
1213
|
+
uri?: string;
|
|
1214
|
+
/** @description The ID of the webset when format is WEBSET */
|
|
1215
|
+
websetId?: string;
|
|
1216
|
+
} | {
|
|
1217
|
+
count: number;
|
|
1218
|
+
/** Format: date-time */
|
|
1219
|
+
createdAt: string;
|
|
1220
|
+
entity: {
|
|
1221
|
+
/**
|
|
1222
|
+
* @default A homepage of a company
|
|
1223
|
+
* @constant
|
|
1224
|
+
*/
|
|
1225
|
+
description: "A homepage of a company";
|
|
1226
|
+
/**
|
|
1227
|
+
* @default company
|
|
1228
|
+
* @constant
|
|
1229
|
+
*/
|
|
1230
|
+
type: "company";
|
|
1231
|
+
} | {
|
|
1232
|
+
/**
|
|
1233
|
+
* @default A LinkedIn profile
|
|
1234
|
+
* @constant
|
|
1235
|
+
*/
|
|
1236
|
+
description: "A LinkedIn profile";
|
|
1237
|
+
/**
|
|
1238
|
+
* @default person
|
|
1239
|
+
* @constant
|
|
1240
|
+
*/
|
|
1241
|
+
type: "person";
|
|
1242
|
+
} | {
|
|
1243
|
+
/**
|
|
1244
|
+
* @default A blog post or article
|
|
1245
|
+
* @constant
|
|
1246
|
+
*/
|
|
1247
|
+
description: "A blog post or article";
|
|
1248
|
+
/**
|
|
1249
|
+
* @default article
|
|
1250
|
+
* @constant
|
|
1251
|
+
*/
|
|
1252
|
+
type: "article";
|
|
1253
|
+
} | {
|
|
1254
|
+
/**
|
|
1255
|
+
* @default A research paper
|
|
1256
|
+
* @constant
|
|
1257
|
+
*/
|
|
1258
|
+
description: "A research paper";
|
|
1259
|
+
/**
|
|
1260
|
+
* @default research_paper
|
|
1261
|
+
* @constant
|
|
1262
|
+
*/
|
|
1263
|
+
type: "research_paper";
|
|
1264
|
+
} | {
|
|
1265
|
+
/** @description When you decide to use a custom entity, this is the description of the entity.
|
|
1266
|
+
*
|
|
1267
|
+
* The entity represents what type of results the will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
|
|
1268
|
+
description: string;
|
|
1269
|
+
/**
|
|
1270
|
+
* @default custom
|
|
1271
|
+
* @constant
|
|
1272
|
+
*/
|
|
1273
|
+
type: "custom";
|
|
1274
|
+
};
|
|
1275
|
+
/** Format: date-time */
|
|
1276
|
+
failedAt: string;
|
|
1277
|
+
failedMessage: string;
|
|
1278
|
+
/** @enum {string} */
|
|
1279
|
+
failedReason: WebsetImportsFailedReason;
|
|
1280
|
+
/** @enum {string} */
|
|
1281
|
+
format: WebsetImportsFormat;
|
|
1282
|
+
id: string;
|
|
1283
|
+
metadata?: {
|
|
1284
|
+
[key: string]: string;
|
|
1285
|
+
};
|
|
1286
|
+
/** @enum {string} */
|
|
1287
|
+
status: WebsetImportsStatus;
|
|
1288
|
+
teamId: string;
|
|
1289
|
+
title: string;
|
|
1290
|
+
/** Format: date-time */
|
|
1291
|
+
updatedAt: string;
|
|
1292
|
+
/** @description The URI of the import when format is CSV */
|
|
1293
|
+
uri?: string;
|
|
1294
|
+
/** @description The ID of the webset when format is WEBSET */
|
|
1295
|
+
websetId?: string;
|
|
1296
|
+
} | {
|
|
1297
|
+
count: number;
|
|
1298
|
+
/** Format: date-time */
|
|
1299
|
+
createdAt: string;
|
|
1300
|
+
entity: {
|
|
1301
|
+
/**
|
|
1302
|
+
* @default A homepage of a company
|
|
1303
|
+
* @constant
|
|
1304
|
+
*/
|
|
1305
|
+
description: "A homepage of a company";
|
|
1306
|
+
/**
|
|
1307
|
+
* @default company
|
|
1308
|
+
* @constant
|
|
1309
|
+
*/
|
|
1310
|
+
type: "company";
|
|
1311
|
+
} | {
|
|
1312
|
+
/**
|
|
1313
|
+
* @default A LinkedIn profile
|
|
1314
|
+
* @constant
|
|
1315
|
+
*/
|
|
1316
|
+
description: "A LinkedIn profile";
|
|
1317
|
+
/**
|
|
1318
|
+
* @default person
|
|
1319
|
+
* @constant
|
|
1320
|
+
*/
|
|
1321
|
+
type: "person";
|
|
1322
|
+
} | {
|
|
1323
|
+
/**
|
|
1324
|
+
* @default A blog post or article
|
|
1325
|
+
* @constant
|
|
1326
|
+
*/
|
|
1327
|
+
description: "A blog post or article";
|
|
1328
|
+
/**
|
|
1329
|
+
* @default article
|
|
1330
|
+
* @constant
|
|
1331
|
+
*/
|
|
1332
|
+
type: "article";
|
|
1333
|
+
} | {
|
|
1334
|
+
/**
|
|
1335
|
+
* @default A research paper
|
|
1336
|
+
* @constant
|
|
1337
|
+
*/
|
|
1338
|
+
description: "A research paper";
|
|
1339
|
+
/**
|
|
1340
|
+
* @default research_paper
|
|
1341
|
+
* @constant
|
|
1342
|
+
*/
|
|
1343
|
+
type: "research_paper";
|
|
1344
|
+
} | {
|
|
1345
|
+
/** @description When you decide to use a custom entity, this is the description of the entity.
|
|
1346
|
+
*
|
|
1347
|
+
* The entity represents what type of results the will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
|
|
1348
|
+
description: string;
|
|
1349
|
+
/**
|
|
1350
|
+
* @default custom
|
|
1351
|
+
* @constant
|
|
1352
|
+
*/
|
|
1353
|
+
type: "custom";
|
|
1354
|
+
};
|
|
1355
|
+
/** @enum {string} */
|
|
1356
|
+
format: WebsetImportsFormat;
|
|
1357
|
+
id: string;
|
|
1358
|
+
metadata?: {
|
|
1359
|
+
[key: string]: string;
|
|
1360
|
+
};
|
|
1361
|
+
/** @enum {string} */
|
|
1362
|
+
status: WebsetImportsStatus;
|
|
1363
|
+
teamId: string;
|
|
1364
|
+
title: string;
|
|
1365
|
+
/** Format: date-time */
|
|
1366
|
+
updatedAt: string;
|
|
1367
|
+
/** @description The URI of the import when format is CSV */
|
|
1368
|
+
uri?: string;
|
|
1369
|
+
/** @description The ID of the webset when format is WEBSET */
|
|
1370
|
+
websetId?: string;
|
|
1371
|
+
})[];
|
|
732
1372
|
/**
|
|
733
1373
|
* @description Set of key-value pairs you want to associate with this object.
|
|
734
1374
|
* @default {}
|
|
@@ -751,37 +1391,14 @@ interface components$1 {
|
|
|
751
1391
|
* @enum {string}
|
|
752
1392
|
*/
|
|
753
1393
|
status: WebsetStatus;
|
|
1394
|
+
/** @description The Streams for the Webset. */
|
|
1395
|
+
streams: unknown[];
|
|
754
1396
|
/**
|
|
755
1397
|
* Format: date-time
|
|
756
1398
|
* @description The date and time the webset was updated
|
|
757
1399
|
*/
|
|
758
1400
|
updatedAt: string;
|
|
759
1401
|
};
|
|
760
|
-
WebsetArticleEntity: {
|
|
761
|
-
/**
|
|
762
|
-
* @default article
|
|
763
|
-
* @constant
|
|
764
|
-
*/
|
|
765
|
-
type: "article";
|
|
766
|
-
};
|
|
767
|
-
WebsetCompanyEntity: {
|
|
768
|
-
/**
|
|
769
|
-
* @default company
|
|
770
|
-
* @constant
|
|
771
|
-
*/
|
|
772
|
-
type: "company";
|
|
773
|
-
};
|
|
774
|
-
WebsetCustomEntity: {
|
|
775
|
-
/** @description When you decide to use a custom entity, this is the description of the entity.
|
|
776
|
-
*
|
|
777
|
-
* The entity represents what type of results the Webset will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
|
|
778
|
-
description: string;
|
|
779
|
-
/**
|
|
780
|
-
* @default custom
|
|
781
|
-
* @constant
|
|
782
|
-
*/
|
|
783
|
-
type: "custom";
|
|
784
|
-
};
|
|
785
1402
|
WebsetEnrichment: {
|
|
786
1403
|
/**
|
|
787
1404
|
* Format: date-time
|
|
@@ -791,7 +1408,7 @@ interface components$1 {
|
|
|
791
1408
|
/** @description The description of the enrichment task provided during the creation of the enrichment. */
|
|
792
1409
|
description: string;
|
|
793
1410
|
/** @description The format of the enrichment response. */
|
|
794
|
-
format: WebsetEnrichmentFormat;
|
|
1411
|
+
format: components$1["schemas"]["WebsetEnrichmentFormat"];
|
|
795
1412
|
/** @description The unique identifier for the enrichment */
|
|
796
1413
|
id: string;
|
|
797
1414
|
/** @description The instructions for the enrichment Agent.
|
|
@@ -837,7 +1454,7 @@ interface components$1 {
|
|
|
837
1454
|
websetId: string;
|
|
838
1455
|
};
|
|
839
1456
|
/** @enum {string} */
|
|
840
|
-
|
|
1457
|
+
WebsetEnrichmentFormat: WebsetEnrichmentFormat;
|
|
841
1458
|
WebsetItem: {
|
|
842
1459
|
/**
|
|
843
1460
|
* Format: date-time
|
|
@@ -879,6 +1496,8 @@ interface components$1 {
|
|
|
879
1496
|
author: string | null;
|
|
880
1497
|
/** @description The date and time the article was published */
|
|
881
1498
|
publishedAt: string | null;
|
|
1499
|
+
/** @description The title of the article */
|
|
1500
|
+
title: string | null;
|
|
882
1501
|
};
|
|
883
1502
|
/** @description The text content for the article */
|
|
884
1503
|
content: string | null;
|
|
@@ -938,6 +1557,8 @@ interface components$1 {
|
|
|
938
1557
|
author: string | null;
|
|
939
1558
|
/** @description The date and time the website was published */
|
|
940
1559
|
publishedAt: string | null;
|
|
1560
|
+
/** @description The title of the website */
|
|
1561
|
+
title: string | null;
|
|
941
1562
|
};
|
|
942
1563
|
/** @description Short description of the Item */
|
|
943
1564
|
description: string;
|
|
@@ -1014,6 +1635,8 @@ interface components$1 {
|
|
|
1014
1635
|
author: string | null;
|
|
1015
1636
|
/** @description The date and time the research paper was published */
|
|
1016
1637
|
publishedAt: string | null;
|
|
1638
|
+
/** @description The title of the research paper */
|
|
1639
|
+
title: string | null;
|
|
1017
1640
|
};
|
|
1018
1641
|
/**
|
|
1019
1642
|
* @default research_paper
|
|
@@ -1026,20 +1649,6 @@ interface components$1 {
|
|
|
1026
1649
|
*/
|
|
1027
1650
|
url: string;
|
|
1028
1651
|
};
|
|
1029
|
-
WebsetPersonEntity: {
|
|
1030
|
-
/**
|
|
1031
|
-
* @default person
|
|
1032
|
-
* @constant
|
|
1033
|
-
*/
|
|
1034
|
-
type: "person";
|
|
1035
|
-
};
|
|
1036
|
-
WebsetResearchPaperEntity: {
|
|
1037
|
-
/**
|
|
1038
|
-
* @default research_paper
|
|
1039
|
-
* @constant
|
|
1040
|
-
*/
|
|
1041
|
-
type: "research_paper";
|
|
1042
|
-
};
|
|
1043
1652
|
WebsetSearch: {
|
|
1044
1653
|
/**
|
|
1045
1654
|
* @description The behavior of the search when it is added to a Webset.
|
|
@@ -1073,7 +1682,13 @@ interface components$1 {
|
|
|
1073
1682
|
/** @description The entity the search will return results for.
|
|
1074
1683
|
*
|
|
1075
1684
|
* When no entity is provided during creation, we will automatically select the best entity based on the query. */
|
|
1076
|
-
entity: components$1["schemas"]["
|
|
1685
|
+
entity: components$1["schemas"]["Entity"];
|
|
1686
|
+
/** @description Sources (existing imports or websets) used to omit certain results to be found during the search. */
|
|
1687
|
+
exclude: {
|
|
1688
|
+
id: string;
|
|
1689
|
+
/** @enum {string} */
|
|
1690
|
+
source: WebsetSearchExcludeSource;
|
|
1691
|
+
}[];
|
|
1077
1692
|
/** @description The unique identifier for the search */
|
|
1078
1693
|
id: string;
|
|
1079
1694
|
/**
|
|
@@ -1120,16 +1735,24 @@ interface components$1 {
|
|
|
1120
1735
|
headers: never;
|
|
1121
1736
|
pathItems: never;
|
|
1122
1737
|
}
|
|
1738
|
+
type ArticleEntity = components$1["schemas"]["ArticleEntity"];
|
|
1739
|
+
type CompanyEntity = components$1["schemas"]["CompanyEntity"];
|
|
1123
1740
|
type CreateCriterionParameters = components$1["schemas"]["CreateCriterionParameters"];
|
|
1124
1741
|
type CreateEnrichmentParameters = components$1["schemas"]["CreateEnrichmentParameters"];
|
|
1742
|
+
type CreateImportParameters = components$1["schemas"]["CreateImportParameters"];
|
|
1743
|
+
type CreateImportResponse = components$1["schemas"]["CreateImportResponse"];
|
|
1125
1744
|
type CreateMonitorParameters = components$1["schemas"]["CreateMonitorParameters"];
|
|
1126
1745
|
type CreateWebhookParameters = components$1["schemas"]["CreateWebhookParameters"];
|
|
1127
1746
|
type CreateWebsetParameters = components$1["schemas"]["CreateWebsetParameters"];
|
|
1128
1747
|
type CreateWebsetSearchParameters = components$1["schemas"]["CreateWebsetSearchParameters"];
|
|
1748
|
+
type CustomEntity = components$1["schemas"]["CustomEntity"];
|
|
1129
1749
|
type EnrichmentResult = components$1["schemas"]["EnrichmentResult"];
|
|
1750
|
+
type Entity = components$1["schemas"]["Entity"];
|
|
1130
1751
|
type Event = components$1["schemas"]["Event"];
|
|
1131
1752
|
type GetWebsetResponse = components$1["schemas"]["GetWebsetResponse"];
|
|
1753
|
+
type Import = components$1["schemas"]["Import"];
|
|
1132
1754
|
type ListEventsResponse = components$1["schemas"]["ListEventsResponse"];
|
|
1755
|
+
type ListImportsResponse = components$1["schemas"]["ListImportsResponse"];
|
|
1133
1756
|
type ListMonitorRunsResponse = components$1["schemas"]["ListMonitorRunsResponse"];
|
|
1134
1757
|
type ListMonitorsResponse = components$1["schemas"]["ListMonitorsResponse"];
|
|
1135
1758
|
type ListWebhookAttemptsResponse = components$1["schemas"]["ListWebhookAttemptsResponse"];
|
|
@@ -1137,23 +1760,19 @@ type ListWebhooksResponse = components$1["schemas"]["ListWebhooksResponse"];
|
|
|
1137
1760
|
type ListWebsetItemResponse = components$1["schemas"]["ListWebsetItemResponse"];
|
|
1138
1761
|
type ListWebsetsResponse = components$1["schemas"]["ListWebsetsResponse"];
|
|
1139
1762
|
type Monitor = components$1["schemas"]["Monitor"];
|
|
1140
|
-
type
|
|
1141
|
-
type MonitorBehaviorSearch = components$1["schemas"]["MonitorBehaviorSearch"];
|
|
1763
|
+
type MonitorBehavior = components$1["schemas"]["MonitorBehavior"];
|
|
1142
1764
|
type MonitorCadence = components$1["schemas"]["MonitorCadence"];
|
|
1143
|
-
type MonitorRefreshBehaviorContentsConfig = components$1["schemas"]["MonitorRefreshBehaviorContentsConfig"];
|
|
1144
|
-
type MonitorRefreshBehaviorEnrichmentsConfig = components$1["schemas"]["MonitorRefreshBehaviorEnrichmentsConfig"];
|
|
1145
1765
|
type MonitorRun = components$1["schemas"]["MonitorRun"];
|
|
1766
|
+
type PersonEntity = components$1["schemas"]["PersonEntity"];
|
|
1767
|
+
type ResearchPaperEntity = components$1["schemas"]["ResearchPaperEntity"];
|
|
1768
|
+
type UpdateImport = components$1["schemas"]["UpdateImport"];
|
|
1146
1769
|
type UpdateMonitor = components$1["schemas"]["UpdateMonitor"];
|
|
1147
1770
|
type UpdateWebhookParameters = components$1["schemas"]["UpdateWebhookParameters"];
|
|
1148
1771
|
type UpdateWebsetRequest = components$1["schemas"]["UpdateWebsetRequest"];
|
|
1149
1772
|
type Webhook = components$1["schemas"]["Webhook"];
|
|
1150
1773
|
type WebhookAttempt = components$1["schemas"]["WebhookAttempt"];
|
|
1151
1774
|
type Webset = components$1["schemas"]["Webset"];
|
|
1152
|
-
type WebsetArticleEntity = components$1["schemas"]["WebsetArticleEntity"];
|
|
1153
|
-
type WebsetCompanyEntity = components$1["schemas"]["WebsetCompanyEntity"];
|
|
1154
|
-
type WebsetCustomEntity = components$1["schemas"]["WebsetCustomEntity"];
|
|
1155
1775
|
type WebsetEnrichment = components$1["schemas"]["WebsetEnrichment"];
|
|
1156
|
-
type WebsetEntity = components$1["schemas"]["WebsetEntity"];
|
|
1157
1776
|
type WebsetItem = components$1["schemas"]["WebsetItem"];
|
|
1158
1777
|
type WebsetItemArticleProperties = components$1["schemas"]["WebsetItemArticleProperties"];
|
|
1159
1778
|
type WebsetItemCompanyProperties = components$1["schemas"]["WebsetItemCompanyProperties"];
|
|
@@ -1161,8 +1780,6 @@ type WebsetItemCustomProperties = components$1["schemas"]["WebsetItemCustomPrope
|
|
|
1161
1780
|
type WebsetItemEvaluation = components$1["schemas"]["WebsetItemEvaluation"];
|
|
1162
1781
|
type WebsetItemPersonProperties = components$1["schemas"]["WebsetItemPersonProperties"];
|
|
1163
1782
|
type WebsetItemResearchPaperProperties = components$1["schemas"]["WebsetItemResearchPaperProperties"];
|
|
1164
|
-
type WebsetPersonEntity = components$1["schemas"]["WebsetPersonEntity"];
|
|
1165
|
-
type WebsetResearchPaperEntity = components$1["schemas"]["WebsetResearchPaperEntity"];
|
|
1166
1783
|
type WebsetSearch = components$1["schemas"]["WebsetSearch"];
|
|
1167
1784
|
declare enum CreateEnrichmentParametersFormat {
|
|
1168
1785
|
text = "text",
|
|
@@ -1172,6 +1789,39 @@ declare enum CreateEnrichmentParametersFormat {
|
|
|
1172
1789
|
email = "email",
|
|
1173
1790
|
phone = "phone"
|
|
1174
1791
|
}
|
|
1792
|
+
declare enum CreateImportParametersFormat {
|
|
1793
|
+
csv = "csv"
|
|
1794
|
+
}
|
|
1795
|
+
declare enum CreateImportResponseFailedReason {
|
|
1796
|
+
invalid_format = "invalid_format",
|
|
1797
|
+
invalid_file_content = "invalid_file_content",
|
|
1798
|
+
missing_identifier = "missing_identifier"
|
|
1799
|
+
}
|
|
1800
|
+
declare enum CreateImportResponseFormat {
|
|
1801
|
+
csv = "csv",
|
|
1802
|
+
webset = "webset"
|
|
1803
|
+
}
|
|
1804
|
+
declare enum CreateImportResponseObject {
|
|
1805
|
+
import = "import"
|
|
1806
|
+
}
|
|
1807
|
+
declare enum CreateImportResponseStatus {
|
|
1808
|
+
pending = "pending",
|
|
1809
|
+
processing = "processing",
|
|
1810
|
+
completed = "completed",
|
|
1811
|
+
failed = "failed"
|
|
1812
|
+
}
|
|
1813
|
+
declare enum CreateWebsetParametersImportSource {
|
|
1814
|
+
import = "import",
|
|
1815
|
+
webset = "webset"
|
|
1816
|
+
}
|
|
1817
|
+
declare enum CreateWebsetParametersSearchExcludeSource {
|
|
1818
|
+
import = "import",
|
|
1819
|
+
webset = "webset"
|
|
1820
|
+
}
|
|
1821
|
+
declare enum CreateWebsetSearchParametersExcludeSource {
|
|
1822
|
+
import = "import",
|
|
1823
|
+
webset = "webset"
|
|
1824
|
+
}
|
|
1175
1825
|
declare enum EventType {
|
|
1176
1826
|
webset_created = "webset.created",
|
|
1177
1827
|
webset_deleted = "webset.deleted",
|
|
@@ -1181,10 +1831,31 @@ declare enum EventType {
|
|
|
1181
1831
|
webset_search_canceled = "webset.search.canceled",
|
|
1182
1832
|
webset_search_completed = "webset.search.completed",
|
|
1183
1833
|
webset_search_updated = "webset.search.updated",
|
|
1184
|
-
|
|
1185
|
-
|
|
1834
|
+
import_created = "import.created",
|
|
1835
|
+
import_completed = "import.completed",
|
|
1836
|
+
import_processing = "import.processing",
|
|
1186
1837
|
webset_item_created = "webset.item.created",
|
|
1187
|
-
webset_item_enriched = "webset.item.enriched"
|
|
1838
|
+
webset_item_enriched = "webset.item.enriched",
|
|
1839
|
+
webset_export_created = "webset.export.created",
|
|
1840
|
+
webset_export_completed = "webset.export.completed"
|
|
1841
|
+
}
|
|
1842
|
+
declare enum ImportFailedReason {
|
|
1843
|
+
invalid_format = "invalid_format",
|
|
1844
|
+
invalid_file_content = "invalid_file_content",
|
|
1845
|
+
missing_identifier = "missing_identifier"
|
|
1846
|
+
}
|
|
1847
|
+
declare enum ImportFormat {
|
|
1848
|
+
csv = "csv",
|
|
1849
|
+
webset = "webset"
|
|
1850
|
+
}
|
|
1851
|
+
declare enum ImportObject {
|
|
1852
|
+
import = "import"
|
|
1853
|
+
}
|
|
1854
|
+
declare enum ImportStatus {
|
|
1855
|
+
pending = "pending",
|
|
1856
|
+
processing = "processing",
|
|
1857
|
+
completed = "completed",
|
|
1858
|
+
failed = "failed"
|
|
1188
1859
|
}
|
|
1189
1860
|
declare enum MonitorObject {
|
|
1190
1861
|
monitor = "monitor"
|
|
@@ -1193,6 +1864,10 @@ declare enum MonitorStatus {
|
|
|
1193
1864
|
enabled = "enabled",
|
|
1194
1865
|
disabled = "disabled"
|
|
1195
1866
|
}
|
|
1867
|
+
declare enum MonitorBehaviorConfigBehavior {
|
|
1868
|
+
override = "override",
|
|
1869
|
+
append = "append"
|
|
1870
|
+
}
|
|
1196
1871
|
declare enum MonitorRunObject {
|
|
1197
1872
|
monitor_run = "monitor_run"
|
|
1198
1873
|
}
|
|
@@ -1223,10 +1898,30 @@ declare enum WebhookAttemptEventType {
|
|
|
1223
1898
|
webset_search_canceled = "webset.search.canceled",
|
|
1224
1899
|
webset_search_completed = "webset.search.completed",
|
|
1225
1900
|
webset_search_updated = "webset.search.updated",
|
|
1226
|
-
|
|
1227
|
-
|
|
1901
|
+
import_created = "import.created",
|
|
1902
|
+
import_completed = "import.completed",
|
|
1903
|
+
import_processing = "import.processing",
|
|
1228
1904
|
webset_item_created = "webset.item.created",
|
|
1229
|
-
webset_item_enriched = "webset.item.enriched"
|
|
1905
|
+
webset_item_enriched = "webset.item.enriched",
|
|
1906
|
+
webset_export_created = "webset.export.created",
|
|
1907
|
+
webset_export_completed = "webset.export.completed"
|
|
1908
|
+
}
|
|
1909
|
+
declare enum WebsetImportsFormat {
|
|
1910
|
+
csv = "csv",
|
|
1911
|
+
webset = "webset"
|
|
1912
|
+
}
|
|
1913
|
+
declare enum WebsetImportsFailedReason {
|
|
1914
|
+
file_not_uploaded = "file_not_uploaded",
|
|
1915
|
+
invalid_format = "invalid_format",
|
|
1916
|
+
invalid_file_content = "invalid_file_content",
|
|
1917
|
+
missing_identifier = "missing_identifier"
|
|
1918
|
+
}
|
|
1919
|
+
declare enum WebsetImportsStatus {
|
|
1920
|
+
created = "created",
|
|
1921
|
+
failed = "failed",
|
|
1922
|
+
processing = "processing",
|
|
1923
|
+
scheduled = "scheduled",
|
|
1924
|
+
completed = "completed"
|
|
1230
1925
|
}
|
|
1231
1926
|
declare enum WebsetStatus {
|
|
1232
1927
|
idle = "idle",
|
|
@@ -1255,6 +1950,10 @@ declare enum WebsetItemEvaluationSatisfied {
|
|
|
1255
1950
|
no = "no",
|
|
1256
1951
|
unclear = "unclear"
|
|
1257
1952
|
}
|
|
1953
|
+
declare enum WebsetSearchExcludeSource {
|
|
1954
|
+
import = "import",
|
|
1955
|
+
webset = "webset"
|
|
1956
|
+
}
|
|
1258
1957
|
declare enum WebsetSearchStatus {
|
|
1259
1958
|
created = "created",
|
|
1260
1959
|
running = "running",
|
|
@@ -1348,6 +2047,100 @@ declare class EventsClient extends WebsetsBaseClient {
|
|
|
1348
2047
|
get(id: string): Promise<Event>;
|
|
1349
2048
|
}
|
|
1350
2049
|
|
|
2050
|
+
/**
|
|
2051
|
+
* Options for waiting until import completion
|
|
2052
|
+
*/
|
|
2053
|
+
interface WaitUntilCompletedOptions {
|
|
2054
|
+
/**
|
|
2055
|
+
* Maximum time to wait in milliseconds (default: 5 minutes)
|
|
2056
|
+
*/
|
|
2057
|
+
timeout?: number;
|
|
2058
|
+
/**
|
|
2059
|
+
* How often to poll for status in milliseconds (default: 2 seconds)
|
|
2060
|
+
*/
|
|
2061
|
+
pollInterval?: number;
|
|
2062
|
+
/**
|
|
2063
|
+
* Callback function called on each poll with the current status
|
|
2064
|
+
*/
|
|
2065
|
+
onPoll?: (status: ImportStatus) => void;
|
|
2066
|
+
}
|
|
2067
|
+
/**
|
|
2068
|
+
* Parameters for creating an import with CSV data
|
|
2069
|
+
*/
|
|
2070
|
+
interface CreateImportWithCsvParameters {
|
|
2071
|
+
/**
|
|
2072
|
+
* Title of the import
|
|
2073
|
+
*/
|
|
2074
|
+
title: string;
|
|
2075
|
+
/**
|
|
2076
|
+
* Entity type and configuration
|
|
2077
|
+
*/
|
|
2078
|
+
entity: CreateImportParameters["entity"];
|
|
2079
|
+
/**
|
|
2080
|
+
* Optional metadata
|
|
2081
|
+
*/
|
|
2082
|
+
metadata?: CreateImportParameters["metadata"];
|
|
2083
|
+
/**
|
|
2084
|
+
* Optional CSV-specific parameters
|
|
2085
|
+
*/
|
|
2086
|
+
csv?: CreateImportParameters["csv"];
|
|
2087
|
+
}
|
|
2088
|
+
/**
|
|
2089
|
+
* CSV data input - can be raw data or buffer
|
|
2090
|
+
*/
|
|
2091
|
+
type CsvDataInput = string | Buffer;
|
|
2092
|
+
/**
|
|
2093
|
+
* Client for managing Imports
|
|
2094
|
+
*/
|
|
2095
|
+
declare class ImportsClient extends WebsetsBaseClient {
|
|
2096
|
+
/**
|
|
2097
|
+
* Create a new Import (basic version - returns upload URL)
|
|
2098
|
+
* @param params The import creation parameters
|
|
2099
|
+
* @returns The created Import response with upload URL
|
|
2100
|
+
*/
|
|
2101
|
+
create(params: CreateImportParameters): Promise<CreateImportResponse>;
|
|
2102
|
+
/**
|
|
2103
|
+
* Create a new Import with CSV data (handles upload)
|
|
2104
|
+
* @param params The import creation parameters (without size/count - calculated automatically)
|
|
2105
|
+
* @param csv CSV data as string or Buffer
|
|
2106
|
+
* @returns The Import after upload (not waited for completion)
|
|
2107
|
+
*/
|
|
2108
|
+
create(params: CreateImportWithCsvParameters, csv: CsvDataInput): Promise<Import>;
|
|
2109
|
+
/**
|
|
2110
|
+
* Get an Import by ID
|
|
2111
|
+
* @param id The ID of the Import
|
|
2112
|
+
* @returns The Import
|
|
2113
|
+
*/
|
|
2114
|
+
get(id: string): Promise<Import>;
|
|
2115
|
+
/**
|
|
2116
|
+
* List all Imports
|
|
2117
|
+
* @param options Pagination options
|
|
2118
|
+
* @returns The list of Imports
|
|
2119
|
+
*/
|
|
2120
|
+
list(options?: PaginationParams): Promise<ListImportsResponse>;
|
|
2121
|
+
/**
|
|
2122
|
+
* Update an Import
|
|
2123
|
+
* @param id The ID of the Import
|
|
2124
|
+
* @param params The import update parameters
|
|
2125
|
+
* @returns The updated Import
|
|
2126
|
+
*/
|
|
2127
|
+
update(id: string, params: UpdateImport): Promise<Import>;
|
|
2128
|
+
/**
|
|
2129
|
+
* Delete an Import
|
|
2130
|
+
* @param id The ID of the Import
|
|
2131
|
+
* @returns The deleted Import
|
|
2132
|
+
*/
|
|
2133
|
+
delete(id: string): Promise<Import>;
|
|
2134
|
+
/**
|
|
2135
|
+
* Wait until an Import is completed or failed
|
|
2136
|
+
* @param id The ID of the Import
|
|
2137
|
+
* @param options Configuration options for timeout and polling
|
|
2138
|
+
* @returns The Import once it reaches a final state (completed or failed)
|
|
2139
|
+
* @throws Error if the Import does not complete within the timeout or fails
|
|
2140
|
+
*/
|
|
2141
|
+
waitUntilCompleted(id: string, options?: WaitUntilCompletedOptions): Promise<Import>;
|
|
2142
|
+
}
|
|
2143
|
+
|
|
1351
2144
|
/**
|
|
1352
2145
|
* Client for managing Webset Items
|
|
1353
2146
|
*/
|
|
@@ -1603,6 +2396,10 @@ declare class WebsetsClient extends WebsetsBaseClient {
|
|
|
1603
2396
|
* Client for managing Events
|
|
1604
2397
|
*/
|
|
1605
2398
|
events: EventsClient;
|
|
2399
|
+
/**
|
|
2400
|
+
* Client for managing Imports
|
|
2401
|
+
*/
|
|
2402
|
+
imports: ImportsClient;
|
|
1606
2403
|
/**
|
|
1607
2404
|
* Client for managing Webset Items
|
|
1608
2405
|
*/
|
|
@@ -1749,7 +2546,7 @@ declare class ResearchClient extends ResearchBaseClient {
|
|
|
1749
2546
|
*/
|
|
1750
2547
|
createTask(params: {
|
|
1751
2548
|
instructions: string;
|
|
1752
|
-
model?: "exa-research" | "exa-research-pro"
|
|
2549
|
+
model?: "exa-research" | "exa-research-pro";
|
|
1753
2550
|
output?: {
|
|
1754
2551
|
inferSchema?: boolean;
|
|
1755
2552
|
schema?: JSONSchema;
|
|
@@ -1811,12 +2608,12 @@ interface components {
|
|
|
1811
2608
|
input: string;
|
|
1812
2609
|
instructions?: string;
|
|
1813
2610
|
/** @enum {string} */
|
|
1814
|
-
model:
|
|
2611
|
+
model: "exa-research" | "exa-research-pro";
|
|
1815
2612
|
stream?: boolean;
|
|
1816
2613
|
text?: {
|
|
1817
2614
|
format?: {
|
|
1818
2615
|
/** @enum {string} */
|
|
1819
|
-
type:
|
|
2616
|
+
type: "text";
|
|
1820
2617
|
} | {
|
|
1821
2618
|
description?: string;
|
|
1822
2619
|
name?: string;
|
|
@@ -1825,7 +2622,7 @@ interface components {
|
|
|
1825
2622
|
};
|
|
1826
2623
|
strict?: boolean;
|
|
1827
2624
|
/** @enum {string} */
|
|
1828
|
-
type:
|
|
2625
|
+
type: "json_schema";
|
|
1829
2626
|
};
|
|
1830
2627
|
};
|
|
1831
2628
|
};
|
|
@@ -1839,7 +2636,7 @@ interface components {
|
|
|
1839
2636
|
* @default exa-research
|
|
1840
2637
|
* @enum {string}
|
|
1841
2638
|
*/
|
|
1842
|
-
model:
|
|
2639
|
+
model: "exa-research" | "exa-research-pro";
|
|
1843
2640
|
output?: {
|
|
1844
2641
|
/**
|
|
1845
2642
|
* @description When true and an output schema is omitted, an output schema will be intelligently generated. Otherwise, if this is false and there is no output schema, a generic markdown report will be generated.
|
|
@@ -1886,13 +2683,13 @@ interface components {
|
|
|
1886
2683
|
/** @description The instructions or query for the research task */
|
|
1887
2684
|
instructions: string;
|
|
1888
2685
|
/** @enum {string} */
|
|
1889
|
-
model?:
|
|
2686
|
+
model?: "exa-research" | "exa-research-pro";
|
|
1890
2687
|
operations: ({
|
|
1891
2688
|
stepId: string;
|
|
1892
2689
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
1893
2690
|
text: string;
|
|
1894
2691
|
/** @enum {string} */
|
|
1895
|
-
type:
|
|
2692
|
+
type: "step-plan";
|
|
1896
2693
|
} | {
|
|
1897
2694
|
/** @description A completed subfield */
|
|
1898
2695
|
data: {
|
|
@@ -1900,7 +2697,7 @@ interface components {
|
|
|
1900
2697
|
};
|
|
1901
2698
|
stepId: string;
|
|
1902
2699
|
/** @enum {string} */
|
|
1903
|
-
type:
|
|
2700
|
+
type: "step-data";
|
|
1904
2701
|
} | {
|
|
1905
2702
|
/** @description What the agent hopes to find with this search query */
|
|
1906
2703
|
goal?: string;
|
|
@@ -1912,24 +2709,24 @@ interface components {
|
|
|
1912
2709
|
title?: string;
|
|
1913
2710
|
url: string;
|
|
1914
2711
|
/** @enum {number} */
|
|
1915
|
-
version:
|
|
2712
|
+
version: 1;
|
|
1916
2713
|
}[];
|
|
1917
2714
|
stepId: string;
|
|
1918
2715
|
/** @enum {string} */
|
|
1919
|
-
type:
|
|
2716
|
+
type: "search";
|
|
1920
2717
|
} | {
|
|
1921
2718
|
/** @description What the agent hopes to find with this crawl */
|
|
1922
2719
|
goal?: string;
|
|
1923
2720
|
stepId: string;
|
|
1924
2721
|
/** @enum {string} */
|
|
1925
|
-
type:
|
|
2722
|
+
type: "crawl";
|
|
1926
2723
|
url: string;
|
|
1927
2724
|
} | {
|
|
1928
2725
|
stepId: string;
|
|
1929
2726
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
1930
2727
|
thought: string;
|
|
1931
2728
|
/** @enum {string} */
|
|
1932
|
-
type:
|
|
2729
|
+
type: "think";
|
|
1933
2730
|
})[];
|
|
1934
2731
|
/** @description The JSON schema specification for the expected output format */
|
|
1935
2732
|
schema?: {
|
|
@@ -1939,7 +2736,7 @@ interface components {
|
|
|
1939
2736
|
* @description The current status of the research task
|
|
1940
2737
|
* @enum {string}
|
|
1941
2738
|
*/
|
|
1942
|
-
status:
|
|
2739
|
+
status: "running" | "completed" | "failed";
|
|
1943
2740
|
timeMs?: number;
|
|
1944
2741
|
};
|
|
1945
2742
|
ResearchTaskEventDto: {
|
|
@@ -1948,7 +2745,7 @@ interface components {
|
|
|
1948
2745
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
1949
2746
|
text: string;
|
|
1950
2747
|
/** @enum {string} */
|
|
1951
|
-
type:
|
|
2748
|
+
type: "step-plan";
|
|
1952
2749
|
} | {
|
|
1953
2750
|
/** @description A completed subfield */
|
|
1954
2751
|
data: {
|
|
@@ -1956,7 +2753,7 @@ interface components {
|
|
|
1956
2753
|
};
|
|
1957
2754
|
stepId: string;
|
|
1958
2755
|
/** @enum {string} */
|
|
1959
|
-
type:
|
|
2756
|
+
type: "step-data";
|
|
1960
2757
|
} | {
|
|
1961
2758
|
/** @description What the agent hopes to find with this search query */
|
|
1962
2759
|
goal?: string;
|
|
@@ -1968,27 +2765,27 @@ interface components {
|
|
|
1968
2765
|
title?: string;
|
|
1969
2766
|
url: string;
|
|
1970
2767
|
/** @enum {number} */
|
|
1971
|
-
version:
|
|
2768
|
+
version: 1;
|
|
1972
2769
|
}[];
|
|
1973
2770
|
stepId: string;
|
|
1974
2771
|
/** @enum {string} */
|
|
1975
|
-
type:
|
|
2772
|
+
type: "search";
|
|
1976
2773
|
} | {
|
|
1977
2774
|
/** @description What the agent hopes to find with this crawl */
|
|
1978
2775
|
goal?: string;
|
|
1979
2776
|
stepId: string;
|
|
1980
2777
|
/** @enum {string} */
|
|
1981
|
-
type:
|
|
2778
|
+
type: "crawl";
|
|
1982
2779
|
url: string;
|
|
1983
2780
|
} | {
|
|
1984
2781
|
stepId: string;
|
|
1985
2782
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
1986
2783
|
thought: string;
|
|
1987
2784
|
/** @enum {string} */
|
|
1988
|
-
type:
|
|
2785
|
+
type: "think";
|
|
1989
2786
|
};
|
|
1990
2787
|
/** @enum {string} */
|
|
1991
|
-
type:
|
|
2788
|
+
type: "operation";
|
|
1992
2789
|
} | {
|
|
1993
2790
|
task: {
|
|
1994
2791
|
/** @description Citations grouped by the root field they were used in */
|
|
@@ -2019,13 +2816,13 @@ interface components {
|
|
|
2019
2816
|
/** @description The instructions or query for the research task */
|
|
2020
2817
|
instructions: string;
|
|
2021
2818
|
/** @enum {string} */
|
|
2022
|
-
model?:
|
|
2819
|
+
model?: "exa-research" | "exa-research-pro";
|
|
2023
2820
|
operations: ({
|
|
2024
2821
|
stepId: string;
|
|
2025
2822
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
2026
2823
|
text: string;
|
|
2027
2824
|
/** @enum {string} */
|
|
2028
|
-
type:
|
|
2825
|
+
type: "step-plan";
|
|
2029
2826
|
} | {
|
|
2030
2827
|
/** @description A completed subfield */
|
|
2031
2828
|
data: {
|
|
@@ -2033,7 +2830,7 @@ interface components {
|
|
|
2033
2830
|
};
|
|
2034
2831
|
stepId: string;
|
|
2035
2832
|
/** @enum {string} */
|
|
2036
|
-
type:
|
|
2833
|
+
type: "step-data";
|
|
2037
2834
|
} | {
|
|
2038
2835
|
/** @description What the agent hopes to find with this search query */
|
|
2039
2836
|
goal?: string;
|
|
@@ -2045,24 +2842,24 @@ interface components {
|
|
|
2045
2842
|
title?: string;
|
|
2046
2843
|
url: string;
|
|
2047
2844
|
/** @enum {number} */
|
|
2048
|
-
version:
|
|
2845
|
+
version: 1;
|
|
2049
2846
|
}[];
|
|
2050
2847
|
stepId: string;
|
|
2051
2848
|
/** @enum {string} */
|
|
2052
|
-
type:
|
|
2849
|
+
type: "search";
|
|
2053
2850
|
} | {
|
|
2054
2851
|
/** @description What the agent hopes to find with this crawl */
|
|
2055
2852
|
goal?: string;
|
|
2056
2853
|
stepId: string;
|
|
2057
2854
|
/** @enum {string} */
|
|
2058
|
-
type:
|
|
2855
|
+
type: "crawl";
|
|
2059
2856
|
url: string;
|
|
2060
2857
|
} | {
|
|
2061
2858
|
stepId: string;
|
|
2062
2859
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
2063
2860
|
thought: string;
|
|
2064
2861
|
/** @enum {string} */
|
|
2065
|
-
type:
|
|
2862
|
+
type: "think";
|
|
2066
2863
|
})[];
|
|
2067
2864
|
/** @description The JSON schema specification for the expected output format */
|
|
2068
2865
|
schema?: {
|
|
@@ -2072,18 +2869,18 @@ interface components {
|
|
|
2072
2869
|
* @description The current status of the research task
|
|
2073
2870
|
* @enum {string}
|
|
2074
2871
|
*/
|
|
2075
|
-
status:
|
|
2872
|
+
status: "running" | "completed" | "failed";
|
|
2076
2873
|
timeMs?: number;
|
|
2077
2874
|
};
|
|
2078
2875
|
/** @enum {string} */
|
|
2079
|
-
type:
|
|
2876
|
+
type: "completed";
|
|
2080
2877
|
};
|
|
2081
2878
|
ResearchTaskOperationDto: {
|
|
2082
2879
|
stepId: string;
|
|
2083
2880
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
2084
2881
|
text: string;
|
|
2085
2882
|
/** @enum {string} */
|
|
2086
|
-
type:
|
|
2883
|
+
type: "step-plan";
|
|
2087
2884
|
} | {
|
|
2088
2885
|
/** @description A completed subfield */
|
|
2089
2886
|
data: {
|
|
@@ -2091,7 +2888,7 @@ interface components {
|
|
|
2091
2888
|
};
|
|
2092
2889
|
stepId: string;
|
|
2093
2890
|
/** @enum {string} */
|
|
2094
|
-
type:
|
|
2891
|
+
type: "step-data";
|
|
2095
2892
|
} | {
|
|
2096
2893
|
/** @description What the agent hopes to find with this search query */
|
|
2097
2894
|
goal?: string;
|
|
@@ -2103,24 +2900,24 @@ interface components {
|
|
|
2103
2900
|
title?: string;
|
|
2104
2901
|
url: string;
|
|
2105
2902
|
/** @enum {number} */
|
|
2106
|
-
version:
|
|
2903
|
+
version: 1;
|
|
2107
2904
|
}[];
|
|
2108
2905
|
stepId: string;
|
|
2109
2906
|
/** @enum {string} */
|
|
2110
|
-
type:
|
|
2907
|
+
type: "search";
|
|
2111
2908
|
} | {
|
|
2112
2909
|
/** @description What the agent hopes to find with this crawl */
|
|
2113
2910
|
goal?: string;
|
|
2114
2911
|
stepId: string;
|
|
2115
2912
|
/** @enum {string} */
|
|
2116
|
-
type:
|
|
2913
|
+
type: "crawl";
|
|
2117
2914
|
url: string;
|
|
2118
2915
|
} | {
|
|
2119
2916
|
stepId: string;
|
|
2120
2917
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
2121
2918
|
thought: string;
|
|
2122
2919
|
/** @enum {string} */
|
|
2123
|
-
type:
|
|
2920
|
+
type: "think";
|
|
2124
2921
|
};
|
|
2125
2922
|
};
|
|
2126
2923
|
responses: never;
|
|
@@ -2134,45 +2931,6 @@ type SchemaListResearchTasksResponseDto = components["schemas"]["ListResearchTas
|
|
|
2134
2931
|
type SchemaResearchCreateTaskRequestDto = components["schemas"]["ResearchCreateTaskRequestDto"];
|
|
2135
2932
|
type SchemaResearchCreateTaskResponseDto = components["schemas"]["ResearchCreateTaskResponseDto"];
|
|
2136
2933
|
type SchemaResearchTaskDto = components["schemas"]["ResearchTaskDto"];
|
|
2137
|
-
declare enum ResearchCreateOpenAIResponseDtoModel {
|
|
2138
|
-
exa_research = "exa-research",
|
|
2139
|
-
exa_research_pro = "exa-research-pro"
|
|
2140
|
-
}
|
|
2141
|
-
declare enum ResearchCreateOpenAIResponseDtoTextFormatType {
|
|
2142
|
-
text = "text"
|
|
2143
|
-
}
|
|
2144
|
-
declare enum ResearchCreateOpenAIResponseDtoTextFormatType {
|
|
2145
|
-
json_schema = "json_schema"
|
|
2146
|
-
}
|
|
2147
|
-
declare enum ResearchTaskDtoOperationsResultsVersion {
|
|
2148
|
-
Value1 = 1
|
|
2149
|
-
}
|
|
2150
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2151
|
-
step_plan = "step-plan"
|
|
2152
|
-
}
|
|
2153
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2154
|
-
step_data = "step-data"
|
|
2155
|
-
}
|
|
2156
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2157
|
-
search = "search"
|
|
2158
|
-
}
|
|
2159
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2160
|
-
crawl = "crawl"
|
|
2161
|
-
}
|
|
2162
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2163
|
-
think = "think"
|
|
2164
|
-
}
|
|
2165
|
-
declare enum ResearchTaskDtoStatus {
|
|
2166
|
-
running = "running",
|
|
2167
|
-
completed = "completed",
|
|
2168
|
-
failed = "failed"
|
|
2169
|
-
}
|
|
2170
|
-
declare enum ResearchTaskEventDtoType {
|
|
2171
|
-
operation = "operation"
|
|
2172
|
-
}
|
|
2173
|
-
declare enum ResearchTaskEventDtoType {
|
|
2174
|
-
completed = "completed"
|
|
2175
|
-
}
|
|
2176
2934
|
|
|
2177
2935
|
type ResearchTaskEvent = components["schemas"]["ResearchTaskEventDto"];
|
|
2178
2936
|
type ResearchTaskOperation = SchemaResearchTaskDto["operations"][0];
|
|
@@ -2673,4 +3431,4 @@ declare class Exa {
|
|
|
2673
3431
|
private parseSSEStream;
|
|
2674
3432
|
}
|
|
2675
3433
|
|
|
2676
|
-
export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, type CreateWebsetSearchParameters, type Default, type EnrichmentResult, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type JSONSchema, type ListEventsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type
|
|
3434
|
+
export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type ArticleEntity, type BaseSearchOptions, type CompanyEntity, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateImportParameters, CreateImportParametersFormat, type CreateImportResponse, type CreateImportWithCsvParameters, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, CreateWebsetParametersImportSource, CreateWebsetParametersSearchExcludeSource, type CreateWebsetSearchParameters, CreateWebsetSearchParametersExcludeSource, type CsvDataInput, type CustomEntity, type Default, type EnrichmentResult, type Entity, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type Import, ImportFailedReason, ImportFormat, ImportObject, ImportStatus, ImportsClient, type JSONSchema, type ListEventsResponse, type ListImportsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehavior, type MonitorCadence, MonitorObject, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type PersonEntity, type RegularSearchOptions, ResearchClient, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type ResearchPaperEntity, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
|