@youdotcom-oss/ai-sdk-plugin 2.0.7 → 2.1.1

package/README.md

@@ -6,7 +6,7 @@ Give your AI applications **real-time access to the web** with native AI SDK too
 
 Build AI applications that can:
 - **Search the web in real-time** - Access current information with advanced filtering (dates, sites, file types)
-- **Generate answers with web context** - Fast AI responses enhanced with live web data
+- **Research** - Comprehensive answers with cited sources, configurable effort (lite to exhaustive)
 - **Extract any webpage** - Pull full content in markdown or HTML format
 - **Zero configuration** - Works with any AI SDK model provider (Anthropic, OpenAI, Google, and more)
 - **Type-safe** - Full TypeScript support with Zod schema validation
@@ -57,7 +57,7 @@ Import the tools and add them to your AI SDK configuration:
 ```typescript
 import { createAnthropic } from '@ai-sdk/anthropic';
 import { generateText, stepCountIs } from 'ai';
-import { youSearch, youContents } from '@youdotcom-oss/ai-sdk-plugin';
+import { youSearch, youResearch, youContents } from '@youdotcom-oss/ai-sdk-plugin';
 
 // Create your AI model provider
 const anthropic = createAnthropic({
@@ -68,6 +68,7 @@ const result = await generateText({
   model: anthropic('claude-sonnet-4-5-20250929'),
   tools: {
     search: youSearch(),
+    research: youResearch(),
     extract: youContents(),
   },
   stopWhen: stepCountIs(5),  // Required for tool result processing
@@ -228,6 +229,15 @@ Comprehensive web and news search with advanced filtering capabilities. Perfect
 - Finding specific content with filters (dates, sites, file types)
 - Research queries requiring multiple results
 
+### youResearch()
+
+Research with comprehensive answers and cited sources. Configurable effort levels (lite, standard, deep, exhaustive) let you trade speed for thoroughness.
+
+**When your AI will use this:**
+- Complex questions requiring in-depth analysis
+- Research reports needing cited sources
+- Thorough comparisons or detailed explanations
+
 ### youContents()
 
 Extract full page content from URLs in markdown or HTML format. Useful for documentation analysis, content processing, and batch URL extraction.

package/dist/main.d.ts

@@ -10,27 +10,14 @@ export type YouToolsConfig = {
  * @param config - Configuration options
  * @returns A tool that can be used with AI SDK's generateText, streamText, etc.
  *
- * @example
- * ```ts
- * import { generateText, stepCountIs } from 'ai';
- * import { youSearch } from '@youdotcom-oss/ai-sdk-plugin';
- *
- * const { text } = await generateText({
- *   model: 'anthropic/claude-sonnet-4.5',
- *   prompt: 'What happened in San Francisco last week?',
- *   tools: {
- *     search: youSearch(),
- *   },
- *   stopWhen: stepCountIs(3),
- * });
- * ```
+ * @public
  */
 export declare const youSearch: (config?: YouToolsConfig) => import("ai").Tool<{
     query: string;
     count?: number | undefined;
     freshness?: string | undefined;
     offset?: number | undefined;
-    country?: "AR" | "CA" | "NL" | "FI" | "FR" | "DE" | "IT" | "JP" | "PL" | "PT-BR" | "RU" | "ES" | "TR" | "AU" | "AT" | "BE" | "BR" | "CL" | "DK" | "HK" | "IN" | "ID" | "KR" | "MY" | "MX" | "NZ" | "NO" | "CN" | "PT" | "PH" | "SA" | "ZA" | "SE" | "CH" | "TW" | "GB" | "US" | undefined;
+    country?: "AR" | "CA" | "NL" | "FI" | "FR" | "DE" | "IT" | "JP" | "PL" | "RU" | "ES" | "TR" | "AU" | "AT" | "BE" | "BR" | "CL" | "DK" | "HK" | "IN" | "ID" | "KR" | "MY" | "MX" | "NZ" | "NO" | "CN" | "PT" | "PH" | "SA" | "ZA" | "SE" | "CH" | "TW" | "GB" | "US" | undefined;
     safesearch?: "off" | "moderate" | "strict" | undefined;
     livecrawl?: "web" | "news" | "all" | undefined;
     livecrawl_formats?: "markdown" | "html" | undefined;
@@ -68,6 +55,30 @@ export declare const youSearch: (config?: YouToolsConfig) => import("ai").Tool<{
         latency?: number | undefined;
     };
 }>;
+/**
+ * You.com research tool for Vercel AI SDK
+ *
+ * Perform research with cited sources and configurable effort (lite, standard, deep, exhaustive).
+ *
+ * @param config - Configuration options
+ * @returns A tool that can be used with AI SDK's generateText, streamText, etc.
+ *
+ * @public
+ */
+export declare const youResearch: (config?: YouToolsConfig) => import("ai").Tool<{
+    input: string;
+    research_effort: "lite" | "standard" | "deep" | "exhaustive";
+}, {
+    output: {
+        content: string;
+        content_type: "text";
+        sources: {
+            url: string;
+            snippets: string[];
+            title?: string | undefined;
+        }[];
+    };
+}>;
 /**
  * You.com content extraction tool for Vercel AI SDK
  *
@@ -76,20 +87,7 @@ export declare const youSearch: (config?: YouToolsConfig) => import("ai").Tool<{
  * @param config - Configuration options
  * @returns A tool that can be used with AI SDK's generateText, streamText, etc.
  *
- * @example
- * ```ts
- * import { generateText, stepCountIs } from 'ai';
- * import { youContents } from '@youdotcom-oss/ai-sdk-plugin';
- *
- * const { text } = await generateText({
- *   model: 'anthropic/claude-sonnet-4.5',
- *   prompt: 'Summarize the content from vercel.com/blog',
- *   tools: {
- *     extract: youContents(),
- *   },
- *   stopWhen: stepCountIs(3),
- * });
- * ```
+ * @public
  */
 export declare const youContents: (config?: YouToolsConfig) => import("ai").Tool<{
     urls: string[];