exa-js 1.7.3 → 1.8.0

package/dist/index.js

@@ -31,13 +31,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   CreateEnrichmentParametersFormat: () => CreateEnrichmentParametersFormat,
-  CreateWebsetSearchParametersBehaviour: () => CreateWebsetSearchParametersBehaviour,
   EventType: () => EventType,
   Exa: () => Exa2,
   ExaError: () => ExaError,
   HttpStatusCode: () => HttpStatusCode,
   ResearchClient: () => ResearchClient,
-  ResearchStatus: () => ResearchStatus,
+  ResearchModel: () => ResearchCreateTaskRequestDtoModel,
+  ResearchStatus: () => ResearchTaskDtoStatus,
+  UpdateStreamStatus: () => UpdateStreamStatus,
   WebhookStatus: () => WebhookStatus,
   WebsetEnrichmentFormat: () => WebsetEnrichmentFormat,
   WebsetEnrichmentStatus: () => WebsetEnrichmentStatus,
@@ -45,10 +46,12 @@ __export(index_exports, {
   WebsetItemEvaluationSatisfied: () => WebsetItemEvaluationSatisfied,
   WebsetItemSource: () => WebsetItemSource,
   WebsetItemsClient: () => WebsetItemsClient,
+  WebsetSearchBehavior: () => WebsetSearchBehavior,
   WebsetSearchCanceledReason: () => WebsetSearchCanceledReason,
   WebsetSearchStatus: () => WebsetSearchStatus,
   WebsetSearchesClient: () => WebsetSearchesClient,
   WebsetStatus: () => WebsetStatus,
+  WebsetStreamsClient: () => WebsetStreamsClient,
   WebsetWebhooksClient: () => WebsetWebhooksClient,
   WebsetsClient: () => WebsetsClient,
   default: () => index_default
@@ -297,10 +300,6 @@ var CreateEnrichmentParametersFormat = /* @__PURE__ */ ((CreateEnrichmentParamet
   CreateEnrichmentParametersFormat2["phone"] = "phone";
   return CreateEnrichmentParametersFormat2;
 })(CreateEnrichmentParametersFormat || {});
-var CreateWebsetSearchParametersBehaviour = /* @__PURE__ */ ((CreateWebsetSearchParametersBehaviour2) => {
-  CreateWebsetSearchParametersBehaviour2["override"] = "override";
-  return CreateWebsetSearchParametersBehaviour2;
-})(CreateWebsetSearchParametersBehaviour || {});
 var EventType = /* @__PURE__ */ ((EventType2) => {
   EventType2["webset_created"] = "webset.created";
   EventType2["webset_deleted"] = "webset.deleted";
@@ -316,6 +315,11 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
   EventType2["webset_item_enriched"] = "webset.item.enriched";
   return EventType2;
 })(EventType || {});
+var UpdateStreamStatus = /* @__PURE__ */ ((UpdateStreamStatus2) => {
+  UpdateStreamStatus2["open"] = "open";
+  UpdateStreamStatus2["closed"] = "closed";
+  return UpdateStreamStatus2;
+})(UpdateStreamStatus || {});
 var WebhookStatus = /* @__PURE__ */ ((WebhookStatus2) => {
   WebhookStatus2["active"] = "active";
   WebhookStatus2["inactive"] = "inactive";
@@ -344,6 +348,7 @@ var WebsetEnrichmentFormat = /* @__PURE__ */ ((WebsetEnrichmentFormat2) => {
 })(WebsetEnrichmentFormat || {});
 var WebsetItemSource = /* @__PURE__ */ ((WebsetItemSource2) => {
   WebsetItemSource2["search"] = "search";
+  WebsetItemSource2["import"] = "import";
   return WebsetItemSource2;
 })(WebsetItemSource || {});
 var WebsetItemEvaluationSatisfied = /* @__PURE__ */ ((WebsetItemEvaluationSatisfied2) => {
@@ -352,11 +357,6 @@ var WebsetItemEvaluationSatisfied = /* @__PURE__ */ ((WebsetItemEvaluationSatisf
   WebsetItemEvaluationSatisfied2["unclear"] = "unclear";
   return WebsetItemEvaluationSatisfied2;
 })(WebsetItemEvaluationSatisfied || {});
-var WebsetSearchCanceledReason = /* @__PURE__ */ ((WebsetSearchCanceledReason2) => {
-  WebsetSearchCanceledReason2["webset_deleted"] = "webset_deleted";
-  WebsetSearchCanceledReason2["webset_canceled"] = "webset_canceled";
-  return WebsetSearchCanceledReason2;
-})(WebsetSearchCanceledReason || {});
 var WebsetSearchStatus = /* @__PURE__ */ ((WebsetSearchStatus2) => {
   WebsetSearchStatus2["created"] = "created";
   WebsetSearchStatus2["running"] = "running";
@@ -364,6 +364,16 @@ var WebsetSearchStatus = /* @__PURE__ */ ((WebsetSearchStatus2) => {
   WebsetSearchStatus2["canceled"] = "canceled";
   return WebsetSearchStatus2;
 })(WebsetSearchStatus || {});
+var WebsetSearchBehavior = /* @__PURE__ */ ((WebsetSearchBehavior2) => {
+  WebsetSearchBehavior2["override"] = "override";
+  WebsetSearchBehavior2["append"] = "append";
+  return WebsetSearchBehavior2;
+})(WebsetSearchBehavior || {});
+var WebsetSearchCanceledReason = /* @__PURE__ */ ((WebsetSearchCanceledReason2) => {
+  WebsetSearchCanceledReason2["webset_deleted"] = "webset_deleted";
+  WebsetSearchCanceledReason2["webset_canceled"] = "webset_canceled";
+  return WebsetSearchCanceledReason2;
+})(WebsetSearchCanceledReason || {});
 
 // src/websets/searches.ts
 var WebsetSearchesClient = class extends WebsetsBaseClient {
@@ -406,6 +416,94 @@ var WebsetSearchesClient = class extends WebsetsBaseClient {
   }
 };
 
+// src/websets/streams.ts
+var WebsetStreamRunsClient = class extends WebsetsBaseClient {
+  /**
+   * List all runs for a Stream
+   * @param streamId The ID of the Stream
+   * @param options Pagination options
+   * @returns The list of Stream runs
+   */
+  async list(streamId, options) {
+    const params = this.buildPaginationParams(options);
+    return this.request(
+      `/v0/streams/${streamId}/runs`,
+      "GET",
+      void 0,
+      params
+    );
+  }
+  /**
+   * Get a specific Stream run
+   * @param streamId The ID of the Stream
+   * @param runId The ID of the Stream run
+   * @returns The Stream run
+   */
+  async get(streamId, runId) {
+    return this.request(
+      `/v0/streams/${streamId}/runs/${runId}`,
+      "GET"
+    );
+  }
+};
+var WebsetStreamsClient = class extends WebsetsBaseClient {
+  constructor(client) {
+    super(client);
+    this.runs = new WebsetStreamRunsClient(client);
+  }
+  /**
+   * Create a Stream
+   * @param params The stream parameters
+   * @returns The created Stream
+   */
+  async create(params) {
+    return this.request("/v0/streams", "POST", params);
+  }
+  /**
+   * Get a Stream by ID
+   * @param id The ID of the Stream
+   * @returns The Stream
+   */
+  async get(id) {
+    return this.request(`/v0/streams/${id}`, "GET");
+  }
+  /**
+   * List all Streams
+   * @param options Pagination and filtering options
+   * @returns The list of Streams
+   */
+  async list(options) {
+    const params = {
+      cursor: options?.cursor,
+      limit: options?.limit,
+      websetId: options?.websetId
+    };
+    return this.request(
+      "/v0/streams",
+      "GET",
+      void 0,
+      params
+    );
+  }
+  /**
+   * Update a Stream
+   * @param id The ID of the Stream
+   * @param params The stream update parameters (status, metadata)
+   * @returns The updated Stream
+   */
+  async update(id, params) {
+    return this.request(`/v0/streams/${id}`, "PATCH", params);
+  }
+  /**
+   * Delete a Stream
+   * @param id The ID of the Stream
+   * @returns The deleted Stream
+   */
+  async delete(id) {
+    return this.request(`/v0/streams/${id}`, "DELETE");
+  }
+};
+
 // src/websets/webhooks.ts
 var WebsetWebhooksClient = class extends WebsetsBaseClient {
   /**
@@ -554,6 +652,7 @@ var WebsetsClient = class extends WebsetsBaseClient {
     this.items = new WebsetItemsClient(client);
     this.searches = new WebsetSearchesClient(client);
     this.enrichments = new WebsetEnrichmentsClient(client);
+    this.streams = new WebsetStreamsClient(client);
     this.webhooks = new WebsetWebhooksClient(client);
   }
   /**
@@ -709,36 +808,66 @@ var ResearchBaseClient = class {
    * @returns The parsed JSON response
    */
   async request(endpoint, method = "POST", data, params) {
-    return this.client.request(`/research${endpoint}`, method, data, params);
+    return this.client.request(
+      `/research/v0${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;
+    if (pagination.cursor) params.cursor = pagination.cursor;
+    if (pagination.limit) params.limit = pagination.limit;
+    return params;
   }
 };
 
+// src/research/openapi.ts
+var ResearchCreateTaskRequestDtoModel = /* @__PURE__ */ ((ResearchCreateTaskRequestDtoModel2) => {
+  ResearchCreateTaskRequestDtoModel2["exa_research"] = "exa-research";
+  ResearchCreateTaskRequestDtoModel2["exa_ultra"] = "exa-ultra";
+  return ResearchCreateTaskRequestDtoModel2;
+})(ResearchCreateTaskRequestDtoModel || {});
+var ResearchTaskDtoStatus = /* @__PURE__ */ ((ResearchTaskDtoStatus2) => {
+  ResearchTaskDtoStatus2["running"] = "running";
+  ResearchTaskDtoStatus2["completed"] = "completed";
+  ResearchTaskDtoStatus2["failed"] = "failed";
+  return ResearchTaskDtoStatus2;
+})(ResearchTaskDtoStatus || {});
+
 // src/research/client.ts
 var ResearchClient = class extends ResearchBaseClient {
   constructor(client) {
     super(client);
   }
   /**
-   * Create a research task.
+   * Create a new research task.
    *
-   * Both parameters are required and have fixed shapes:
-   * 1. `input`
-   *      `{ instructions: string }`
-   *     • `instructions` – High-level guidance that tells the research agent what to do.
-   * 2. `output`
-   *    defines the exact structure you expect back, and guides the research conducted by the agent.
-   *      `{ schema: JSONSchema }`.
-   *    The agent's response will be validated against this schema.
+   * @param params Object containing:
+   *   - model: The research model to use (e.g., ResearchModel.ExaResearch).
+   *   - instructions: High-level guidance for the research agent.
+   *   - output: An object with a `schema` property (JSONSchema) that defines the expected output structure.
    *
-   * @param input  Object containing high-level research instructions.
-   * @param output Object containing the expected output schema.
-   * @returns The ResearchTaskResponse returned by the API.
+   * @returns An object containing the unique ID of the created research task.
    */
-  async createTask(input, output) {
-    return this.request("/tasks", "POST", {
-      input,
-      output
-    });
+  async createTask(params) {
+    const { model, ...rest } = params;
+    const payload = {
+      model: model ?? "exa-research" /* exa_research */,
+      ...rest
+    };
+    return this.request(
+      "/tasks",
+      "POST",
+      payload
+    );
   }
   /**
    * Retrieve a research task by ID.
@@ -749,15 +878,28 @@ var ResearchClient = class extends ResearchBaseClient {
   /**
    * 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;
     const startTime = Date.now();
+    let consecutiveFailures = 0;
     while (true) {
-      const task = await this.request(`/tasks/${id}`, "GET");
-      if (task.status === "completed" || task.status === "failed") {
-        return task;
+      try {
+        const task = await this.request(`/tasks/${id}`, "GET");
+        consecutiveFailures = 0;
+        if (task.status === "completed" || task.status === "failed") {
+          return task;
+        }
+      } catch (err) {
+        consecutiveFailures += 1;
+        if (consecutiveFailures >= maxConsecutiveFailures) {
+          throw new Error(
+            `Polling failed ${maxConsecutiveFailures} times in a row for task ${id}: ${err}`
+          );
+        }
       }
       if (Date.now() - startTime > maxPollingTime) {
         throw new Error(
@@ -767,16 +909,22 @@ var ResearchClient = class extends ResearchBaseClient {
       await new Promise((resolve) => setTimeout(resolve, pollingInterval));
     }
   }
+  /**
+   * 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/research/types.ts
-var ResearchStatus = /* @__PURE__ */ ((ResearchStatus2) => {
-  ResearchStatus2["in_progress"] = "in_progress";
-  ResearchStatus2["completed"] = "completed";
-  ResearchStatus2["failed"] = "failed";
-  return ResearchStatus2;
-})(ResearchStatus || {});
-
 // src/index.ts
 var fetchImpl = typeof global !== "undefined" && global.fetch ? global.fetch : import_cross_fetch.default;
 var HeadersImpl = typeof global !== "undefined" && global.Headers ? global.Headers : import_cross_fetch.Headers;
@@ -1190,13 +1338,14 @@ var index_default = Exa2;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CreateEnrichmentParametersFormat,
-  CreateWebsetSearchParametersBehaviour,
   EventType,
   Exa,
   ExaError,
   HttpStatusCode,
   ResearchClient,
+  ResearchModel,
   ResearchStatus,
+  UpdateStreamStatus,
   WebhookStatus,
   WebsetEnrichmentFormat,
   WebsetEnrichmentStatus,
@@ -1204,10 +1353,12 @@ var index_default = Exa2;
   WebsetItemEvaluationSatisfied,
   WebsetItemSource,
   WebsetItemsClient,
+  WebsetSearchBehavior,
   WebsetSearchCanceledReason,
   WebsetSearchStatus,
   WebsetSearchesClient,
   WebsetStatus,
+  WebsetStreamsClient,
   WebsetWebhooksClient,
   WebsetsClient
 });