@youdotcom-oss/ai-sdk-plugin 2.0.6 → 2.1.0

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[];

package/dist/main.js

@@ -1,11 +1,15 @@
 var __defProp = Object.defineProperty;
+var __returnValue = (v) => v;
+function __exportSetter(name, newValue) {
+  this[name] = __returnValue.bind(null, newValue);
+}
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, {
       get: all[name],
       enumerable: true,
       configurable: true,
-      set: (newValue) => all[name] = () => newValue
+      set: __exportSetter.bind(all, name)
     });
 };
 
@@ -13568,7 +13572,7 @@ var ContentsItemSchema = object({
 var ContentsApiResponseSchema = array(ContentsItemSchema);
 // ../api/src/shared/api.constants.ts
 var SEARCH_API_URL = process.env.YDC_SEARCH_API_URL || "https://api.you.com/v1/agents/search";
-var DEEP_SEARCH_API_URL = process.env.YDC_DEEP_SEARCH_API_URL || "https://api.you.com/v1/deep_search";
+var RESEARCH_API_URL = process.env.YDC_RESEARCH_API_URL || "https://api.you.com/v1/research";
 var CONTENTS_API_URL = process.env.YDC_CONTENTS_API_URL || "https://ydc-index.io/v1/contents";
 
 // ../api/src/shared/check-response-for-errors.ts
@@ -13635,21 +13639,58 @@ var fetchContents = async ({
   const parsedResults = ContentsApiResponseSchema.parse(results);
   return parsedResults;
 };
-// ../api/src/deep-search/deep-search.schemas.ts
-var SearchEffortSchema = _enum2(["low", "medium", "high"]).describe("Search effort level");
-var DeepSearchQuerySchema = object({
-  query: string2().min(1, "Query is required").describe("The research question or complex query requiring in-depth investigation and multi-step reasoning"),
-  search_effort: SearchEffortSchema.optional().default("medium").describe("Computation budget: low (<30s), medium (<60s, default), high (<300s)")
+// ../api/src/research/research.schemas.ts
+var ResearchEffortSchema = _enum2(["lite", "standard", "deep", "exhaustive"]).describe("Controls how much time and effort the Research API spends on your question. Higher effort levels run more searches and dig deeper into sources, at the cost of a longer response time.");
+var ResearchQuerySchema = object({
+  input: string2().min(1, "Input is required").describe("The research question or complex query requiring in-depth investigation and multi-step reasoning. Maximum length: 40,000 characters."),
+  research_effort: ResearchEffortSchema.optional().default("standard").describe("Controls how much time and effort the Research API spends on your question. lite: fast answers, standard: balanced (default), deep: thorough, exhaustive: most comprehensive.")
 });
-var DeepSearchSourceSchema = object({
+var ResearchSourceSchema = object({
   url: string2().describe("Source webpage URL"),
-  title: string2().describe("Source webpage title"),
+  title: string2().optional().describe("Source webpage title"),
   snippets: array(string2()).describe("Relevant excerpts from the source page used in generating the answer")
 });
-var DeepSearchResponseSchema = object({
-  answer: string2().describe("Comprehensive response with inline citations, formatted in Markdown"),
-  results: array(DeepSearchSourceSchema).describe("List of web sources used to generate the answer")
+var ResearchOutputSchema = object({
+  content: string2().describe("Comprehensive response with inline citations, formatted in Markdown"),
+  content_type: _enum2(["text"]).describe("The format of the content field"),
+  sources: array(ResearchSourceSchema).describe("List of web sources used to generate the answer")
+});
+var ResearchResponseSchema = object({
+  output: ResearchOutputSchema.describe("The research output containing the answer and sources")
 });
+// ../api/src/research/research.utils.ts
+var callResearch = async ({
+  researchQuery,
+  YDC_API_KEY = process.env.YDC_API_KEY,
+  getUserAgent
+}) => {
+  if (!YDC_API_KEY) {
+    throw new Error("YDC_API_KEY is required for Research API");
+  }
+  const response = await fetch(RESEARCH_API_URL, {
+    method: "POST",
+    headers: new Headers({
+      "X-API-Key": YDC_API_KEY,
+      "Content-Type": "application/json",
+      "User-Agent": getUserAgent()
+    }),
+    body: JSON.stringify(researchQuery)
+  });
+  if (!response.ok) {
+    const errorCode = response.status;
+    if (errorCode === 429) {
+      throw new Error("Rate limited by You.com API. Please try again later.");
+    } else if (errorCode === 403) {
+      throw new Error("Forbidden. Please check your You.com API key.");
+    } else if (errorCode === 402) {
+      throw new Error("Free tier limit exceeded. Please upgrade at: https://you.com/platform");
+    }
+    throw new Error(`Research API request failed. Error code: ${errorCode}`);
+  }
+  const data = await response.json();
+  checkResponseForErrors(data);
+  return ResearchResponseSchema.parse(data);
+};
 // ../api/src/search/search.schemas.ts
 var LanguageSchema = _enum2([
   "AR",
@@ -13735,7 +13776,6 @@ var SearchQuerySchema = object({
     "CN",
     "PL",
     "PT",
-    "PT-BR",
     "PH",
     "RU",
     "SA",
@@ -13834,23 +13874,18 @@ var fetchSearchResults = async ({
     } else if (errorCode === 402) {
       let errorMessage = "Free tier limit exceeded. Please upgrade to continue.";
       let upgradeUrl = "https://you.com/platform";
-      try {
-        const json2 = await response.json();
-        const parseResult = ApiErrorResponseSchema.safeParse(json2);
-        if (parseResult.success) {
-          const errorBody = parseResult.data;
-          if (errorBody.message) {
-            errorMessage = errorBody.message;
-          }
-          if (errorBody.upgrade_url) {
-            upgradeUrl = errorBody.upgrade_url;
-          }
-          if (errorBody.reset_at) {
-            const resetDate = new Date(errorBody.reset_at).toLocaleDateString();
-            errorMessage += ` Limit resets on ${resetDate}.`;
-          }
-        }
-      } catch {}
+      const json2 = await response.json();
+      const errorBody = ApiErrorResponseSchema.parse(json2);
+      if (errorBody.message) {
+        errorMessage = errorBody.message;
+      }
+      if (errorBody.upgrade_url) {
+        upgradeUrl = errorBody.upgrade_url;
+      }
+      if (errorBody.reset_at) {
+        const resetDate = new Date(errorBody.reset_at).toLocaleDateString();
+        errorMessage += ` Limit resets on ${resetDate}.`;
+      }
       throw new Error(`${errorMessage} Upgrade at: ${upgradeUrl}`);
     }
     throw new Error(`Failed to perform search. Error code: ${errorCode}`);
@@ -13865,7 +13900,7 @@ import { tool } from "ai";
 // package.json
 var package_default = {
   name: "@youdotcom-oss/ai-sdk-plugin",
-  version: "2.0.6",
+  version: "2.1.0",
   description: "Vercel AI SDK plugin for You.com web search, AI agents, and content extraction via MCP",
   license: "MIT",
   engines: {
@@ -13927,7 +13962,7 @@ var package_default = {
   },
   types: "./dist/main.d.ts",
   dependencies: {
-    "@youdotcom-oss/api": "0.3.3"
+    "@youdotcom-oss/api": "0.4.0"
   },
   peerDependencies: {
     ai: "^6.0.83"
@@ -13958,6 +13993,24 @@ var youSearch = (config2 = {}) => {
     }
   });
 };
+var youResearch = (config2 = {}) => {
+  const apiKey = config2.apiKey ?? process.env.YDC_API_KEY;
+  return tool({
+    description: "Research a topic with comprehensive answers and cited sources using You.com. Supports configurable effort levels (lite, standard, deep, exhaustive). Returns a detailed answer with inline citations and a list of sources. Use this when you need thorough, well-researched answers to complex questions.",
+    inputSchema: ResearchQuerySchema,
+    execute: async (params) => {
+      if (!apiKey) {
+        throw new Error("YDC_API_KEY is required. Set it in environment variables or pass it in config.");
+      }
+      const response = await callResearch({
+        researchQuery: params,
+        YDC_API_KEY: apiKey,
+        getUserAgent
+      });
+      return response;
+    }
+  });
+};
 var youContents = (config2 = {}) => {
   const apiKey = config2.apiKey ?? process.env.YDC_API_KEY;
   return tool({
@@ -13978,5 +14031,6 @@ var youContents = (config2 = {}) => {
 };
 export {
   youSearch,
+  youResearch,
   youContents
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@youdotcom-oss/ai-sdk-plugin",
-  "version": "2.0.6",
+  "version": "2.1.0",
   "description": "Vercel AI SDK plugin for You.com web search, AI agents, and content extraction via MCP",
   "license": "MIT",
   "engines": {
@@ -62,7 +62,7 @@
   },
   "types": "./dist/main.d.ts",
   "dependencies": {
-    "@youdotcom-oss/api": "0.3.3"
+    "@youdotcom-oss/api": "0.4.0"
   },
   "peerDependencies": {
     "ai": "^6.0.83"