valyu-js 2.3.3 → 2.4.1

package/dist/index.d.mts

@@ -59,6 +59,7 @@ interface ContentsOptions {
     extractEffort?: ExtractEffort;
     responseLength?: ContentResponseLength;
     maxPriceDollars?: number;
+    screenshot?: boolean;
 }
 interface ContentResult {
     url: string;
@@ -66,10 +67,13 @@ interface ContentResult {
     content: string | number;
     length: number;
     source: string;
+    price: number;
+    description?: string;
     summary?: string | object;
     summary_success?: boolean;
     data_type?: string;
     image_url?: Record<string, string>;
+    screenshot_url?: string | null;
     citation?: string;
 }
 interface ContentsResponse {
@@ -154,7 +158,7 @@ interface AnswerStreamChunk {
 }
 type DeepResearchMode = "fast" | "standard" | "lite" | "heavy";
 type DeepResearchStatus = "queued" | "running" | "completed" | "failed" | "cancelled";
-type DeepResearchOutputFormat = "markdown" | "pdf" | Record<string, any>;
+type DeepResearchOutputFormat = "markdown" | "pdf" | "toon" | Record<string, any>;
 type DeepResearchOutputType = "markdown" | "json";
 type ImageType = "chart" | "ai_generated";
 type ChartType = "line" | "bar" | "area";
@@ -203,6 +207,10 @@ interface DeliverableResult {
 interface DeepResearchSearchConfig {
     searchType?: "all" | "web" | "proprietary";
     includedSources?: string[];
+    excludedSources?: string[];
+    startDate?: string;
+    endDate?: string;
+    category?: string;
 }
 interface DeepResearchCreateOptions {
     input: string;
@@ -393,10 +401,7 @@ interface CreateBatchOptions {
     name?: string;
     model?: DeepResearchMode;
     outputFormats?: DeepResearchOutputFormat[];
-    search?: {
-        searchType?: "all" | "web" | "proprietary";
-        includedSources?: string[];
-    };
+    search?: DeepResearchSearchConfig;
     webhookUrl?: string;
     metadata?: Record<string, string | number | boolean>;
 }
@@ -535,14 +540,22 @@ declare class Valyu {
      * @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
      */
     contents(urls: string[], options?: ContentsOptions): Promise<ContentsResponse>;
     /**
      * DeepResearch: Create a new research task
+     * @param options.search - Search configuration options
+     * @param options.search.searchType - Type of search: "all", "web", or "proprietary" (default: "all")
+     * @param options.search.includedSources - Array of source types to include (e.g., ["academic", "finance", "web"])
+     * @param options.search.excludedSources - Array of source types to exclude (e.g., ["web", "patent"])
+     * @param options.search.startDate - Start date filter in ISO format (YYYY-MM-DD)
+     * @param options.search.endDate - End date filter in ISO format (YYYY-MM-DD)
+     * @param options.search.category - Category filter for search results
      */
     private _deepresearchCreate;
     /**
@@ -584,6 +597,12 @@ declare class Valyu {
      * @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.search.searchType - Type of search: "all", "web", or "proprietary" (default: "all")
+     * @param options.search.includedSources - Array of source types to include (e.g., ["academic", "finance", "web"])
+     * @param options.search.excludedSources - Array of source types to exclude (e.g., ["web", "patent"])
+     * @param options.search.startDate - Start date filter in ISO format (YYYY-MM-DD)
+     * @param options.search.endDate - End date filter in ISO format (YYYY-MM-DD)
+     * @param options.search.category - Category filter for search results
      * @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

package/dist/index.d.ts

@@ -59,6 +59,7 @@ interface ContentsOptions {
     extractEffort?: ExtractEffort;
     responseLength?: ContentResponseLength;
     maxPriceDollars?: number;
+    screenshot?: boolean;
 }
 interface ContentResult {
     url: string;
@@ -66,10 +67,13 @@ interface ContentResult {
     content: string | number;
     length: number;
     source: string;
+    price: number;
+    description?: string;
     summary?: string | object;
     summary_success?: boolean;
     data_type?: string;
     image_url?: Record<string, string>;
+    screenshot_url?: string | null;
     citation?: string;
 }
 interface ContentsResponse {
@@ -154,7 +158,7 @@ interface AnswerStreamChunk {
 }
 type DeepResearchMode = "fast" | "standard" | "lite" | "heavy";
 type DeepResearchStatus = "queued" | "running" | "completed" | "failed" | "cancelled";
-type DeepResearchOutputFormat = "markdown" | "pdf" | Record<string, any>;
+type DeepResearchOutputFormat = "markdown" | "pdf" | "toon" | Record<string, any>;
 type DeepResearchOutputType = "markdown" | "json";
 type ImageType = "chart" | "ai_generated";
 type ChartType = "line" | "bar" | "area";
@@ -203,6 +207,10 @@ interface DeliverableResult {
 interface DeepResearchSearchConfig {
     searchType?: "all" | "web" | "proprietary";
     includedSources?: string[];
+    excludedSources?: string[];
+    startDate?: string;
+    endDate?: string;
+    category?: string;
 }
 interface DeepResearchCreateOptions {
     input: string;
@@ -393,10 +401,7 @@ interface CreateBatchOptions {
     name?: string;
     model?: DeepResearchMode;
     outputFormats?: DeepResearchOutputFormat[];
-    search?: {
-        searchType?: "all" | "web" | "proprietary";
-        includedSources?: string[];
-    };
+    search?: DeepResearchSearchConfig;
     webhookUrl?: string;
     metadata?: Record<string, string | number | boolean>;
 }
@@ -535,14 +540,22 @@ declare class Valyu {
      * @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
      */
     contents(urls: string[], options?: ContentsOptions): Promise<ContentsResponse>;
     /**
      * DeepResearch: Create a new research task
+     * @param options.search - Search configuration options
+     * @param options.search.searchType - Type of search: "all", "web", or "proprietary" (default: "all")
+     * @param options.search.includedSources - Array of source types to include (e.g., ["academic", "finance", "web"])
+     * @param options.search.excludedSources - Array of source types to exclude (e.g., ["web", "patent"])
+     * @param options.search.startDate - Start date filter in ISO format (YYYY-MM-DD)
+     * @param options.search.endDate - End date filter in ISO format (YYYY-MM-DD)
+     * @param options.search.category - Category filter for search results
      */
     private _deepresearchCreate;
     /**
@@ -584,6 +597,12 @@ declare class Valyu {
      * @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.search.searchType - Type of search: "all", "web", or "proprietary" (default: "all")
+     * @param options.search.includedSources - Array of source types to include (e.g., ["academic", "finance", "web"])
+     * @param options.search.excludedSources - Array of source types to exclude (e.g., ["web", "patent"])
+     * @param options.search.startDate - Start date filter in ISO format (YYYY-MM-DD)
+     * @param options.search.endDate - End date filter in ISO format (YYYY-MM-DD)
+     * @param options.search.category - Category filter for search results
      * @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

package/dist/index.js

@@ -359,9 +359,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 = {}) {
@@ -456,6 +457,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 import_axios.default.post(`${this.baseUrl}/contents`, payload, {
         headers: this.headers
       });
@@ -487,6 +491,13 @@ var Valyu = class {
   }
   /**
    * DeepResearch: Create a new research task
+   * @param options.search - Search configuration options
+   * @param options.search.searchType - Type of search: "all", "web", or "proprietary" (default: "all")
+   * @param options.search.includedSources - Array of source types to include (e.g., ["academic", "finance", "web"])
+   * @param options.search.excludedSources - Array of source types to exclude (e.g., ["web", "patent"])
+   * @param options.search.startDate - Start date filter in ISO format (YYYY-MM-DD)
+   * @param options.search.endDate - End date filter in ISO format (YYYY-MM-DD)
+   * @param options.search.category - Category filter for search results
    */
   async _deepresearchCreate(options) {
     try {
@@ -504,10 +515,25 @@ var Valyu = class {
       };
       if (options.strategy) payload.strategy = options.strategy;
       if (options.search) {
-        payload.search = {
-          search_type: options.search.searchType,
-          included_sources: options.search.includedSources
-        };
+        payload.search = {};
+        if (options.search.searchType) {
+          payload.search.search_type = options.search.searchType;
+        }
+        if (options.search.includedSources) {
+          payload.search.included_sources = options.search.includedSources;
+        }
+        if (options.search.excludedSources) {
+          payload.search.excluded_sources = options.search.excludedSources;
+        }
+        if (options.search.startDate) {
+          payload.search.start_date = options.search.startDate;
+        }
+        if (options.search.endDate) {
+          payload.search.end_date = options.search.endDate;
+        }
+        if (options.search.category) {
+          payload.search.category = options.search.category;
+        }
       }
       if (options.urls) payload.urls = options.urls;
       if (options.files) payload.files = options.files;
@@ -724,6 +750,12 @@ var Valyu = class {
    * @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.search.searchType - Type of search: "all", "web", or "proprietary" (default: "all")
+   * @param options.search.includedSources - Array of source types to include (e.g., ["academic", "finance", "web"])
+   * @param options.search.excludedSources - Array of source types to exclude (e.g., ["web", "patent"])
+   * @param options.search.startDate - Start date filter in ISO format (YYYY-MM-DD)
+   * @param options.search.endDate - End date filter in ISO format (YYYY-MM-DD)
+   * @param options.search.category - Category filter for search results
    * @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
@@ -735,10 +767,25 @@ var Valyu = class {
       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
-        };
+        payload.search = {};
+        if (options.search.searchType) {
+          payload.search.search_type = options.search.searchType;
+        }
+        if (options.search.includedSources) {
+          payload.search.included_sources = options.search.includedSources;
+        }
+        if (options.search.excludedSources) {
+          payload.search.excluded_sources = options.search.excludedSources;
+        }
+        if (options.search.startDate) {
+          payload.search.start_date = options.search.startDate;
+        }
+        if (options.search.endDate) {
+          payload.search.end_date = options.search.endDate;
+        }
+        if (options.search.category) {
+          payload.search.category = options.search.category;
+        }
       }
       if (options.webhookUrl) payload.webhook_url = options.webhookUrl;
       if (options.metadata) payload.metadata = options.metadata;
@@ -795,9 +842,25 @@ var Valyu = class {
           error: "tasks array cannot be empty"
         };
       }
+      if (options.tasks.length > 100) {
+        return {
+          success: false,
+          error: "Maximum 100 tasks allowed per request"
+        };
+      }
+      const tasksPayload = options.tasks.map((task) => {
+        const taskPayload = {
+          input: task.input
+        };
+        if (task.id) taskPayload.id = task.id;
+        if (task.strategy) taskPayload.strategy = task.strategy;
+        if (task.urls) taskPayload.urls = task.urls;
+        if (task.metadata) taskPayload.metadata = task.metadata;
+        return taskPayload;
+      });
       const response = await import_axios.default.post(
         `${this.baseUrl}/deepresearch/batches/${batchId}/tasks`,
-        { tasks: options.tasks },
+        { tasks: tasksPayload },
         { headers: this.headers }
       );
       return { success: true, ...response.data };
@@ -853,10 +916,9 @@ var Valyu = class {
    */
   async _batchList() {
     try {
-      const response = await import_axios.default.get(
-        `${this.baseUrl}/deepresearch/batches`,
-        { headers: this.headers }
-      );
+      const response = await import_axios.default.get(`${this.baseUrl}/deepresearch/batches`, {
+        headers: this.headers
+      });
       return { success: true, batches: response.data };
     } catch (e) {
       return {
@@ -975,7 +1037,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) {
@@ -984,7 +1048,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;
@@ -1003,12 +1069,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;
@@ -1023,7 +1095,7 @@ var Valyu = class {
         method: "POST",
         headers: {
           ...this.headers,
-          "Accept": "text/event-stream"
+          Accept: "text/event-stream"
         },
         body: JSON.stringify(payload)
       });
@@ -1076,9 +1148,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;
@@ -1105,13 +1188,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();
@@ -1137,7 +1223,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 || "";