exa-js 1.8.27 → 1.9.1

package/dist/index.js

@@ -32,10 +32,6 @@ var index_exports = {};
 __export(index_exports, {
   CreateEnrichmentParametersFormat: () => CreateEnrichmentParametersFormat,
   CreateImportParametersFormat: () => CreateImportParametersFormat,
-  CreateWebsetParametersImportSource: () => CreateWebsetParametersImportSource,
-  CreateWebsetParametersSearchExcludeSource: () => CreateWebsetParametersSearchExcludeSource,
-  CreateWebsetSearchParametersExcludeSource: () => CreateWebsetSearchParametersExcludeSource,
-  CreateWebsetSearchParametersScopeSource: () => CreateWebsetSearchParametersScopeSource,
   EventType: () => EventType,
   EventsClient: () => EventsClient,
   Exa: () => Exa2,
@@ -51,20 +47,20 @@ __export(index_exports, {
   MonitorRunStatus: () => MonitorRunStatus,
   MonitorRunType: () => MonitorRunType,
   MonitorStatus: () => MonitorStatus,
-  PreviewWebsetResponseEnrichmentsFormat: () => PreviewWebsetResponseEnrichmentsFormat,
-  ResearchClient: () => ResearchClient,
-  ScopeSourceType: () => ScopeSourceType,
   UpdateMonitorStatus: () => UpdateMonitorStatus,
   WebhookStatus: () => WebhookStatus,
   WebsetEnrichmentFormat: () => WebsetEnrichmentFormat,
   WebsetEnrichmentStatus: () => WebsetEnrichmentStatus,
   WebsetEnrichmentsClient: () => WebsetEnrichmentsClient,
+  WebsetImportSource: () => WebsetImportSource,
   WebsetItemEvaluationSatisfied: () => WebsetItemEvaluationSatisfied,
   WebsetItemSource: () => WebsetItemSource,
   WebsetItemsClient: () => WebsetItemsClient,
   WebsetMonitorsClient: () => WebsetMonitorsClient,
   WebsetSearchBehavior: () => WebsetSearchBehavior,
   WebsetSearchCanceledReason: () => WebsetSearchCanceledReason,
+  WebsetSearchExcludeSource: () => WebsetSearchExcludeSource,
+  WebsetSearchScopeSource: () => WebsetSearchScopeSource,
   WebsetSearchStatus: () => WebsetSearchStatus,
   WebsetSearchesClient: () => WebsetSearchesClient,
   WebsetStatus: () => WebsetStatus,
@@ -184,6 +180,20 @@ var WebsetEnrichmentsClient = class extends WebsetsBaseClient {
       "DELETE"
     );
   }
+  /**
+   * Update an Enrichment
+   * @param websetId The ID of the Webset
+   * @param id The ID of the Enrichment
+   * @param params The enrichment update parameters
+   * @returns Promise that resolves when the update is complete
+   */
+  async update(websetId, id, params) {
+    return this.request(
+      `/v0/websets/${websetId}/enrichments/${id}`,
+      "PATCH",
+      params
+    );
+  }
   /**
    * Cancel a running Enrichment
    * @param websetId The ID of the Webset
@@ -243,37 +253,18 @@ var CreateEnrichmentParametersFormat = /* @__PURE__ */ ((CreateEnrichmentParamet
   CreateEnrichmentParametersFormat2["options"] = "options";
   CreateEnrichmentParametersFormat2["email"] = "email";
   CreateEnrichmentParametersFormat2["phone"] = "phone";
+  CreateEnrichmentParametersFormat2["url"] = "url";
   return CreateEnrichmentParametersFormat2;
 })(CreateEnrichmentParametersFormat || {});
 var CreateImportParametersFormat = /* @__PURE__ */ ((CreateImportParametersFormat2) => {
   CreateImportParametersFormat2["csv"] = "csv";
   return CreateImportParametersFormat2;
 })(CreateImportParametersFormat || {});
-var CreateWebsetParametersImportSource = /* @__PURE__ */ ((CreateWebsetParametersImportSource2) => {
-  CreateWebsetParametersImportSource2["import"] = "import";
-  CreateWebsetParametersImportSource2["webset"] = "webset";
-  return CreateWebsetParametersImportSource2;
-})(CreateWebsetParametersImportSource || {});
-var CreateWebsetParametersSearchExcludeSource = /* @__PURE__ */ ((CreateWebsetParametersSearchExcludeSource2) => {
-  CreateWebsetParametersSearchExcludeSource2["import"] = "import";
-  CreateWebsetParametersSearchExcludeSource2["webset"] = "webset";
-  return CreateWebsetParametersSearchExcludeSource2;
-})(CreateWebsetParametersSearchExcludeSource || {});
-var ScopeSourceType = /* @__PURE__ */ ((ScopeSourceType2) => {
-  ScopeSourceType2["import"] = "import";
-  ScopeSourceType2["webset"] = "webset";
-  return ScopeSourceType2;
-})(ScopeSourceType || {});
-var CreateWebsetSearchParametersExcludeSource = /* @__PURE__ */ ((CreateWebsetSearchParametersExcludeSource2) => {
-  CreateWebsetSearchParametersExcludeSource2["import"] = "import";
-  CreateWebsetSearchParametersExcludeSource2["webset"] = "webset";
-  return CreateWebsetSearchParametersExcludeSource2;
-})(CreateWebsetSearchParametersExcludeSource || {});
-var CreateWebsetSearchParametersScopeSource = /* @__PURE__ */ ((CreateWebsetSearchParametersScopeSource2) => {
-  CreateWebsetSearchParametersScopeSource2["import"] = "import";
-  CreateWebsetSearchParametersScopeSource2["webset"] = "webset";
-  return CreateWebsetSearchParametersScopeSource2;
-})(CreateWebsetSearchParametersScopeSource || {});
+var WebsetImportSource = /* @__PURE__ */ ((WebsetImportSource2) => {
+  WebsetImportSource2["import"] = "import";
+  WebsetImportSource2["webset"] = "webset";
+  return WebsetImportSource2;
+})(WebsetImportSource || {});
 var EventType = /* @__PURE__ */ ((EventType2) => {
   EventType2["webset_created"] = "webset.created";
   EventType2["webset_deleted"] = "webset.deleted";
@@ -285,9 +276,13 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
   EventType2["webset_search_updated"] = "webset.search.updated";
   EventType2["import_created"] = "import.created";
   EventType2["import_completed"] = "import.completed";
-  EventType2["import_processing"] = "import.processing";
   EventType2["webset_item_created"] = "webset.item.created";
   EventType2["webset_item_enriched"] = "webset.item.enriched";
+  EventType2["monitor_created"] = "monitor.created";
+  EventType2["monitor_updated"] = "monitor.updated";
+  EventType2["monitor_deleted"] = "monitor.deleted";
+  EventType2["monitor_run_created"] = "monitor.run.created";
+  EventType2["monitor_run_completed"] = "monitor.run.completed";
   EventType2["webset_export_created"] = "webset.export.created";
   EventType2["webset_export_completed"] = "webset.export.completed";
   return EventType2;
@@ -340,15 +335,6 @@ var MonitorRunType = /* @__PURE__ */ ((MonitorRunType2) => {
   MonitorRunType2["refresh"] = "refresh";
   return MonitorRunType2;
 })(MonitorRunType || {});
-var PreviewWebsetResponseEnrichmentsFormat = /* @__PURE__ */ ((PreviewWebsetResponseEnrichmentsFormat2) => {
-  PreviewWebsetResponseEnrichmentsFormat2["text"] = "text";
-  PreviewWebsetResponseEnrichmentsFormat2["date"] = "date";
-  PreviewWebsetResponseEnrichmentsFormat2["number"] = "number";
-  PreviewWebsetResponseEnrichmentsFormat2["options"] = "options";
-  PreviewWebsetResponseEnrichmentsFormat2["email"] = "email";
-  PreviewWebsetResponseEnrichmentsFormat2["phone"] = "phone";
-  return PreviewWebsetResponseEnrichmentsFormat2;
-})(PreviewWebsetResponseEnrichmentsFormat || {});
 var UpdateMonitorStatus = /* @__PURE__ */ ((UpdateMonitorStatus2) => {
   UpdateMonitorStatus2["enabled"] = "enabled";
   UpdateMonitorStatus2["disabled"] = "disabled";
@@ -379,6 +365,7 @@ var WebsetEnrichmentFormat = /* @__PURE__ */ ((WebsetEnrichmentFormat2) => {
   WebsetEnrichmentFormat2["options"] = "options";
   WebsetEnrichmentFormat2["email"] = "email";
   WebsetEnrichmentFormat2["phone"] = "phone";
+  WebsetEnrichmentFormat2["url"] = "url";
   return WebsetEnrichmentFormat2;
 })(WebsetEnrichmentFormat || {});
 var WebsetItemSource = /* @__PURE__ */ ((WebsetItemSource2) => {
@@ -392,6 +379,16 @@ var WebsetItemEvaluationSatisfied = /* @__PURE__ */ ((WebsetItemEvaluationSatisf
   WebsetItemEvaluationSatisfied2["unclear"] = "unclear";
   return WebsetItemEvaluationSatisfied2;
 })(WebsetItemEvaluationSatisfied || {});
+var WebsetSearchExcludeSource = /* @__PURE__ */ ((WebsetSearchExcludeSource2) => {
+  WebsetSearchExcludeSource2["import"] = "import";
+  WebsetSearchExcludeSource2["webset"] = "webset";
+  return WebsetSearchExcludeSource2;
+})(WebsetSearchExcludeSource || {});
+var WebsetSearchScopeSource = /* @__PURE__ */ ((WebsetSearchScopeSource2) => {
+  WebsetSearchScopeSource2["import"] = "import";
+  WebsetSearchScopeSource2["webset"] = "webset";
+  return WebsetSearchScopeSource2;
+})(WebsetSearchScopeSource || {});
 var WebsetSearchStatus = /* @__PURE__ */ ((WebsetSearchStatus2) => {
   WebsetSearchStatus2["created"] = "created";
   WebsetSearchStatus2["pending"] = "pending";
@@ -1093,50 +1090,25 @@ function zodToJsonSchema(schema) {
 
 // src/research/base.ts
 var ResearchBaseClient = class {
-  /**
-   * Initialize a new Research base client
-   * @param client The Exa client instance
-   */
   constructor(client) {
     this.client = client;
   }
-  /**
-   * Make a request to the Research API (prefixes all paths with `/research`).
-   * @param endpoint The endpoint path, beginning with a slash (e.g. "/tasks").
-   * @param method The HTTP method. Defaults to "POST".
-   * @param data Optional request body
-   * @param params Optional query parameters
-   * @returns The parsed JSON response
-   */
   async request(endpoint, method = "POST", data, params) {
     return this.client.request(
-      `/research/v0${endpoint}`,
+      `/research/v1${endpoint}`,
       method,
       data,
       params
     );
   }
-  /**
-   * Make a request to the Research API (prefixes all paths with `/research`).
-   * @param endpoint The endpoint path, beginning with a slash (e.g. "/tasks").
-   * @param method The HTTP method. Defaults to "POST".
-   * @param data Optional request body
-   * @param params Optional query parameters
-   * @returns The parsed JSON response
-   */
   async rawRequest(endpoint, method = "POST", data, params) {
     return this.client.rawRequest(
-      `/research/v0${endpoint}`,
+      `/research/v1${endpoint}`,
       method,
       data,
       params
     );
   }
-  /**
-   * Helper to build pagination parameters.
-   * @param pagination The pagination parameters
-   * @returns QueryParams object with pagination parameters
-   */
   buildPaginationParams(pagination) {
     const params = {};
     if (!pagination) return params;
@@ -1151,26 +1123,34 @@ var ResearchClient = class extends ResearchBaseClient {
   constructor(client) {
     super(client);
   }
-  async createTask(params) {
-    const { instructions, model, output } = params;
-    let schema = output?.schema;
+  async create(params) {
+    const { instructions, model, outputSchema } = params;
+    let schema = outputSchema;
     if (schema && isZodSchema(schema)) {
       schema = zodToJsonSchema(schema);
     }
     const payload = {
       instructions,
-      model: model ?? "exa-research",
-      output: output ? {
-        schema,
-        inferSchema: output.inferSchema ?? true
-      } : { inferSchema: true }
+      model: model ?? "exa-research"
     };
-    return this.request("/tasks", "POST", payload);
+    if (schema) {
+      payload.outputSchema = schema;
+    }
+    return this.request("", "POST", payload);
   }
-  getTask(id, options) {
+  get(researchId, options) {
     if (options?.stream) {
       const promise = async () => {
-        const resp = await this.rawRequest(`/tasks/${id}?stream=true`, "GET");
+        const params = { stream: "true" };
+        if (options.events !== void 0) {
+          params.events = options.events.toString();
+        }
+        const resp = await this.rawRequest(
+          `/${researchId}`,
+          "GET",
+          void 0,
+          params
+        );
         if (!resp.body) {
           throw new Error("No response body for SSE stream");
         }
@@ -1214,59 +1194,53 @@ var ResearchClient = class extends ResearchBaseClient {
       };
       return promise();
     } else {
-      return this.request(`/tasks/${id}`, "GET");
+      const params = { stream: "false" };
+      if (options?.events !== void 0) {
+        params.events = options.events.toString();
+      }
+      return this.request(
+        `/${researchId}`,
+        "GET",
+        void 0,
+        params
+      );
     }
   }
-  /**
-   * @deprecated This method is deprecated and may be removed in a future release.
-   * @see getTask(id, {stream: true})
-   * Poll a research task until completion or failure.
-   * Polls every 1 second with a maximum timeout of 10 minutes.
-   * Resilient to up to 10 consecutive polling failures.
-   */
-  async pollTask(id) {
-    const pollingInterval = 1e3;
-    const maxPollingTime = 10 * 60 * 1e3;
-    const maxConsecutiveFailures = 10;
+  async list(options) {
+    const params = this.buildPaginationParams(options);
+    return this.request("", "GET", void 0, params);
+  }
+  async pollUntilFinished(researchId, options) {
+    const pollInterval = options?.pollInterval ?? 1e3;
+    const timeoutMs = options?.timeoutMs ?? 10 * 60 * 1e3;
+    const maxConsecutiveFailures = 5;
     const startTime = Date.now();
     let consecutiveFailures = 0;
     while (true) {
       try {
-        const task = await this.request(`/tasks/${id}`, "GET");
+        const research = await this.get(researchId, {
+          events: options?.events
+        });
         consecutiveFailures = 0;
-        if (task.status === "completed" || task.status === "failed") {
-          return task;
+        if (research.status === "completed" || research.status === "failed" || research.status === "canceled") {
+          return research;
         }
       } catch (err) {
         consecutiveFailures += 1;
         if (consecutiveFailures >= maxConsecutiveFailures) {
           throw new Error(
-            `Polling failed ${maxConsecutiveFailures} times in a row for task ${id}: ${err}`
+            `Polling failed ${maxConsecutiveFailures} times in a row for research ${researchId}: ${err}`
           );
         }
       }
-      if (Date.now() - startTime > maxPollingTime) {
+      if (Date.now() - startTime > timeoutMs) {
         throw new Error(
-          `Polling timeout: Task ${id} did not complete within 10 minutes`
+          `Polling timeout: Research ${researchId} did not complete within ${timeoutMs}ms`
         );
       }
-      await new Promise((resolve) => setTimeout(resolve, pollingInterval));
+      await new Promise((resolve) => setTimeout(resolve, pollInterval));
     }
   }
-  /**
-   * List research tasks
-   * @param options Pagination options
-   * @returns The paginated list of research tasks
-   */
-  async listTasks(options) {
-    const params = this.buildPaginationParams(options);
-    return this.request(
-      "/tasks",
-      "GET",
-      void 0,
-      params
-    );
-  }
 };
 
 // src/index.ts
@@ -1697,10 +1671,6 @@ var index_default = Exa2;
 0 && (module.exports = {
   CreateEnrichmentParametersFormat,
   CreateImportParametersFormat,
-  CreateWebsetParametersImportSource,
-  CreateWebsetParametersSearchExcludeSource,
-  CreateWebsetSearchParametersExcludeSource,
-  CreateWebsetSearchParametersScopeSource,
   EventType,
   EventsClient,
   Exa,
@@ -1716,20 +1686,20 @@ var index_default = Exa2;
   MonitorRunStatus,
   MonitorRunType,
   MonitorStatus,
-  PreviewWebsetResponseEnrichmentsFormat,
-  ResearchClient,
-  ScopeSourceType,
   UpdateMonitorStatus,
   WebhookStatus,
   WebsetEnrichmentFormat,
   WebsetEnrichmentStatus,
   WebsetEnrichmentsClient,
+  WebsetImportSource,
   WebsetItemEvaluationSatisfied,
   WebsetItemSource,
   WebsetItemsClient,
   WebsetMonitorsClient,
   WebsetSearchBehavior,
   WebsetSearchCanceledReason,
+  WebsetSearchExcludeSource,
+  WebsetSearchScopeSource,
   WebsetSearchStatus,
   WebsetSearchesClient,
   WebsetStatus,