exa-js 1.6.13 → 1.7.0

package/dist/index.mjs

@@ -58,12 +58,9 @@ var WebsetsBaseClient = class {
    */
   buildPaginationParams(pagination) {
     const params = {};
-    if (!pagination)
-      return params;
-    if (pagination.cursor)
-      params.cursor = pagination.cursor;
-    if (pagination.limit)
-      params.limit = pagination.limit;
+    if (!pagination) return params;
+    if (pagination.cursor) params.cursor = pagination.cursor;
+    if (pagination.limit) params.limit = pagination.limit;
     return params;
   }
 };
@@ -642,6 +639,11 @@ var WebsetsClient = class extends WebsetsBaseClient {
 // src/index.ts
 var fetchImpl = typeof global !== "undefined" && global.fetch ? global.fetch : fetch;
 var HeadersImpl = typeof global !== "undefined" && global.Headers ? global.Headers : Headers;
+var ResearchStatus = /* @__PURE__ */ ((ResearchStatus2) => {
+  ResearchStatus2["completed"] = "completed";
+  ResearchStatus2["failed"] = "failed";
+  return ResearchStatus2;
+})(ResearchStatus || {});
 var Exa2 = class {
   /**
    * Helper method to separate out the contents-specific options from the rest.
@@ -662,20 +664,14 @@ var Exa2 = class {
     if (text === void 0 && summary === void 0 && highlights === void 0 && extras === void 0) {
       contentsOptions.text = true;
     }
-    if (text !== void 0)
-      contentsOptions.text = text;
-    if (summary !== void 0)
-      contentsOptions.summary = summary;
-    if (highlights !== void 0)
-      contentsOptions.highlights = highlights;
-    if (subpages !== void 0)
-      contentsOptions.subpages = subpages;
+    if (text !== void 0) contentsOptions.text = text;
+    if (summary !== void 0) contentsOptions.summary = summary;
+    if (highlights !== void 0) contentsOptions.highlights = highlights;
+    if (subpages !== void 0) contentsOptions.subpages = subpages;
     if (subpageTarget !== void 0)
       contentsOptions.subpageTarget = subpageTarget;
-    if (extras !== void 0)
-      contentsOptions.extras = extras;
-    if (livecrawl !== void 0)
-      contentsOptions.livecrawl = livecrawl;
+    if (extras !== void 0) contentsOptions.extras = extras;
+    if (livecrawl !== void 0) contentsOptions.livecrawl = livecrawl;
     if (livecrawlTimeout !== void 0)
       contentsOptions.livecrawlTimeout = livecrawlTimeout;
     return {
@@ -918,14 +914,12 @@ var Exa2 = class {
     try {
       while (true) {
         const { done, value } = await reader.read();
-        if (done)
-          break;
+        if (done) break;
         buffer += decoder.decode(value, { stream: true });
         const lines = buffer.split("\n");
         buffer = lines.pop() || "";
         for (const line of lines) {
-          if (!line.startsWith("data: "))
-            continue;
+          if (!line.startsWith("data: ")) continue;
           const jsonStr = line.replace(/^data:\s*/, "").trim();
           if (!jsonStr || jsonStr === "[DONE]") {
             continue;
@@ -977,8 +971,50 @@ var Exa2 = class {
     }
     return { content, citations };
   }
+  /**
+   * Creates and runs a research task in a blocking manner.
+   *
+   * 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 {{ instructions: string }} input   The research prompt.
+   * @param {{ schema: JSONSchema }}                output  The desired output schema.
+   * @returns {Promise<ResearchTaskResponse>}                     The research response.
+   *
+   * @example
+   * const response = await exa.researchTask(
+   *   { instructions: "I need a few key facts about honey pot ants." },
+   *   {
+   *     schema: {
+   *       type: "object",
+   *       required: ["scientificName", "primaryRegions"],
+   *       properties: {
+   *         scientificName: { type: "string" },
+   *         primaryRegions:  { type: "string" },
+   *       },
+   *     },
+   *   },
+   * );
+   */
+  async researchTask(input, output) {
+    const body = {
+      input,
+      output
+    };
+    return await this.request(
+      "/research/tasks",
+      "POST",
+      body
+    );
+  }
 };
-var src_default = Exa2;
+var index_default = Exa2;
 export {
   CreateEnrichmentParametersFormat,
   CreateWebsetSearchParametersBehaviour,
@@ -986,6 +1022,7 @@ export {
   Exa2 as Exa,
   ExaError,
   HttpStatusCode,
+  ResearchStatus,
   WebhookStatus,
   WebsetEnrichmentFormat,
   WebsetEnrichmentStatus,
@@ -999,6 +1036,6 @@ export {
   WebsetStatus,
   WebsetWebhooksClient,
   WebsetsClient,
-  src_default as default
+  index_default as default
 };
 //# sourceMappingURL=index.mjs.map