@tavily/ai-sdk 0.1.1 → 0.3.0

package/README.md

@@ -76,6 +76,7 @@ const result = await generateText({
 - `autoParameters?: boolean` - Enable automatic parameter optimization
 - `timeout?: number` - Request timeout in milliseconds
 - `includeFavicon?: boolean` - Include favicon URLs in results
+- `includeUsage?: boolean` - Whether to include credit usage information in the response.
 - `proxies?: { http?: string, https?: string }` - HTTP/HTTPS proxy configuration
 - `apiBaseURL?: string` - Custom API base URL
 
@@ -104,6 +105,7 @@ const result = await generateText({
 - `format?: "markdown" | "text"` - Output format (default: "markdown")
 - `timeout?: number` - Request timeout in milliseconds
 - `includeFavicon?: boolean` - Include favicon URLs in results
+- `includeUsage?: boolean` - Whether to include credit usage information in the response. NOTE:The value may be 0 if the total successful URL extractions has not yet reached 5 calls. See our [Credits & Pricing documentation]("https://docs.tavily.com/documentation/api-credits") for details.
 - `proxies?: { http?: string, https?: string }` - HTTP/HTTPS proxy configuration
 - `apiBaseURL?: string` - Custom API base URL
 
@@ -145,6 +147,7 @@ const result = await generateText({
 - `format?: "markdown" | "text"` - Output format (default: "markdown")
 - `timeout?: number` - Request timeout in milliseconds
 - `includeFavicon?: boolean` - Include favicon URLs in results
+- `includeUsage?: boolean` - Whether to include credit usage information in the response. NOTE:The value may be 0 if the total use of /extract and /map have not yet reached minimum requirements. See our [Credits & Pricing documentation]("https://docs.tavily.com/documentation/api-credits") for details.
 - `proxies?: { http?: string, https?: string }` - HTTP/HTTPS proxy configuration
 - `apiBaseURL?: string` - Custom API base URL
 
@@ -187,6 +190,7 @@ const result = await generateText({
 - `timeout?: number` - Request timeout in milliseconds
 - `proxies?: { http?: string, https?: string }` - HTTP/HTTPS proxy configuration
 - `apiBaseURL?: string` - Custom API base URL
+- `includeUsage?: boolean` - Whether to include credit usage information in the response.NOTE:The value may be 0 if the total successful pages mapped has not yet reached 10 calls. See our [Credits & Pricing documentation]("https://docs.tavily.com/documentation/api-credits") for details.
 
 **Input Parameters (for AI agent):**
 - `url: string` - Base URL to start mapping from (required)

package/dist/index.d.ts

@@ -21,6 +21,7 @@ type TavilyExtractOptions = TavilyClientOptions & Partial<TavilyExtractOptions$1
 declare const tavilyExtract: (options?: TavilyExtractOptions) => ai.Tool<{
     urls: string[];
     extractDepth?: "basic" | "advanced" | undefined;
+    query?: string | undefined;
 }, _tavily_core.TavilyExtractResponse>;
 
 type TavilyCrawlOptions = TavilyClientOptions & Partial<TavilyCrawlOptions$1>;

package/dist/index.js

@@ -38,18 +38,21 @@ var tavilyExtract = (options = {}) => {
     urls: z2.array(z2.string()).describe("Array of URLs to extract content from"),
     extractDepth: z2.enum(["basic", "advanced"]).optional().describe(
       "Extraction depth - 'basic' for main content, 'advanced' for comprehensive extraction (default: 'basic')"
-    )
+    ),
+    query: z2.string().optional().describe("User intent query for reranking extracted content chunks")
   });
   return tool2({
     description: "Extract clean, structured content from one or more URLs. Returns parsed content in markdown or text format, optimized for AI consumption.",
     inputSchema,
     execute: async ({
       urls,
-      extractDepth: inputExtractDepth
+      extractDepth: inputExtractDepth,
+      query: inputQuery
     }) => {
       return await client.extract(urls, {
         ...options,
-        extractDepth: inputExtractDepth ?? options.extractDepth
+        extractDepth: inputExtractDepth ?? options.extractDepth,
+        query: inputQuery ?? options.query
       });
     }
   });
@@ -87,7 +90,8 @@ var tavilyCrawl = (options = {}) => {
         maxDepth: inputMaxDepth ?? options.maxDepth,
         extractDepth: inputExtractDepth ?? options.extractDepth,
         instructions: inputInstructions ?? options.instructions,
-        allowExternal: inputAllowExternal ?? options.allowExternal
+        allowExternal: inputAllowExternal ?? options.allowExternal,
+        chunksPerSource: 3
       });
     }
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tavily/ai-sdk",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Tavily AI SDK tools - Search, Extract, Crawl, and Map",
   "type": "module",
   "main": "./dist/index.js",