valyu-js 2.7.1 → 2.7.3

package/dist/index.d.mts

@@ -207,7 +207,7 @@ type DeepResearchMode = "fast" | "standard" | "lite" | "heavy" | "max";
 type DeepResearchStatus = "queued" | "running" | "awaiting_input" | "paused" | "completed" | "failed" | "cancelled";
 type DeepResearchOutputFormat = "markdown" | "pdf" | "toon" | Record<string, any>;
 type DeepResearchOutputType = "markdown" | "json" | "toon";
-type ImageType = "chart" | "ai_generated";
+type ImageType = "chart" | "ai_generated" | "screenshot";
 type ChartType = "line" | "bar" | "area";
 interface FileAttachment {
     data: string;
@@ -261,6 +261,10 @@ interface DeepResearchSearchConfig {
     category?: string;
     countryCode?: CountryCode;
 }
+interface DeepResearchTools {
+    code_execution?: boolean;
+    screenshots?: boolean;
+}
 interface DeepResearchCreateOptions {
     query?: string;
     input?: string;
@@ -275,7 +279,9 @@ interface DeepResearchCreateOptions {
     files?: FileAttachment[];
     deliverables?: (string | Deliverable)[];
     mcpServers?: MCPServerConfig[];
+    /** @deprecated Use tools.code_execution instead */
     codeExecution?: boolean;
+    tools?: DeepResearchTools;
     previousReports?: string[];
     webhookUrl?: string;
     alertEmail?: string | AlertEmailConfig;
@@ -331,6 +337,8 @@ interface ImageMetadata {
     x_axis_label?: string;
     y_axis_label?: string;
     data_series?: ChartDataSeries[];
+    source_url?: string;
+    captured_at?: number;
 }
 interface DeepResearchSource {
     title: string;
@@ -354,6 +362,12 @@ interface DeepResearchUsage {
     compute_cost: number;
     total_cost: number;
 }
+interface DeepResearchCostBreakdown {
+    task: number;
+    screenshots?: number;
+    code_execution?: number;
+    deliverables?: number;
+}
 interface DeepResearchCreateResponse {
     success: boolean;
     deepresearch_id?: string;
@@ -387,6 +401,8 @@ interface DeepResearchStatusResponse {
     sources?: DeepResearchSource[];
     cost?: number;
     usage?: DeepResearchUsage;
+    cost_breakdown?: DeepResearchCostBreakdown;
+    tools?: DeepResearchTools;
     batch_id?: string;
     batch_task_id?: string;
     hitl_config?: Record<string, boolean>;
@@ -451,6 +467,7 @@ interface WaitOptions {
     pollInterval?: number;
     maxWaitTime?: number;
     onProgress?: (status: DeepResearchStatusResponse) => void;
+    onInteraction?: (interaction: Interaction) => Promise<Record<string, any> | null | undefined> | Record<string, any> | null | undefined;
 }
 interface StreamCallback {
     onMessage?: (message: any) => void;
@@ -683,6 +700,16 @@ declare class Valyu {
         togglePublic: (taskId: string, isPublic: boolean) => Promise<DeepResearchTogglePublicResponse>;
         getAssets: (taskId: string, assetId: string, options?: DeepResearchGetAssetsOptions) => Promise<DeepResearchGetAssetsResponse>;
         respond: (taskId: string, interactionId: string, response: Record<string, any>) => Promise<DeepResearchRespondResponse>;
+        respondPlanningQuestions: (taskId: string, interactionId: string, answers: {
+            question: string;
+            answer: string;
+        }[]) => Promise<DeepResearchRespondResponse>;
+        approvePlan: (taskId: string, interactionId: string, modifications?: string) => Promise<DeepResearchRespondResponse>;
+        respondSourceReview: (taskId: string, interactionId: string, options?: {
+            includedDomains?: string[];
+            excludedDomains?: string[];
+        }) => Promise<DeepResearchRespondResponse>;
+        approveOutline: (taskId: string, interactionId: string, modifications?: string) => Promise<DeepResearchRespondResponse>;
     };
     batch: {
         create: (options?: CreateBatchOptions) => Promise<CreateBatchResponse>;
@@ -808,6 +835,22 @@ declare class Valyu {
      * @param response - Response data matching the checkpoint type
      */
     private _deepresearchRespond;
+    /**
+     * DeepResearch: Respond to a planning_questions checkpoint
+     */
+    private _deepresearchRespondPlanningQuestions;
+    /**
+     * DeepResearch: Approve or request modifications to a plan_review checkpoint
+     */
+    private _deepresearchApprovePlan;
+    /**
+     * DeepResearch: Respond to a source_review checkpoint
+     */
+    private _deepresearchRespondSourceReview;
+    /**
+     * DeepResearch: Approve or request modifications to an outline_review checkpoint
+     */
+    private _deepresearchApproveOutline;
     /**
      * DeepResearch: Cancel task
      */
@@ -941,4 +984,4 @@ declare class Valyu {
     private _datasourcesCategories;
 }
 
-export { type AIUsage, type AddBatchTasksOptions, type AddBatchTasksResponse, type AlertEmailConfig, type AnswerErrorResponse, type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamChunkType, type AnswerSuccessResponse, type BatchCounts, type BatchPagination, type BatchStatus, type BatchStatusResponse, type BatchTaskCreated, type BatchTaskInput, type BatchTaskListItem, type BatchWaitOptions, type CancelBatchResponse, type ChartDataPoint, type ChartDataSeries, type ChartType, type ContentResponseLength, type ContentResult, type ContentResultFailed, type ContentResultSuccess, type ContentsAsyncJobResponse, type ContentsJobResponse, type ContentsJobStatus, type ContentsJobWaitOptions, type ContentsOptions, type ContentsResponse, type Cost, type CountryCode, type CreateBatchOptions, type CreateBatchResponse, type Datasource, type DatasourceCategory, type DatasourceCategoryId, type DatasourceCoverage, type DatasourceModality, type DatasourcePricing, type DatasourcesCategoriesResponse, type DatasourcesListOptions, type DatasourcesListResponse, type DeepResearchBatch, type DeepResearchCancelResponse, type DeepResearchCreateOptions, type DeepResearchCreateResponse, type DeepResearchDeleteResponse, type DeepResearchGetAssetsOptions, type DeepResearchGetAssetsResponse, type DeepResearchListResponse, type DeepResearchMode, type DeepResearchOutputFormat, type DeepResearchRespondResponse, type DeepResearchSearchConfig, type DeepResearchSource, type DeepResearchStatus, type DeepResearchStatusResponse, type DeepResearchTaskListItem, type DeepResearchTogglePublicResponse, type DeepResearchUpdateResponse, type DeepResearchUsage, type ExtractEffort, type ExtractionMetadata, type FeedbackResponse, type FeedbackSentiment, type FileAttachment, type HitlConfig, type ImageMetadata, type ImageType, type Interaction, type InteractionHistoryEntry, type InteractionType, type ListBatchTasksOptions, type ListBatchTasksResponse, type ListBatchesOptions, type ListBatchesResponse, type ListOptions, type MCPServerConfig, type Progress, type ResponseLength, type SearchMetadata, type SearchOptions, type SearchResponse, type SearchResult, type SearchType, type StreamCallback, Valyu, type WaitOptions, verifyContentsWebhookSignature };
+export { type AIUsage, type AddBatchTasksOptions, type AddBatchTasksResponse, type AlertEmailConfig, type AnswerErrorResponse, type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamChunkType, type AnswerSuccessResponse, type BatchCounts, type BatchPagination, type BatchStatus, type BatchStatusResponse, type BatchTaskCreated, type BatchTaskInput, type BatchTaskListItem, type BatchWaitOptions, type CancelBatchResponse, type ChartDataPoint, type ChartDataSeries, type ChartType, type ContentResponseLength, type ContentResult, type ContentResultFailed, type ContentResultSuccess, type ContentsAsyncJobResponse, type ContentsJobResponse, type ContentsJobStatus, type ContentsJobWaitOptions, type ContentsOptions, type ContentsResponse, type Cost, type CountryCode, type CreateBatchOptions, type CreateBatchResponse, type Datasource, type DatasourceCategory, type DatasourceCategoryId, type DatasourceCoverage, type DatasourceModality, type DatasourcePricing, type DatasourcesCategoriesResponse, type DatasourcesListOptions, type DatasourcesListResponse, type DeepResearchBatch, type DeepResearchCancelResponse, type DeepResearchCostBreakdown, type DeepResearchCreateOptions, type DeepResearchCreateResponse, type DeepResearchDeleteResponse, type DeepResearchGetAssetsOptions, type DeepResearchGetAssetsResponse, type DeepResearchListResponse, type DeepResearchMode, type DeepResearchOutputFormat, type DeepResearchRespondResponse, type DeepResearchSearchConfig, type DeepResearchSource, type DeepResearchStatus, type DeepResearchStatusResponse, type DeepResearchTaskListItem, type DeepResearchTogglePublicResponse, type DeepResearchTools, type DeepResearchUpdateResponse, type DeepResearchUsage, type ExtractEffort, type ExtractionMetadata, type FeedbackResponse, type FeedbackSentiment, type FileAttachment, type HitlConfig, type ImageMetadata, type ImageType, type Interaction, type InteractionHistoryEntry, type InteractionType, type ListBatchTasksOptions, type ListBatchTasksResponse, type ListBatchesOptions, type ListBatchesResponse, type ListOptions, type MCPServerConfig, type Progress, type ResponseLength, type SearchMetadata, type SearchOptions, type SearchResponse, type SearchResult, type SearchType, type StreamCallback, Valyu, type WaitOptions, verifyContentsWebhookSignature };

package/dist/index.d.ts

@@ -207,7 +207,7 @@ type DeepResearchMode = "fast" | "standard" | "lite" | "heavy" | "max";
 type DeepResearchStatus = "queued" | "running" | "awaiting_input" | "paused" | "completed" | "failed" | "cancelled";
 type DeepResearchOutputFormat = "markdown" | "pdf" | "toon" | Record<string, any>;
 type DeepResearchOutputType = "markdown" | "json" | "toon";
-type ImageType = "chart" | "ai_generated";
+type ImageType = "chart" | "ai_generated" | "screenshot";
 type ChartType = "line" | "bar" | "area";
 interface FileAttachment {
     data: string;
@@ -261,6 +261,10 @@ interface DeepResearchSearchConfig {
     category?: string;
     countryCode?: CountryCode;
 }
+interface DeepResearchTools {
+    code_execution?: boolean;
+    screenshots?: boolean;
+}
 interface DeepResearchCreateOptions {
     query?: string;
     input?: string;
@@ -275,7 +279,9 @@ interface DeepResearchCreateOptions {
     files?: FileAttachment[];
     deliverables?: (string | Deliverable)[];
     mcpServers?: MCPServerConfig[];
+    /** @deprecated Use tools.code_execution instead */
     codeExecution?: boolean;
+    tools?: DeepResearchTools;
     previousReports?: string[];
     webhookUrl?: string;
     alertEmail?: string | AlertEmailConfig;
@@ -331,6 +337,8 @@ interface ImageMetadata {
     x_axis_label?: string;
     y_axis_label?: string;
     data_series?: ChartDataSeries[];
+    source_url?: string;
+    captured_at?: number;
 }
 interface DeepResearchSource {
     title: string;
@@ -354,6 +362,12 @@ interface DeepResearchUsage {
     compute_cost: number;
     total_cost: number;
 }
+interface DeepResearchCostBreakdown {
+    task: number;
+    screenshots?: number;
+    code_execution?: number;
+    deliverables?: number;
+}
 interface DeepResearchCreateResponse {
     success: boolean;
     deepresearch_id?: string;
@@ -387,6 +401,8 @@ interface DeepResearchStatusResponse {
     sources?: DeepResearchSource[];
     cost?: number;
     usage?: DeepResearchUsage;
+    cost_breakdown?: DeepResearchCostBreakdown;
+    tools?: DeepResearchTools;
     batch_id?: string;
     batch_task_id?: string;
     hitl_config?: Record<string, boolean>;
@@ -451,6 +467,7 @@ interface WaitOptions {
     pollInterval?: number;
     maxWaitTime?: number;
     onProgress?: (status: DeepResearchStatusResponse) => void;
+    onInteraction?: (interaction: Interaction) => Promise<Record<string, any> | null | undefined> | Record<string, any> | null | undefined;
 }
 interface StreamCallback {
     onMessage?: (message: any) => void;
@@ -683,6 +700,16 @@ declare class Valyu {
         togglePublic: (taskId: string, isPublic: boolean) => Promise<DeepResearchTogglePublicResponse>;
         getAssets: (taskId: string, assetId: string, options?: DeepResearchGetAssetsOptions) => Promise<DeepResearchGetAssetsResponse>;
         respond: (taskId: string, interactionId: string, response: Record<string, any>) => Promise<DeepResearchRespondResponse>;
+        respondPlanningQuestions: (taskId: string, interactionId: string, answers: {
+            question: string;
+            answer: string;
+        }[]) => Promise<DeepResearchRespondResponse>;
+        approvePlan: (taskId: string, interactionId: string, modifications?: string) => Promise<DeepResearchRespondResponse>;
+        respondSourceReview: (taskId: string, interactionId: string, options?: {
+            includedDomains?: string[];
+            excludedDomains?: string[];
+        }) => Promise<DeepResearchRespondResponse>;
+        approveOutline: (taskId: string, interactionId: string, modifications?: string) => Promise<DeepResearchRespondResponse>;
     };
     batch: {
         create: (options?: CreateBatchOptions) => Promise<CreateBatchResponse>;
@@ -808,6 +835,22 @@ declare class Valyu {
      * @param response - Response data matching the checkpoint type
      */
     private _deepresearchRespond;
+    /**
+     * DeepResearch: Respond to a planning_questions checkpoint
+     */
+    private _deepresearchRespondPlanningQuestions;
+    /**
+     * DeepResearch: Approve or request modifications to a plan_review checkpoint
+     */
+    private _deepresearchApprovePlan;
+    /**
+     * DeepResearch: Respond to a source_review checkpoint
+     */
+    private _deepresearchRespondSourceReview;
+    /**
+     * DeepResearch: Approve or request modifications to an outline_review checkpoint
+     */
+    private _deepresearchApproveOutline;
     /**
      * DeepResearch: Cancel task
      */
@@ -941,4 +984,4 @@ declare class Valyu {
     private _datasourcesCategories;
 }
 
-export { type AIUsage, type AddBatchTasksOptions, type AddBatchTasksResponse, type AlertEmailConfig, type AnswerErrorResponse, type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamChunkType, type AnswerSuccessResponse, type BatchCounts, type BatchPagination, type BatchStatus, type BatchStatusResponse, type BatchTaskCreated, type BatchTaskInput, type BatchTaskListItem, type BatchWaitOptions, type CancelBatchResponse, type ChartDataPoint, type ChartDataSeries, type ChartType, type ContentResponseLength, type ContentResult, type ContentResultFailed, type ContentResultSuccess, type ContentsAsyncJobResponse, type ContentsJobResponse, type ContentsJobStatus, type ContentsJobWaitOptions, type ContentsOptions, type ContentsResponse, type Cost, type CountryCode, type CreateBatchOptions, type CreateBatchResponse, type Datasource, type DatasourceCategory, type DatasourceCategoryId, type DatasourceCoverage, type DatasourceModality, type DatasourcePricing, type DatasourcesCategoriesResponse, type DatasourcesListOptions, type DatasourcesListResponse, type DeepResearchBatch, type DeepResearchCancelResponse, type DeepResearchCreateOptions, type DeepResearchCreateResponse, type DeepResearchDeleteResponse, type DeepResearchGetAssetsOptions, type DeepResearchGetAssetsResponse, type DeepResearchListResponse, type DeepResearchMode, type DeepResearchOutputFormat, type DeepResearchRespondResponse, type DeepResearchSearchConfig, type DeepResearchSource, type DeepResearchStatus, type DeepResearchStatusResponse, type DeepResearchTaskListItem, type DeepResearchTogglePublicResponse, type DeepResearchUpdateResponse, type DeepResearchUsage, type ExtractEffort, type ExtractionMetadata, type FeedbackResponse, type FeedbackSentiment, type FileAttachment, type HitlConfig, type ImageMetadata, type ImageType, type Interaction, type InteractionHistoryEntry, type InteractionType, type ListBatchTasksOptions, type ListBatchTasksResponse, type ListBatchesOptions, type ListBatchesResponse, type ListOptions, type MCPServerConfig, type Progress, type ResponseLength, type SearchMetadata, type SearchOptions, type SearchResponse, type SearchResult, type SearchType, type StreamCallback, Valyu, type WaitOptions, verifyContentsWebhookSignature };
+export { type AIUsage, type AddBatchTasksOptions, type AddBatchTasksResponse, type AlertEmailConfig, type AnswerErrorResponse, type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamChunkType, type AnswerSuccessResponse, type BatchCounts, type BatchPagination, type BatchStatus, type BatchStatusResponse, type BatchTaskCreated, type BatchTaskInput, type BatchTaskListItem, type BatchWaitOptions, type CancelBatchResponse, type ChartDataPoint, type ChartDataSeries, type ChartType, type ContentResponseLength, type ContentResult, type ContentResultFailed, type ContentResultSuccess, type ContentsAsyncJobResponse, type ContentsJobResponse, type ContentsJobStatus, type ContentsJobWaitOptions, type ContentsOptions, type ContentsResponse, type Cost, type CountryCode, type CreateBatchOptions, type CreateBatchResponse, type Datasource, type DatasourceCategory, type DatasourceCategoryId, type DatasourceCoverage, type DatasourceModality, type DatasourcePricing, type DatasourcesCategoriesResponse, type DatasourcesListOptions, type DatasourcesListResponse, type DeepResearchBatch, type DeepResearchCancelResponse, type DeepResearchCostBreakdown, type DeepResearchCreateOptions, type DeepResearchCreateResponse, type DeepResearchDeleteResponse, type DeepResearchGetAssetsOptions, type DeepResearchGetAssetsResponse, type DeepResearchListResponse, type DeepResearchMode, type DeepResearchOutputFormat, type DeepResearchRespondResponse, type DeepResearchSearchConfig, type DeepResearchSource, type DeepResearchStatus, type DeepResearchStatusResponse, type DeepResearchTaskListItem, type DeepResearchTogglePublicResponse, type DeepResearchTools, type DeepResearchUpdateResponse, type DeepResearchUsage, type ExtractEffort, type ExtractionMetadata, type FeedbackResponse, type FeedbackSentiment, type FileAttachment, type HitlConfig, type ImageMetadata, type ImageType, type Interaction, type InteractionHistoryEntry, type InteractionType, type ListBatchTasksOptions, type ListBatchTasksResponse, type ListBatchesOptions, type ListBatchesResponse, type ListOptions, type MCPServerConfig, type Progress, type ResponseLength, type SearchMetadata, type SearchOptions, type SearchResponse, type SearchResult, type SearchType, type StreamCallback, Valyu, type WaitOptions, verifyContentsWebhookSignature };

package/dist/index.js

@@ -98,7 +98,11 @@ var Valyu = class {
       delete: this._deepresearchDelete.bind(this),
       togglePublic: this._deepresearchTogglePublic.bind(this),
       getAssets: this._deepresearchGetAssets.bind(this),
-      respond: this._deepresearchRespond.bind(this)
+      respond: this._deepresearchRespond.bind(this),
+      respondPlanningQuestions: this._deepresearchRespondPlanningQuestions.bind(this),
+      approvePlan: this._deepresearchApprovePlan.bind(this),
+      respondSourceReview: this._deepresearchRespondSourceReview.bind(this),
+      approveOutline: this._deepresearchApproveOutline.bind(this)
     };
     this.batch = {
       create: this._batchCreate.bind(this),
@@ -656,9 +660,13 @@ var Valyu = class {
         query: queryValue,
         mode: mode || "fast",
         // API defaults to "standard", but we keep "fast" for backward compatibility
-        output_formats: options.outputFormats || ["markdown"],
-        code_execution: options.codeExecution !== false
+        output_formats: options.outputFormats || ["markdown"]
       };
+      if (options.tools) {
+        payload.tools = options.tools;
+      } else if (options.codeExecution !== void 0) {
+        payload.code_execution = options.codeExecution;
+      }
       if (options.strategy) payload.strategy = options.strategy;
       if (options.researchStrategy)
         payload.research_strategy = options.researchStrategy;
@@ -765,6 +773,19 @@ var Valyu = class {
       if (options.onProgress) {
         options.onProgress(status);
       }
+      if ((status.status === "awaiting_input" || status.status === "paused") && status.interaction) {
+        if (options.onInteraction) {
+          const response = await options.onInteraction(status.interaction);
+          if (response) {
+            await this._deepresearchRespond(
+              taskId,
+              status.interaction.interaction_id,
+              response
+            );
+            continue;
+          }
+        }
+      }
       if (status.status === "completed" || status.status === "failed" || status.status === "cancelled") {
         return status;
       }
@@ -890,6 +911,45 @@ var Valyu = class {
       };
     }
   }
+  /**
+   * DeepResearch: Respond to a planning_questions checkpoint
+   */
+  async _deepresearchRespondPlanningQuestions(taskId, interactionId, answers) {
+    return this._deepresearchRespond(taskId, interactionId, {
+      answers
+    });
+  }
+  /**
+   * DeepResearch: Approve or request modifications to a plan_review checkpoint
+   */
+  async _deepresearchApprovePlan(taskId, interactionId, modifications) {
+    const response = { approved: true };
+    if (modifications) {
+      response.approved = false;
+      response.modifications = modifications;
+    }
+    return this._deepresearchRespond(taskId, interactionId, response);
+  }
+  /**
+   * DeepResearch: Respond to a source_review checkpoint
+   */
+  async _deepresearchRespondSourceReview(taskId, interactionId, options = {}) {
+    return this._deepresearchRespond(taskId, interactionId, {
+      included_domains: options.includedDomains || [],
+      excluded_domains: options.excludedDomains || []
+    });
+  }
+  /**
+   * DeepResearch: Approve or request modifications to an outline_review checkpoint
+   */
+  async _deepresearchApproveOutline(taskId, interactionId, modifications) {
+    const response = { approved: true };
+    if (modifications) {
+      response.approved = false;
+      response.modifications = modifications;
+    }
+    return this._deepresearchRespond(taskId, interactionId, response);
+  }
   /**
    * DeepResearch: Cancel task
    */