exa-js 1.8.1 → 1.8.4
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 +198 -150
- package/dist/index.d.ts +198 -150
- package/dist/index.js +137 -98
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +129 -96
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -79,12 +79,12 @@ interface components$1 {
|
|
|
79
79
|
label: string;
|
|
80
80
|
}[];
|
|
81
81
|
};
|
|
82
|
-
|
|
83
|
-
/** @description Behavior to perform when
|
|
84
|
-
behavior: components$1["schemas"]["
|
|
85
|
-
/** @description How often the
|
|
82
|
+
CreateMonitorParameters: {
|
|
83
|
+
/** @description Behavior to perform when monitor runs */
|
|
84
|
+
behavior: components$1["schemas"]["MonitorBehaviorSearch"] | components$1["schemas"]["MonitorBehaviorRefresh"];
|
|
85
|
+
/** @description How often the monitor will run */
|
|
86
86
|
cadence: {
|
|
87
|
-
/** @description Cron expression for
|
|
87
|
+
/** @description Cron expression for monitor cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day. */
|
|
88
88
|
cron: string;
|
|
89
89
|
/**
|
|
90
90
|
* @description IANA timezone (e.g., "America/New_York")
|
|
@@ -155,7 +155,7 @@ interface components$1 {
|
|
|
155
155
|
* - `append`: the search will add the new Items found to the existing Webset. Any Items that don't match the new criteria will be discarded.
|
|
156
156
|
* @default override
|
|
157
157
|
*/
|
|
158
|
-
behavior: WebsetSearchBehavior;
|
|
158
|
+
behavior: components$1["schemas"]["WebsetSearchBehavior"];
|
|
159
159
|
/** @description Number of Items the Search will attempt to find.
|
|
160
160
|
*
|
|
161
161
|
* The actual number of Items found may be less than this number depending on the query complexity. */
|
|
@@ -406,17 +406,17 @@ interface components$1 {
|
|
|
406
406
|
/** @description The cursor to paginate through the next set of results */
|
|
407
407
|
nextCursor: string | null;
|
|
408
408
|
};
|
|
409
|
-
|
|
410
|
-
/** @description The list of
|
|
411
|
-
data: components$1["schemas"]["
|
|
409
|
+
ListMonitorRunsResponse: {
|
|
410
|
+
/** @description The list of monitor runs */
|
|
411
|
+
data: components$1["schemas"]["MonitorRun"][];
|
|
412
412
|
/** @description Whether there are more results to paginate through */
|
|
413
413
|
hasMore: boolean;
|
|
414
414
|
/** @description The cursor to paginate through the next set of results */
|
|
415
415
|
nextCursor: string | null;
|
|
416
416
|
};
|
|
417
|
-
|
|
418
|
-
/** @description The list of
|
|
419
|
-
data: components$1["schemas"]["
|
|
417
|
+
ListMonitorsResponse: {
|
|
418
|
+
/** @description The list of monitors */
|
|
419
|
+
data: components$1["schemas"]["Monitor"][];
|
|
420
420
|
/** @description Whether there are more results to paginate through */
|
|
421
421
|
hasMore: boolean;
|
|
422
422
|
/** @description The cursor to paginate through the next set of results */
|
|
@@ -454,12 +454,12 @@ interface components$1 {
|
|
|
454
454
|
/** @description The cursor to paginate through the next set of results */
|
|
455
455
|
nextCursor: string | null;
|
|
456
456
|
};
|
|
457
|
-
|
|
458
|
-
/** @description Behavior to perform when
|
|
459
|
-
behavior: components$1["schemas"]["
|
|
460
|
-
/** @description How often the
|
|
457
|
+
Monitor: {
|
|
458
|
+
/** @description Behavior to perform when monitor runs */
|
|
459
|
+
behavior: components$1["schemas"]["MonitorBehaviorSearch"] | components$1["schemas"]["MonitorBehaviorRefresh"];
|
|
460
|
+
/** @description How often the monitor will run */
|
|
461
461
|
cadence: {
|
|
462
|
-
/** @description Cron expression for
|
|
462
|
+
/** @description Cron expression for monitor cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day. */
|
|
463
463
|
cron: string;
|
|
464
464
|
/**
|
|
465
465
|
* @description IANA timezone (e.g., "America/New_York")
|
|
@@ -469,16 +469,16 @@ interface components$1 {
|
|
|
469
469
|
};
|
|
470
470
|
/**
|
|
471
471
|
* Format: date-time
|
|
472
|
-
* @description When the
|
|
472
|
+
* @description When the monitor was created
|
|
473
473
|
*/
|
|
474
474
|
createdAt: string;
|
|
475
|
-
/** @description The unique identifier for the
|
|
475
|
+
/** @description The unique identifier for the Monitor */
|
|
476
476
|
id: string;
|
|
477
477
|
/**
|
|
478
|
-
*
|
|
479
|
-
* @description The last run of the
|
|
478
|
+
* MonitorRun
|
|
479
|
+
* @description The last run of the monitor
|
|
480
480
|
*/
|
|
481
|
-
lastRun: components$1["schemas"]["
|
|
481
|
+
lastRun: components$1["schemas"]["MonitorRun"];
|
|
482
482
|
/** @description Set of key-value pairs you want to associate with this object. */
|
|
483
483
|
metadata: {
|
|
484
484
|
[key: string]: string;
|
|
@@ -492,36 +492,36 @@ interface components$1 {
|
|
|
492
492
|
* @description The type of object
|
|
493
493
|
* @enum {string}
|
|
494
494
|
*/
|
|
495
|
-
object:
|
|
495
|
+
object: MonitorObject;
|
|
496
496
|
/**
|
|
497
|
-
* @description The status of the
|
|
497
|
+
* @description The status of the Monitor
|
|
498
498
|
* @enum {string}
|
|
499
499
|
*/
|
|
500
|
-
status:
|
|
500
|
+
status: MonitorStatus;
|
|
501
501
|
/**
|
|
502
502
|
* Format: date-time
|
|
503
|
-
* @description When the
|
|
503
|
+
* @description When the monitor was last updated
|
|
504
504
|
*/
|
|
505
505
|
updatedAt: string;
|
|
506
|
-
/** @description The id of the Webset the
|
|
506
|
+
/** @description The id of the Webset the Monitor belongs to */
|
|
507
507
|
websetId: string;
|
|
508
508
|
};
|
|
509
|
-
|
|
509
|
+
MonitorBehaviorRefresh: {
|
|
510
510
|
/** @description Specify the target of the refresh */
|
|
511
|
-
config: components$1["schemas"]["
|
|
511
|
+
config: components$1["schemas"]["MonitorRefreshBehaviorEnrichmentsConfig"] | components$1["schemas"]["MonitorRefreshBehaviorContentsConfig"];
|
|
512
512
|
/**
|
|
513
513
|
* @default refresh
|
|
514
514
|
* @constant
|
|
515
515
|
*/
|
|
516
516
|
type: "refresh";
|
|
517
517
|
};
|
|
518
|
-
|
|
518
|
+
MonitorBehaviorSearch: {
|
|
519
519
|
config: {
|
|
520
520
|
/**
|
|
521
521
|
* @description The behaviour of the Search when it is added to a Webset.
|
|
522
522
|
* @default append
|
|
523
523
|
*/
|
|
524
|
-
behavior
|
|
524
|
+
behavior: components$1["schemas"]["WebsetSearchBehavior"];
|
|
525
525
|
/** @description The maximum number of results to find */
|
|
526
526
|
count: number;
|
|
527
527
|
criteria: {
|
|
@@ -537,8 +537,8 @@ interface components$1 {
|
|
|
537
537
|
*/
|
|
538
538
|
type: "search";
|
|
539
539
|
};
|
|
540
|
-
|
|
541
|
-
/** @description Cron expression for
|
|
540
|
+
MonitorCadence: {
|
|
541
|
+
/** @description Cron expression for monitor cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day. */
|
|
542
542
|
cron: string;
|
|
543
543
|
/**
|
|
544
544
|
* @description IANA timezone (e.g., "America/New_York")
|
|
@@ -546,14 +546,14 @@ interface components$1 {
|
|
|
546
546
|
*/
|
|
547
547
|
timezone: string;
|
|
548
548
|
};
|
|
549
|
-
|
|
549
|
+
MonitorRefreshBehaviorContentsConfig: {
|
|
550
550
|
/**
|
|
551
551
|
* @default contents
|
|
552
552
|
* @constant
|
|
553
553
|
*/
|
|
554
554
|
target: "contents";
|
|
555
555
|
};
|
|
556
|
-
|
|
556
|
+
MonitorRefreshBehaviorEnrichmentsConfig: {
|
|
557
557
|
/** @description Only refresh specific enrichments */
|
|
558
558
|
enrichments?: {
|
|
559
559
|
ids?: string[];
|
|
@@ -564,7 +564,7 @@ interface components$1 {
|
|
|
564
564
|
*/
|
|
565
565
|
target: "enrichments";
|
|
566
566
|
};
|
|
567
|
-
|
|
567
|
+
MonitorRun: {
|
|
568
568
|
/**
|
|
569
569
|
* Format: date-time
|
|
570
570
|
* @description When the run was canceled
|
|
@@ -585,40 +585,40 @@ interface components$1 {
|
|
|
585
585
|
* @description When the run failed
|
|
586
586
|
*/
|
|
587
587
|
failedAt: string | null;
|
|
588
|
-
/** @description The unique identifier for the
|
|
588
|
+
/** @description The unique identifier for the Monitor Run */
|
|
589
589
|
id: string;
|
|
590
|
+
/** @description The monitor that the run is associated with */
|
|
591
|
+
monitorId: string;
|
|
590
592
|
/**
|
|
591
593
|
* @description The type of object
|
|
592
594
|
* @enum {string}
|
|
593
595
|
*/
|
|
594
|
-
object:
|
|
596
|
+
object: MonitorRunObject;
|
|
595
597
|
/**
|
|
596
|
-
* @description The status of the
|
|
598
|
+
* @description The status of the Monitor Run
|
|
597
599
|
* @enum {string}
|
|
598
600
|
*/
|
|
599
|
-
status:
|
|
600
|
-
/** @description The stream that the run is associated with */
|
|
601
|
-
streamId: string;
|
|
601
|
+
status: MonitorRunStatus;
|
|
602
602
|
/**
|
|
603
|
-
* @description The type of the
|
|
603
|
+
* @description The type of the Monitor Run
|
|
604
604
|
* @enum {string}
|
|
605
605
|
*/
|
|
606
|
-
type:
|
|
606
|
+
type: MonitorRunType;
|
|
607
607
|
/**
|
|
608
608
|
* Format: date-time
|
|
609
609
|
* @description When the run was last updated
|
|
610
610
|
*/
|
|
611
611
|
updatedAt: string;
|
|
612
612
|
};
|
|
613
|
-
|
|
613
|
+
UpdateMonitor: {
|
|
614
614
|
metadata?: {
|
|
615
615
|
[key: string]: string;
|
|
616
616
|
};
|
|
617
617
|
/**
|
|
618
|
-
* @description The status of the
|
|
618
|
+
* @description The status of the monitor.
|
|
619
619
|
* @enum {string}
|
|
620
620
|
*/
|
|
621
|
-
status?:
|
|
621
|
+
status?: UpdateMonitorStatus;
|
|
622
622
|
};
|
|
623
623
|
UpdateWebhookParameters: {
|
|
624
624
|
/** @description The events to trigger the webhook */
|
|
@@ -694,7 +694,7 @@ interface components$1 {
|
|
|
694
694
|
* @description The type of event
|
|
695
695
|
* @enum {string}
|
|
696
696
|
*/
|
|
697
|
-
eventType:
|
|
697
|
+
eventType: WebhookAttemptEventType;
|
|
698
698
|
/** @description The unique identifier for the webhook attempt */
|
|
699
699
|
id: string;
|
|
700
700
|
/**
|
|
@@ -736,6 +736,8 @@ interface components$1 {
|
|
|
736
736
|
metadata: {
|
|
737
737
|
[key: string]: string;
|
|
738
738
|
};
|
|
739
|
+
/** @description The Monitors for the Webset. */
|
|
740
|
+
monitors: components$1["schemas"]["Monitor"][];
|
|
739
741
|
/**
|
|
740
742
|
* @default webset
|
|
741
743
|
* @constant
|
|
@@ -749,8 +751,6 @@ interface components$1 {
|
|
|
749
751
|
* @enum {string}
|
|
750
752
|
*/
|
|
751
753
|
status: WebsetStatus;
|
|
752
|
-
/** @description The Streams for the Webset. */
|
|
753
|
-
streams: components$1["schemas"]["Stream"][];
|
|
754
754
|
/**
|
|
755
755
|
* Format: date-time
|
|
756
756
|
* @description The date and time the webset was updated
|
|
@@ -1048,14 +1048,14 @@ interface components$1 {
|
|
|
1048
1048
|
* - `append`: the search will add the new Items found to the existing Webset. Any Items that don't match the new criteria will be discarded.
|
|
1049
1049
|
* @default override
|
|
1050
1050
|
*/
|
|
1051
|
-
behavior: WebsetSearchBehavior;
|
|
1051
|
+
behavior: components$1["schemas"]["WebsetSearchBehavior"];
|
|
1052
1052
|
/**
|
|
1053
1053
|
* Format: date-time
|
|
1054
1054
|
* @description The date and time the search was canceled
|
|
1055
1055
|
*/
|
|
1056
1056
|
canceledAt: string | null;
|
|
1057
1057
|
/** @description The reason the search was canceled */
|
|
1058
|
-
canceledReason: WebsetSearchCanceledReason
|
|
1058
|
+
canceledReason: components$1["schemas"]["WebsetSearchCanceledReason"];
|
|
1059
1059
|
/** @description The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity. */
|
|
1060
1060
|
count: number;
|
|
1061
1061
|
/**
|
|
@@ -1109,6 +1109,10 @@ interface components$1 {
|
|
|
1109
1109
|
*/
|
|
1110
1110
|
updatedAt: string;
|
|
1111
1111
|
};
|
|
1112
|
+
/** @enum {string} */
|
|
1113
|
+
WebsetSearchBehavior: WebsetSearchBehavior;
|
|
1114
|
+
/** @enum {string} */
|
|
1115
|
+
WebsetSearchCanceledReason: WebsetSearchCanceledReason;
|
|
1112
1116
|
};
|
|
1113
1117
|
responses: never;
|
|
1114
1118
|
parameters: never;
|
|
@@ -1116,8 +1120,9 @@ interface components$1 {
|
|
|
1116
1120
|
headers: never;
|
|
1117
1121
|
pathItems: never;
|
|
1118
1122
|
}
|
|
1123
|
+
type CreateCriterionParameters = components$1["schemas"]["CreateCriterionParameters"];
|
|
1119
1124
|
type CreateEnrichmentParameters = components$1["schemas"]["CreateEnrichmentParameters"];
|
|
1120
|
-
type
|
|
1125
|
+
type CreateMonitorParameters = components$1["schemas"]["CreateMonitorParameters"];
|
|
1121
1126
|
type CreateWebhookParameters = components$1["schemas"]["CreateWebhookParameters"];
|
|
1122
1127
|
type CreateWebsetParameters = components$1["schemas"]["CreateWebsetParameters"];
|
|
1123
1128
|
type CreateWebsetSearchParameters = components$1["schemas"]["CreateWebsetSearchParameters"];
|
|
@@ -1125,22 +1130,39 @@ type EnrichmentResult = components$1["schemas"]["EnrichmentResult"];
|
|
|
1125
1130
|
type Event = components$1["schemas"]["Event"];
|
|
1126
1131
|
type GetWebsetResponse = components$1["schemas"]["GetWebsetResponse"];
|
|
1127
1132
|
type ListEventsResponse = components$1["schemas"]["ListEventsResponse"];
|
|
1128
|
-
type
|
|
1129
|
-
type
|
|
1133
|
+
type ListMonitorRunsResponse = components$1["schemas"]["ListMonitorRunsResponse"];
|
|
1134
|
+
type ListMonitorsResponse = components$1["schemas"]["ListMonitorsResponse"];
|
|
1130
1135
|
type ListWebhookAttemptsResponse = components$1["schemas"]["ListWebhookAttemptsResponse"];
|
|
1131
1136
|
type ListWebhooksResponse = components$1["schemas"]["ListWebhooksResponse"];
|
|
1132
1137
|
type ListWebsetItemResponse = components$1["schemas"]["ListWebsetItemResponse"];
|
|
1133
1138
|
type ListWebsetsResponse = components$1["schemas"]["ListWebsetsResponse"];
|
|
1134
|
-
type
|
|
1135
|
-
type
|
|
1136
|
-
type
|
|
1139
|
+
type Monitor = components$1["schemas"]["Monitor"];
|
|
1140
|
+
type MonitorBehaviorRefresh = components$1["schemas"]["MonitorBehaviorRefresh"];
|
|
1141
|
+
type MonitorBehaviorSearch = components$1["schemas"]["MonitorBehaviorSearch"];
|
|
1142
|
+
type MonitorCadence = components$1["schemas"]["MonitorCadence"];
|
|
1143
|
+
type MonitorRefreshBehaviorContentsConfig = components$1["schemas"]["MonitorRefreshBehaviorContentsConfig"];
|
|
1144
|
+
type MonitorRefreshBehaviorEnrichmentsConfig = components$1["schemas"]["MonitorRefreshBehaviorEnrichmentsConfig"];
|
|
1145
|
+
type MonitorRun = components$1["schemas"]["MonitorRun"];
|
|
1146
|
+
type UpdateMonitor = components$1["schemas"]["UpdateMonitor"];
|
|
1137
1147
|
type UpdateWebhookParameters = components$1["schemas"]["UpdateWebhookParameters"];
|
|
1138
1148
|
type UpdateWebsetRequest = components$1["schemas"]["UpdateWebsetRequest"];
|
|
1139
1149
|
type Webhook = components$1["schemas"]["Webhook"];
|
|
1140
1150
|
type WebhookAttempt = components$1["schemas"]["WebhookAttempt"];
|
|
1141
1151
|
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"];
|
|
1142
1155
|
type WebsetEnrichment = components$1["schemas"]["WebsetEnrichment"];
|
|
1156
|
+
type WebsetEntity = components$1["schemas"]["WebsetEntity"];
|
|
1143
1157
|
type WebsetItem = components$1["schemas"]["WebsetItem"];
|
|
1158
|
+
type WebsetItemArticleProperties = components$1["schemas"]["WebsetItemArticleProperties"];
|
|
1159
|
+
type WebsetItemCompanyProperties = components$1["schemas"]["WebsetItemCompanyProperties"];
|
|
1160
|
+
type WebsetItemCustomProperties = components$1["schemas"]["WebsetItemCustomProperties"];
|
|
1161
|
+
type WebsetItemEvaluation = components$1["schemas"]["WebsetItemEvaluation"];
|
|
1162
|
+
type WebsetItemPersonProperties = components$1["schemas"]["WebsetItemPersonProperties"];
|
|
1163
|
+
type WebsetItemResearchPaperProperties = components$1["schemas"]["WebsetItemResearchPaperProperties"];
|
|
1164
|
+
type WebsetPersonEntity = components$1["schemas"]["WebsetPersonEntity"];
|
|
1165
|
+
type WebsetResearchPaperEntity = components$1["schemas"]["WebsetResearchPaperEntity"];
|
|
1144
1166
|
type WebsetSearch = components$1["schemas"]["WebsetSearch"];
|
|
1145
1167
|
declare enum CreateEnrichmentParametersFormat {
|
|
1146
1168
|
text = "text",
|
|
@@ -1164,34 +1186,48 @@ declare enum EventType {
|
|
|
1164
1186
|
webset_item_created = "webset.item.created",
|
|
1165
1187
|
webset_item_enriched = "webset.item.enriched"
|
|
1166
1188
|
}
|
|
1167
|
-
declare enum
|
|
1168
|
-
|
|
1189
|
+
declare enum MonitorObject {
|
|
1190
|
+
monitor = "monitor"
|
|
1169
1191
|
}
|
|
1170
|
-
declare enum
|
|
1171
|
-
|
|
1172
|
-
|
|
1192
|
+
declare enum MonitorStatus {
|
|
1193
|
+
enabled = "enabled",
|
|
1194
|
+
disabled = "disabled"
|
|
1173
1195
|
}
|
|
1174
|
-
declare enum
|
|
1175
|
-
|
|
1196
|
+
declare enum MonitorRunObject {
|
|
1197
|
+
monitor_run = "monitor_run"
|
|
1176
1198
|
}
|
|
1177
|
-
declare enum
|
|
1199
|
+
declare enum MonitorRunStatus {
|
|
1178
1200
|
created = "created",
|
|
1179
1201
|
running = "running",
|
|
1180
1202
|
completed = "completed",
|
|
1181
1203
|
canceled = "canceled"
|
|
1182
1204
|
}
|
|
1183
|
-
declare enum
|
|
1205
|
+
declare enum MonitorRunType {
|
|
1184
1206
|
search = "search",
|
|
1185
1207
|
refresh = "refresh"
|
|
1186
1208
|
}
|
|
1187
|
-
declare enum
|
|
1188
|
-
|
|
1189
|
-
|
|
1209
|
+
declare enum UpdateMonitorStatus {
|
|
1210
|
+
enabled = "enabled",
|
|
1211
|
+
disabled = "disabled"
|
|
1190
1212
|
}
|
|
1191
1213
|
declare enum WebhookStatus {
|
|
1192
1214
|
active = "active",
|
|
1193
1215
|
inactive = "inactive"
|
|
1194
1216
|
}
|
|
1217
|
+
declare enum WebhookAttemptEventType {
|
|
1218
|
+
webset_created = "webset.created",
|
|
1219
|
+
webset_deleted = "webset.deleted",
|
|
1220
|
+
webset_paused = "webset.paused",
|
|
1221
|
+
webset_idle = "webset.idle",
|
|
1222
|
+
webset_search_created = "webset.search.created",
|
|
1223
|
+
webset_search_canceled = "webset.search.canceled",
|
|
1224
|
+
webset_search_completed = "webset.search.completed",
|
|
1225
|
+
webset_search_updated = "webset.search.updated",
|
|
1226
|
+
webset_export_created = "webset.export.created",
|
|
1227
|
+
webset_export_completed = "webset.export.completed",
|
|
1228
|
+
webset_item_created = "webset.item.created",
|
|
1229
|
+
webset_item_enriched = "webset.item.enriched"
|
|
1230
|
+
}
|
|
1195
1231
|
declare enum WebsetStatus {
|
|
1196
1232
|
idle = "idle",
|
|
1197
1233
|
running = "running",
|
|
@@ -1358,108 +1394,108 @@ declare class WebsetItemsClient extends WebsetsBaseClient {
|
|
|
1358
1394
|
}
|
|
1359
1395
|
|
|
1360
1396
|
/**
|
|
1361
|
-
* Client for managing Webset
|
|
1362
|
-
*/
|
|
1363
|
-
|
|
1364
|
-
/**
|
|
1365
|
-
* Client for managing Webset Searches
|
|
1366
|
-
*/
|
|
1367
|
-
declare class WebsetSearchesClient extends WebsetsBaseClient {
|
|
1368
|
-
/**
|
|
1369
|
-
* Create a new Search for the Webset
|
|
1370
|
-
* @param websetId The ID of the Webset
|
|
1371
|
-
* @param params The search parameters
|
|
1372
|
-
* @returns The created Webset Search
|
|
1373
|
-
*/
|
|
1374
|
-
create(websetId: string, params: CreateWebsetSearchParameters): Promise<WebsetSearch>;
|
|
1375
|
-
/**
|
|
1376
|
-
* Get a Search by ID
|
|
1377
|
-
* @param websetId The ID of the Webset
|
|
1378
|
-
* @param id The ID of the Search
|
|
1379
|
-
* @returns The Webset Search
|
|
1380
|
-
*/
|
|
1381
|
-
get(websetId: string, id: string): Promise<WebsetSearch>;
|
|
1382
|
-
/**
|
|
1383
|
-
* Cancel a running Search
|
|
1384
|
-
* @param websetId The ID of the Webset
|
|
1385
|
-
* @param id The ID of the Search
|
|
1386
|
-
* @returns The canceled Webset Search
|
|
1387
|
-
*/
|
|
1388
|
-
cancel(websetId: string, id: string): Promise<WebsetSearch>;
|
|
1389
|
-
}
|
|
1390
|
-
|
|
1391
|
-
/**
|
|
1392
|
-
* Client for managing Webset Streams
|
|
1397
|
+
* Client for managing Webset Monitors
|
|
1393
1398
|
*/
|
|
1394
1399
|
|
|
1395
1400
|
/**
|
|
1396
|
-
* Options for listing
|
|
1401
|
+
* Options for listing monitors
|
|
1397
1402
|
*/
|
|
1398
|
-
interface
|
|
1403
|
+
interface ListMonitorsOptions extends PaginationParams$1 {
|
|
1399
1404
|
/**
|
|
1400
|
-
* The id of the Webset to list
|
|
1405
|
+
* The id of the Webset to list monitors for
|
|
1401
1406
|
*/
|
|
1402
1407
|
websetId?: string;
|
|
1403
1408
|
}
|
|
1404
1409
|
/**
|
|
1405
|
-
* Client for managing
|
|
1410
|
+
* Client for managing Monitor Runs
|
|
1406
1411
|
*/
|
|
1407
|
-
declare class
|
|
1412
|
+
declare class WebsetMonitorRunsClient extends WebsetsBaseClient {
|
|
1408
1413
|
/**
|
|
1409
|
-
* List all runs for a
|
|
1410
|
-
* @param
|
|
1414
|
+
* List all runs for a Monitor
|
|
1415
|
+
* @param monitorId The ID of the Monitor
|
|
1411
1416
|
* @param options Pagination options
|
|
1412
|
-
* @returns The list of
|
|
1417
|
+
* @returns The list of Monitor runs
|
|
1413
1418
|
*/
|
|
1414
|
-
list(
|
|
1419
|
+
list(monitorId: string, options?: PaginationParams$1): Promise<ListMonitorRunsResponse>;
|
|
1415
1420
|
/**
|
|
1416
|
-
* Get a specific
|
|
1417
|
-
* @param
|
|
1418
|
-
* @param runId The ID of the
|
|
1419
|
-
* @returns The
|
|
1421
|
+
* Get a specific Monitor run
|
|
1422
|
+
* @param monitorId The ID of the Monitor
|
|
1423
|
+
* @param runId The ID of the Monitor run
|
|
1424
|
+
* @returns The Monitor run
|
|
1420
1425
|
*/
|
|
1421
|
-
get(
|
|
1426
|
+
get(monitorId: string, runId: string): Promise<MonitorRun>;
|
|
1422
1427
|
}
|
|
1423
1428
|
/**
|
|
1424
|
-
* Client for managing Webset
|
|
1429
|
+
* Client for managing Webset Monitors
|
|
1425
1430
|
*/
|
|
1426
|
-
declare class
|
|
1431
|
+
declare class WebsetMonitorsClient extends WebsetsBaseClient {
|
|
1427
1432
|
/**
|
|
1428
|
-
* Client for managing
|
|
1433
|
+
* Client for managing Monitor Runs
|
|
1429
1434
|
*/
|
|
1430
|
-
runs:
|
|
1435
|
+
runs: WebsetMonitorRunsClient;
|
|
1431
1436
|
constructor(client: Exa);
|
|
1432
1437
|
/**
|
|
1433
|
-
* Create a
|
|
1434
|
-
* @param params The
|
|
1435
|
-
* @returns The created
|
|
1438
|
+
* Create a Monitor
|
|
1439
|
+
* @param params The monitor parameters
|
|
1440
|
+
* @returns The created Monitor
|
|
1436
1441
|
*/
|
|
1437
|
-
create(params:
|
|
1442
|
+
create(params: CreateMonitorParameters): Promise<Monitor>;
|
|
1438
1443
|
/**
|
|
1439
|
-
* Get a
|
|
1440
|
-
* @param id The ID of the
|
|
1441
|
-
* @returns The
|
|
1444
|
+
* Get a Monitor by ID
|
|
1445
|
+
* @param id The ID of the Monitor
|
|
1446
|
+
* @returns The Monitor
|
|
1442
1447
|
*/
|
|
1443
|
-
get(id: string): Promise<
|
|
1448
|
+
get(id: string): Promise<Monitor>;
|
|
1444
1449
|
/**
|
|
1445
|
-
* List all
|
|
1450
|
+
* List all Monitors
|
|
1446
1451
|
* @param options Pagination and filtering options
|
|
1447
|
-
* @returns The list of
|
|
1452
|
+
* @returns The list of Monitors
|
|
1448
1453
|
*/
|
|
1449
|
-
list(options?:
|
|
1454
|
+
list(options?: ListMonitorsOptions): Promise<ListMonitorsResponse>;
|
|
1450
1455
|
/**
|
|
1451
|
-
* Update a
|
|
1452
|
-
* @param id The ID of the
|
|
1453
|
-
* @param params The
|
|
1454
|
-
* @returns The updated
|
|
1456
|
+
* Update a Monitor
|
|
1457
|
+
* @param id The ID of the Monitor
|
|
1458
|
+
* @param params The monitor update parameters (status, metadata)
|
|
1459
|
+
* @returns The updated Monitor
|
|
1455
1460
|
*/
|
|
1456
|
-
update(id: string, params:
|
|
1461
|
+
update(id: string, params: UpdateMonitor): Promise<Monitor>;
|
|
1457
1462
|
/**
|
|
1458
|
-
* Delete a
|
|
1459
|
-
* @param id The ID of the
|
|
1460
|
-
* @returns The deleted
|
|
1463
|
+
* Delete a Monitor
|
|
1464
|
+
* @param id The ID of the Monitor
|
|
1465
|
+
* @returns The deleted Monitor
|
|
1461
1466
|
*/
|
|
1462
|
-
delete(id: string): Promise<
|
|
1467
|
+
delete(id: string): Promise<Monitor>;
|
|
1468
|
+
}
|
|
1469
|
+
|
|
1470
|
+
/**
|
|
1471
|
+
* Client for managing Webset Searches
|
|
1472
|
+
*/
|
|
1473
|
+
|
|
1474
|
+
/**
|
|
1475
|
+
* Client for managing Webset Searches
|
|
1476
|
+
*/
|
|
1477
|
+
declare class WebsetSearchesClient extends WebsetsBaseClient {
|
|
1478
|
+
/**
|
|
1479
|
+
* Create a new Search for the Webset
|
|
1480
|
+
* @param websetId The ID of the Webset
|
|
1481
|
+
* @param params The search parameters
|
|
1482
|
+
* @returns The created Webset Search
|
|
1483
|
+
*/
|
|
1484
|
+
create(websetId: string, params: CreateWebsetSearchParameters): Promise<WebsetSearch>;
|
|
1485
|
+
/**
|
|
1486
|
+
* Get a Search by ID
|
|
1487
|
+
* @param websetId The ID of the Webset
|
|
1488
|
+
* @param id The ID of the Search
|
|
1489
|
+
* @returns The Webset Search
|
|
1490
|
+
*/
|
|
1491
|
+
get(websetId: string, id: string): Promise<WebsetSearch>;
|
|
1492
|
+
/**
|
|
1493
|
+
* Cancel a running Search
|
|
1494
|
+
* @param websetId The ID of the Webset
|
|
1495
|
+
* @param id The ID of the Search
|
|
1496
|
+
* @returns The canceled Webset Search
|
|
1497
|
+
*/
|
|
1498
|
+
cancel(websetId: string, id: string): Promise<WebsetSearch>;
|
|
1463
1499
|
}
|
|
1464
1500
|
|
|
1465
1501
|
/**
|
|
@@ -1580,9 +1616,9 @@ declare class WebsetsClient extends WebsetsBaseClient {
|
|
|
1580
1616
|
*/
|
|
1581
1617
|
enrichments: WebsetEnrichmentsClient;
|
|
1582
1618
|
/**
|
|
1583
|
-
* Client for managing Webset
|
|
1619
|
+
* Client for managing Webset Monitors
|
|
1584
1620
|
*/
|
|
1585
|
-
|
|
1621
|
+
monitors: WebsetMonitorsClient;
|
|
1586
1622
|
/**
|
|
1587
1623
|
* Client for managing Webset Webhooks
|
|
1588
1624
|
*/
|
|
@@ -1944,6 +1980,7 @@ type ContentsOptions = {
|
|
|
1944
1980
|
highlights?: HighlightsContentsOptions | true;
|
|
1945
1981
|
summary?: SummaryContentsOptions | true;
|
|
1946
1982
|
livecrawl?: LivecrawlOptions;
|
|
1983
|
+
context?: ContextOptions | true;
|
|
1947
1984
|
livecrawlTimeout?: number;
|
|
1948
1985
|
filterEmptyResults?: boolean;
|
|
1949
1986
|
subpages?: number;
|
|
@@ -1977,6 +2014,16 @@ type HighlightsContentsOptions = {
|
|
|
1977
2014
|
numSentences?: number;
|
|
1978
2015
|
highlightsPerUrl?: number;
|
|
1979
2016
|
};
|
|
2017
|
+
/**
|
|
2018
|
+
* Options for retrieving summary from page.
|
|
2019
|
+
* @typedef {Object} SummaryContentsOptions
|
|
2020
|
+
* @property {string} [query] - The query string to use for summary generation.
|
|
2021
|
+
* @property {JSONSchema} [schema] - JSON schema for structured output from summary.
|
|
2022
|
+
*/
|
|
2023
|
+
type SummaryContentsOptions = {
|
|
2024
|
+
query?: string;
|
|
2025
|
+
schema?: JSONSchema;
|
|
2026
|
+
};
|
|
1980
2027
|
/**
|
|
1981
2028
|
* Represents a JSON Schema definition used for structured summary output.
|
|
1982
2029
|
* To learn more visit https://json-schema.org/overview/what-is-jsonschema.
|
|
@@ -1999,14 +2046,13 @@ type JSONSchema = {
|
|
|
1999
2046
|
not?: JSONSchema;
|
|
2000
2047
|
};
|
|
2001
2048
|
/**
|
|
2002
|
-
* Options for retrieving
|
|
2003
|
-
*
|
|
2004
|
-
* @
|
|
2005
|
-
* @property {
|
|
2049
|
+
* Options for retrieving the context from a list of search results. The context is a string
|
|
2050
|
+
* representation of all the search results.
|
|
2051
|
+
* @typedef {Object} ContextOptions
|
|
2052
|
+
* @property {number} [maxCharacters] - The maximum number of characters.
|
|
2006
2053
|
*/
|
|
2007
|
-
type
|
|
2008
|
-
|
|
2009
|
-
schema?: JSONSchema;
|
|
2054
|
+
type ContextOptions = {
|
|
2055
|
+
maxCharacters?: number;
|
|
2010
2056
|
};
|
|
2011
2057
|
/**
|
|
2012
2058
|
* @typedef {Object} TextResponse
|
|
@@ -2119,6 +2165,7 @@ type SearchResult<T extends ContentsOptions> = {
|
|
|
2119
2165
|
* Represents a search response object.
|
|
2120
2166
|
* @typedef {Object} SearchResponse
|
|
2121
2167
|
* @property {Result[]} results - The list of search results.
|
|
2168
|
+
* @property {string} [context] - The context for the search.
|
|
2122
2169
|
* @property {string} [autopromptString] - The autoprompt string, if applicable.
|
|
2123
2170
|
* @property {string} [autoDate] - The autoprompt date, if applicable.
|
|
2124
2171
|
* @property {string} requestId - The request ID for the search.
|
|
@@ -2126,6 +2173,7 @@ type SearchResult<T extends ContentsOptions> = {
|
|
|
2126
2173
|
*/
|
|
2127
2174
|
type SearchResponse<T extends ContentsOptions> = {
|
|
2128
2175
|
results: SearchResult<T>[];
|
|
2176
|
+
context?: string;
|
|
2129
2177
|
autopromptString?: string;
|
|
2130
2178
|
autoDate?: string;
|
|
2131
2179
|
requestId: string;
|
|
@@ -2311,4 +2359,4 @@ declare class Exa {
|
|
|
2311
2359
|
private parseSSEStream;
|
|
2312
2360
|
}
|
|
2313
2361
|
|
|
2314
|
-
export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type
|
|
2362
|
+
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 ListResearchTasksOptions, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehaviorRefresh, type MonitorBehaviorSearch, type MonitorCadence, MonitorObject, type MonitorRefreshBehaviorContentsConfig, type MonitorRefreshBehaviorEnrichmentsConfig, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type RegularSearchOptions, ResearchClient, ResearchCreateTaskRequestDtoModel as ResearchModel, ResearchTaskDtoStatus as ResearchStatus, type SchemaResearchTaskDto as ResearchTask, type SearchResponse, type SearchResult, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetArticleEntity, type WebsetCompanyEntity, type WebsetCustomEntity, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetEntity, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetPersonEntity, type WebsetResearchPaperEntity, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
|