@tavily/ai-sdk 0.1.0 → 0.2.0

package/README.md

@@ -39,7 +39,7 @@ Search the web for real-time, AI-optimized information:
 
 ```typescript
 import { tavilySearch } from "@tavily/ai-sdk";
-import { generateText, gateway } from "ai";
+import { generateText, gateway, stepCountIs } from "ai";
 
 const result = await generateText({
   model: gateway("openai/gpt-5-mini"),
@@ -51,6 +51,7 @@ const result = await generateText({
       maxResults: 5,
     }),
   },
+  stopWhen: stepCountIs(3),
 });
 ```
 
@@ -75,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
 
@@ -84,7 +86,7 @@ Extract clean, structured content from URLs:
 
 ```typescript
 import { tavilyExtract } from "@tavily/ai-sdk";
-import { generateText, gateway } from "ai";
+import { generateText, gateway, stepCountIs } from "ai";
 
 const result = await generateText({
   model: gateway("openai/gpt-5-mini"),
@@ -92,6 +94,7 @@ const result = await generateText({
   tools: {
     tavilyExtract: tavilyExtract(),
   },
+  stopWhen: stepCountIs(3),
 });
 ```
 
@@ -102,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
 
@@ -115,7 +119,7 @@ Crawl websites to discover and extract content from multiple pages:
 
 ```typescript
 import { tavilyCrawl } from "@tavily/ai-sdk";
-import { generateText, gateway } from "ai";
+import { generateText, gateway, stepCountIs } from "ai";
 
 const result = await generateText({
   model: gateway("openai/gpt-5-mini"),
@@ -123,6 +127,7 @@ const result = await generateText({
   tools: {
     tavilyCrawl: tavilyCrawl(),
   },
+  stopWhen: stepCountIs(3),
 });
 ```
 
@@ -142,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
 
@@ -158,7 +164,7 @@ Map website structure to understand site architecture:
 
 ```typescript
 import { tavilyMap } from "@tavily/ai-sdk";
-import { generateText, gateway } from "ai";
+import { generateText, gateway, stepCountIs } from "ai";
 
 const result = await generateText({
   model: gateway("openai/gpt-5-mini"),
@@ -166,6 +172,7 @@ const result = await generateText({
   tools: {
     tavilyMap: tavilyMap(),
   },
+  stopWhen: stepCountIs(3),
 });
 ```
 
@@ -183,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)
@@ -202,7 +210,7 @@ import {
   tavilyCrawl, 
   tavilyMap 
 } from "@tavily/ai-sdk";
-import { generateText, gateway } from "ai";
+import { generateText, gateway, stepCountIs } from "ai";
 
 const result = await generateText({
   model: gateway("openai/gpt-5-mini"),
@@ -213,6 +221,7 @@ const result = await generateText({
     tavilyCrawl: tavilyCrawl(),
     tavilyMap: tavilyMap(),
   },
+  stopWhen: stepCountIs(3),
 });
 ```
 

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>;
@@ -34,6 +35,7 @@ declare const tavilyCrawl: (options?: TavilyCrawlOptions) => ai.Tool<{
     extractDepth?: "basic" | "advanced" | undefined;
     instructions?: string | undefined;
     allowExternal?: boolean | undefined;
+    query?: string | undefined;
 }, _tavily_core.TavilyCrawlResponse>;
 
 type TavilyMapOptions = TavilyClientOptions & Partial<TavilyMapOptions$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
       });
     }
   });
@@ -70,7 +73,8 @@ var tavilyCrawl = (options = {}) => {
     instructions: z3.string().optional().describe(
       "Optional instructions to guide the crawler (e.g., 'only crawl blog posts', 'focus on product pages')"
     ),
-    allowExternal: z3.boolean().optional().describe("Whether to allow crawling external domains (default: false)")
+    allowExternal: z3.boolean().optional().describe("Whether to allow crawling external domains (default: false)"),
+    query: z3.string().optional().describe("User intent query for reranking extracted content chunks")
   });
   return tool3({
     description: "Crawl a website starting from a base URL to discover and extract content from multiple pages. Intelligently traverses links and extracts structured data at scale.",
@@ -80,14 +84,16 @@ var tavilyCrawl = (options = {}) => {
       maxDepth: inputMaxDepth,
       extractDepth: inputExtractDepth,
       instructions: inputInstructions,
-      allowExternal: inputAllowExternal
+      allowExternal: inputAllowExternal,
+      query: inputQuery
     }) => {
       return await client.crawl(url, {
         ...options,
         maxDepth: inputMaxDepth ?? options.maxDepth,
         extractDepth: inputExtractDepth ?? options.extractDepth,
         instructions: inputInstructions ?? options.instructions,
-        allowExternal: inputAllowExternal ?? options.allowExternal
+        allowExternal: inputAllowExternal ?? options.allowExternal,
+        query: inputQuery ?? options.query
       });
     }
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tavily/ai-sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Tavily AI SDK tools - Search, Extract, Crawl, and Map",
   "type": "module",
   "main": "./dist/index.js",
@@ -31,6 +31,14 @@
   ],
   "author": "Tavily",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tavily-ai/ai-sdk"
+  },
+  "homepage": "https://docs.tavily.com/documentation/integrations/vercel",
+  "bugs": {
+    "url": "https://github.com/tavily-ai/ai-sdk/issues"
+  },
   "packageManager": "pnpm@10.8.0",
   "devDependencies": {
     "@ai-sdk/openai": "^2.0.71",