valyu-js 2.3.2 → 2.4.0

package/dist/index.mjs

@@ -24,6 +24,15 @@ var Valyu = class {
       delete: this._deepresearchDelete.bind(this),
       togglePublic: this._deepresearchTogglePublic.bind(this)
     };
+    this.batch = {
+      create: this._batchCreate.bind(this),
+      status: this._batchStatus.bind(this),
+      addTasks: this._batchAddTasks.bind(this),
+      listTasks: this._batchListTasks.bind(this),
+      cancel: this._batchCancel.bind(this),
+      list: this._batchList.bind(this),
+      waitForCompletion: this._batchWaitForCompletion.bind(this)
+    };
   }
   /**
    * Validates date format (YYYY-MM-DD)
@@ -316,9 +325,10 @@ var Valyu = class {
    * @param urls - Array of URLs to process (max 10)
    * @param options - Content extraction configuration options
    * @param options.summary - AI summary configuration: false (raw), true (auto), string (custom), or JSON schema
-   * @param options.extractEffort - Extraction thoroughness: "normal" or "high"
+   * @param options.extractEffort - Extraction thoroughness: "normal", "high", or "auto"
    * @param options.responseLength - Content length per URL
    * @param options.maxPriceDollars - Maximum cost limit in USD
+   * @param options.screenshot - Request page screenshots (default: false)
    * @returns Promise resolving to content extraction results
    */
   async contents(urls, options = {}) {
@@ -413,6 +423,9 @@ var Valyu = class {
       if (options.maxPriceDollars !== void 0) {
         payload.max_price_dollars = options.maxPriceDollars;
       }
+      if (options.screenshot !== void 0) {
+        payload.screenshot = options.screenshot;
+      }
       const response = await axios.post(`${this.baseUrl}/contents`, payload, {
         headers: this.headers
       });
@@ -455,7 +468,7 @@ var Valyu = class {
       }
       const payload = {
         input: options.input,
-        model: options.model || "lite",
+        model: options.model || "fast",
         output_formats: options.outputFormats || ["markdown"],
         code_execution: options.codeExecution !== false
       };
@@ -674,6 +687,184 @@ var Valyu = class {
       };
     }
   }
+  /**
+   * Batch: Create a new batch
+   * @param options - Batch configuration options
+   * @param options.name - Optional name for the batch
+   * @param options.model - DeepResearch mode: "fast", "standard", or "heavy" (default: "standard")
+   * @param options.outputFormats - Output formats for tasks (default: ["markdown"])
+   * @param options.search - Search configuration for all tasks in batch
+   * @param options.webhookUrl - Optional HTTPS URL for completion notification
+   * @param options.metadata - Optional metadata key-value pairs
+   * @returns Promise resolving to batch creation response with batch_id and webhook_secret
+   */
+  async _batchCreate(options = {}) {
+    try {
+      const payload = {};
+      if (options.name) payload.name = options.name;
+      if (options.model) payload.model = options.model;
+      if (options.outputFormats) payload.output_formats = options.outputFormats;
+      if (options.search) {
+        payload.search = {
+          search_type: options.search.searchType,
+          included_sources: options.search.includedSources
+        };
+      }
+      if (options.webhookUrl) payload.webhook_url = options.webhookUrl;
+      if (options.metadata) payload.metadata = options.metadata;
+      const response = await axios.post(
+        `${this.baseUrl}/deepresearch/batches`,
+        payload,
+        { headers: this.headers }
+      );
+      return { success: true, ...response.data };
+    } catch (e) {
+      return {
+        success: false,
+        error: e.response?.data?.error || e.message
+      };
+    }
+  }
+  /**
+   * Batch: Get batch status
+   * @param batchId - The batch ID to query
+   * @returns Promise resolving to batch status with counts and usage
+   */
+  async _batchStatus(batchId) {
+    try {
+      const response = await axios.get(
+        `${this.baseUrl}/deepresearch/batches/${batchId}`,
+        { headers: this.headers }
+      );
+      return { success: true, batch: response.data };
+    } catch (e) {
+      return {
+        success: false,
+        error: e.response?.data?.error || e.message
+      };
+    }
+  }
+  /**
+   * Batch: Add tasks to a batch
+   * @param batchId - The batch ID to add tasks to
+   * @param options - Task configuration options
+   * @param options.tasks - Array of task inputs
+   * @returns Promise resolving to response with added_count and task_ids
+   */
+  async _batchAddTasks(batchId, options) {
+    try {
+      if (!options.tasks || !Array.isArray(options.tasks)) {
+        return {
+          success: false,
+          error: "tasks must be an array"
+        };
+      }
+      if (options.tasks.length === 0) {
+        return {
+          success: false,
+          error: "tasks array cannot be empty"
+        };
+      }
+      const response = await axios.post(
+        `${this.baseUrl}/deepresearch/batches/${batchId}/tasks`,
+        { tasks: options.tasks },
+        { headers: this.headers }
+      );
+      return { success: true, ...response.data };
+    } catch (e) {
+      return {
+        success: false,
+        error: e.response?.data?.error || e.message
+      };
+    }
+  }
+  /**
+   * Batch: List all tasks in a batch
+   * @param batchId - The batch ID to query
+   * @returns Promise resolving to list of tasks with their status
+   */
+  async _batchListTasks(batchId) {
+    try {
+      const response = await axios.get(
+        `${this.baseUrl}/deepresearch/batches/${batchId}/tasks`,
+        { headers: this.headers }
+      );
+      return { success: true, ...response.data };
+    } catch (e) {
+      return {
+        success: false,
+        error: e.response?.data?.error || e.message
+      };
+    }
+  }
+  /**
+   * Batch: Cancel a batch and all its pending tasks
+   * @param batchId - The batch ID to cancel
+   * @returns Promise resolving to cancellation confirmation
+   */
+  async _batchCancel(batchId) {
+    try {
+      const response = await axios.post(
+        `${this.baseUrl}/deepresearch/batches/${batchId}/cancel`,
+        {},
+        { headers: this.headers }
+      );
+      return { success: true, ...response.data };
+    } catch (e) {
+      return {
+        success: false,
+        error: e.response?.data?.error || e.message
+      };
+    }
+  }
+  /**
+   * Batch: List all batches
+   * @returns Promise resolving to list of all batches
+   */
+  async _batchList() {
+    try {
+      const response = await axios.get(`${this.baseUrl}/deepresearch/batches`, {
+        headers: this.headers
+      });
+      return { success: true, batches: response.data };
+    } catch (e) {
+      return {
+        success: false,
+        error: e.response?.data?.error || e.message
+      };
+    }
+  }
+  /**
+   * Batch: Wait for batch completion with polling
+   * @param batchId - The batch ID to wait for
+   * @param options - Wait configuration options
+   * @param options.pollInterval - Polling interval in milliseconds (default: 10000)
+   * @param options.maxWaitTime - Maximum wait time in milliseconds (default: 7200000)
+   * @param options.onProgress - Callback for progress updates
+   * @returns Promise resolving to final batch status
+   */
+  async _batchWaitForCompletion(batchId, options = {}) {
+    const pollInterval = options.pollInterval || 1e4;
+    const maxWaitTime = options.maxWaitTime || 72e5;
+    const startTime = Date.now();
+    while (true) {
+      const statusResponse = await this._batchStatus(batchId);
+      if (!statusResponse.success || !statusResponse.batch) {
+        throw new Error(statusResponse.error || "Failed to get batch status");
+      }
+      const batch = statusResponse.batch;
+      if (options.onProgress) {
+        options.onProgress(batch);
+      }
+      if (batch.status === "completed" || batch.status === "completed_with_errors" || batch.status === "cancelled") {
+        return batch;
+      }
+      if (Date.now() - startTime > maxWaitTime) {
+        throw new Error("Maximum wait time exceeded");
+      }
+      await new Promise((resolve) => setTimeout(resolve, pollInterval));
+    }
+  }
   /**
    * Get AI-powered answers using the Valyu Answer API
    * @param query - The question or query string
@@ -753,7 +944,9 @@ var Valyu = class {
       }
       const validation = this.validateSources(options.includedSources);
       if (!validation.valid) {
-        return `Invalid includedSources format. Invalid sources: ${validation.invalidSources.join(", ")}.`;
+        return `Invalid includedSources format. Invalid sources: ${validation.invalidSources.join(
+          ", "
+        )}.`;
       }
     }
     if (options.excludedSources !== void 0) {
@@ -762,7 +955,9 @@ var Valyu = class {
       }
       const validation = this.validateSources(options.excludedSources);
       if (!validation.valid) {
-        return `Invalid excludedSources format. Invalid sources: ${validation.invalidSources.join(", ")}.`;
+        return `Invalid excludedSources format. Invalid sources: ${validation.invalidSources.join(
+          ", "
+        )}.`;
       }
     }
     return null;
@@ -781,12 +976,18 @@ var Valyu = class {
       query: query.trim(),
       search_type: finalSearchType
     };
-    if (options.dataMaxPrice !== void 0) payload.data_max_price = options.dataMaxPrice;
-    if (options.structuredOutput !== void 0) payload.structured_output = options.structuredOutput;
-    if (options.systemInstructions !== void 0) payload.system_instructions = options.systemInstructions.trim();
-    if (options.countryCode !== void 0) payload.country_code = options.countryCode;
-    if (options.includedSources !== void 0) payload.included_sources = options.includedSources;
-    if (options.excludedSources !== void 0) payload.excluded_sources = options.excludedSources;
+    if (options.dataMaxPrice !== void 0)
+      payload.data_max_price = options.dataMaxPrice;
+    if (options.structuredOutput !== void 0)
+      payload.structured_output = options.structuredOutput;
+    if (options.systemInstructions !== void 0)
+      payload.system_instructions = options.systemInstructions.trim();
+    if (options.countryCode !== void 0)
+      payload.country_code = options.countryCode;
+    if (options.includedSources !== void 0)
+      payload.included_sources = options.includedSources;
+    if (options.excludedSources !== void 0)
+      payload.excluded_sources = options.excludedSources;
     if (options.startDate !== void 0) payload.start_date = options.startDate;
     if (options.endDate !== void 0) payload.end_date = options.endDate;
     if (options.fastMode !== void 0) payload.fast_mode = options.fastMode;
@@ -801,7 +1002,7 @@ var Valyu = class {
         method: "POST",
         headers: {
           ...this.headers,
-          "Accept": "text/event-stream"
+          Accept: "text/event-stream"
         },
         body: JSON.stringify(payload)
       });
@@ -854,9 +1055,20 @@ var Valyu = class {
           contents: fullContent || finalMetadata.contents || "",
           data_type: finalMetadata.data_type || "unstructured",
           search_results: finalSearchResults,
-          search_metadata: finalMetadata.search_metadata || { tx_ids: [], number_of_results: 0, total_characters: 0 },
-          ai_usage: finalMetadata.ai_usage || { input_tokens: 0, output_tokens: 0 },
-          cost: finalMetadata.cost || { total_deduction_dollars: 0, search_deduction_dollars: 0, ai_deduction_dollars: 0 }
+          search_metadata: finalMetadata.search_metadata || {
+            tx_ids: [],
+            number_of_results: 0,
+            total_characters: 0
+          },
+          ai_usage: finalMetadata.ai_usage || {
+            input_tokens: 0,
+            output_tokens: 0
+          },
+          cost: finalMetadata.cost || {
+            total_deduction_dollars: 0,
+            search_deduction_dollars: 0,
+            ai_deduction_dollars: 0
+          }
         };
         if (finalMetadata.extraction_metadata) {
           response2.extraction_metadata = finalMetadata.extraction_metadata;
@@ -883,13 +1095,16 @@ var Valyu = class {
         method: "POST",
         headers: {
           ...this.headers,
-          "Accept": "text/event-stream"
+          Accept: "text/event-stream"
         },
         body: JSON.stringify(payload)
       });
       if (!response.ok) {
         const errorData = await response.json().catch(() => ({}));
-        yield { type: "error", error: errorData.error || `HTTP Error: ${response.status}` };
+        yield {
+          type: "error",
+          error: errorData.error || `HTTP Error: ${response.status}`
+        };
         return;
       }
       const reader = response.body?.getReader();
@@ -915,7 +1130,10 @@ var Valyu = class {
           try {
             const parsed = JSON.parse(dataStr);
             if (parsed.search_results && parsed.success === void 0) {
-              yield { type: "search_results", search_results: parsed.search_results };
+              yield {
+                type: "search_results",
+                search_results: parsed.search_results
+              };
             } else if (parsed.choices) {
               const delta = parsed.choices[0]?.delta || {};
               const content = delta.content || "";