@ai-sdk/perplexity 4.0.50 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @ai-sdk/perplexity
 
+## 5.0.0
+
+### Major Changes
+
+- 38fe0e5: BREAKING: Migrate language generation from the Sonar Chat Completions API to the Agent API. Replace Sonar model IDs and provider options with Agent API presets, models, and tools. The new API changes request and response metadata, raw stream events, usage and cost data, and does not support Sonar PDF input or image and video results.
+
+### Patch Changes
+
+- 38fe0e5: Recover missing text from Agent API terminal events and output items, including incomplete responses, without repeating text already received as deltas. Track each message content part separately.
+- 38fe0e5: Accept native Agent API tool traces such as finance results without validating them as web search results. Preserve these traces in raw responses and stream chunks.
+- 38fe0e5: Preserve URL citation annotations as sources in Agent API streams, including completed and incomplete terminal responses.
+- 38fe0e5: Emit each Agent API source URL once while preserving search result IDs for citation correlation when a URL is fetched or annotated before it appears in search results.
+
+## 4.0.52
+
+### Patch Changes
+
+- Updated dependencies [af9597b]
+- Updated dependencies [bc49f78]
+  - @ai-sdk/provider-utils@5.0.49
+
+## 4.0.51
+
+### Patch Changes
+
+- Updated dependencies [be877ff]
+  - @ai-sdk/provider-utils@5.0.48
+
 ## 4.0.50
 
 ### Patch Changes

package/README.md

@@ -1,18 +1,15 @@
 # AI SDK - Perplexity Provider
 
 The **[Perplexity provider](https://ai-sdk.dev/providers/ai-sdk-providers/perplexity)** for the [AI SDK](https://ai-sdk.dev/docs)
-contains language model support for Perplexity's Sonar API - a powerful answer engine with real-time web search capabilities.
+contains language model support for Perplexity's Agent API, including web search, citations, function tools, and structured output.
 
 ## Features
 
 - Real-time web search grounding for accurate, up-to-date responses
-- Support for advanced queries and follow-up questions
-- Multiple tiers available:
-  - **Sonar Pro**: Enhanced capabilities for complex tasks with 2x more citations
-  - **Sonar**: Lightweight offering optimized for speed and cost
-- Industry-leading answer quality
-- Data privacy - no training on customer data
-- Self-serve API access with scalable pricing
+- Agent API presets from `fast` through `xhigh`
+- Direct access to supported third-party models through Perplexity
+- Native tools for web search, URL fetching, code execution, finance, MCP, and connectors
+- AI SDK function tools, structured output, reasoning streams, and multi-turn tool calls
 
 > **Deploying to Vercel?** With Vercel's AI Gateway you can access Perplexity (and hundreds of models from other providers) — no additional packages, API keys, or extra cost. [Get started with AI Gateway](https://vercel.com/ai-gateway).
 
@@ -47,11 +44,20 @@ import { perplexity } from '@ai-sdk/perplexity';
 import { generateText } from 'ai';
 
 const { text } = await generateText({
-  model: perplexity('sonar-pro'),
+  model: perplexity('low'),
   prompt: 'What are the latest developments in quantum computing?',
 });
 ```
 
+Version 5 is a breaking migration from Sonar Chat Completions to the Agent API.
+Legacy Sonar model IDs and provider options are not mapped. Review the
+[migration notes](https://ai-sdk.dev/providers/ai-sdk-providers/perplexity#migrating-from-v4-sonar-to-v5-agent-api)
+before upgrading an existing application.
+
+Perplexity supports Sonar Chat Completions only until September 27, 2026.
+Remaining on version 4 will not preserve language generation after that date.
+Migrate unsupported Sonar features using the alternatives in the migration notes.
+
 ## Documentation
 
 Please check out the **[Perplexity provider documentation](https://ai-sdk.dev/providers/ai-sdk-providers/perplexity)** for more information.

package/dist/index.d.ts

@@ -12,15 +12,16 @@ declare const perplexityEmbeddingModelOptions: z.ZodObject<{
 }, z.core.$strip>;
 type PerplexityEmbeddingModelOptions = z.infer<typeof perplexityEmbeddingModelOptions>;
 
-type PerplexityLanguageModelId = 'sonar-deep-research' | 'sonar-reasoning-pro' | 'sonar-reasoning' | 'sonar-pro' | 'sonar' | (string & {});
+type PerplexityAgentPreset = 'fast' | 'low' | 'medium' | 'high' | 'xhigh';
+type PerplexityLanguageModelId = PerplexityAgentPreset | 'perplexity/sonar' | (string & {});
 
 interface PerplexityProvider extends ProviderV4 {
     /**
-     * Creates an Perplexity chat model for text generation.
+     * Creates a Perplexity Agent API model or preset for text generation.
      */
     (modelId: PerplexityLanguageModelId): LanguageModelV4;
     /**
-     * Creates an Perplexity language model for text generation.
+     * Creates a Perplexity Agent API model or preset for text generation.
      */
     languageModel(modelId: PerplexityLanguageModelId): LanguageModelV4;
     /**
@@ -38,7 +39,7 @@ interface PerplexityProvider extends ProviderV4 {
 }
 interface PerplexityProviderSettings {
     /**
-     * Base URL for the perplexity API calls.
+     * Base URL for Perplexity API calls.
      */
     baseURL?: string;
     /**
@@ -59,129 +60,36 @@ declare function createPerplexity(options?: PerplexityProviderSettings): Perplex
 declare const perplexity: PerplexityProvider;
 
 declare const perplexityLanguageModelOptions: z.ZodObject<{
-    /**
-     * Filters search results to those published within the specified time window.
-     * Cannot be combined with other date filters.
-     */
-    search_recency_filter: z.ZodOptional<z.ZodEnum<{
-        hour: "hour";
-        day: "day";
-        week: "week";
-        month: "month";
-        year: "year";
-    }>>;
-    /**
-     * Restrict web search results to specific domains or URLs.
-     * Prefix a domain with "-" to exclude it.
-     */
-    search_domain_filter: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    /**
-     * Filter search results by language using ISO 639-1 codes.
-     */
-    search_language_filter: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    /**
-     * Return search results published after this date.
-     */
-    search_after_date_filter: z.ZodOptional<z.ZodString>;
-    /**
-     * Return search results published before this date.
-     */
-    search_before_date_filter: z.ZodOptional<z.ZodString>;
-    /**
-     * Return search results last updated after this date.
-     */
-    last_updated_after_filter: z.ZodOptional<z.ZodString>;
-    /**
-     * Return search results last updated before this date.
-     */
-    last_updated_before_filter: z.ZodOptional<z.ZodString>;
-    /**
-     * Source of search results.
-     */
-    search_mode: z.ZodOptional<z.ZodEnum<{
-        web: "web";
-        academic: "academic";
-        sec: "sec";
-    }>>;
-    /**
-     * If true, the model decides whether web search is needed.
-     */
-    enable_search_classifier: z.ZodOptional<z.ZodBoolean>;
-    /**
-     * If true, disables web search.
-     */
-    disable_search: z.ZodOptional<z.ZodBoolean>;
-    /**
-     * If true, a list of related questions is included in the response.
-     */
-    return_related_questions: z.ZodOptional<z.ZodBoolean>;
-    /**
-     * If true, image search results are included in the response.
-     */
-    return_images: z.ZodOptional<z.ZodBoolean>;
-    /**
-     * Restrict image results to specific domains.
-     * Prefix a domain with "-" to exclude it.
-     */
-    image_domain_filter: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    /**
-     * Restrict image results to specific file formats.
-     */
-    image_format_filter: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    /**
-     * Additional media response configuration.
-     */
-    media_response: z.ZodOptional<z.ZodObject<{
-        overrides: z.ZodOptional<z.ZodObject<{
-            /**
-             * If true, video results are included in the response.
-             */
-            return_videos: z.ZodOptional<z.ZodBoolean>;
+    /** Top-level Agent API instructions. */
+    instructions: z.ZodOptional<z.ZodString>;
+    /**
+     * Native Agent API tools. AI SDK function tools can also be supplied through
+     * the top-level `tools` option on `generateText` and `streamText`.
+     */
+    tools: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        type: z.ZodLiteral<"web_search">;
+        filters: z.ZodOptional<z.ZodObject<{
+            search_domain_filter: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            search_recency_filter: z.ZodOptional<z.ZodEnum<{
+                hour: "hour";
+                day: "day";
+                week: "week";
+                month: "month";
+                year: "year";
+            }>>;
+            search_after_date_filter: z.ZodOptional<z.ZodString>;
+            search_before_date_filter: z.ZodOptional<z.ZodString>;
+            last_updated_after_filter: z.ZodOptional<z.ZodString>;
+            last_updated_before_filter: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>>;
-    }, z.core.$loose>>;
-    /**
-     * Controls the format of streaming events.
-     */
-    stream_mode: z.ZodOptional<z.ZodEnum<{
-        full: "full";
-        concise: "concise";
-    }>>;
-    /**
-     * Controls how much effort the model spends on reasoning.
-     */
-    reasoning_effort: z.ZodOptional<z.ZodEnum<{
-        minimal: "minimal";
-        low: "low";
-        medium: "medium";
-        high: "high";
-    }>>;
-    /**
-     * Preferred response language as an ISO 639-1 language code.
-     */
-    language_preference: z.ZodOptional<z.ZodString>;
-    /**
-     * Additional web search configuration.
-     */
-    web_search_options: z.ZodOptional<z.ZodObject<{
-        /**
-         * Controls the size of search context injected into the model.
-         */
+        max_results: z.ZodOptional<z.ZodNumber>;
+        max_tokens: z.ZodOptional<z.ZodNumber>;
+        max_tokens_per_page: z.ZodOptional<z.ZodNumber>;
         search_context_size: z.ZodOptional<z.ZodEnum<{
             low: "low";
             medium: "medium";
             high: "high";
         }>>;
-        /**
-         * Controls whether to use fast search, pro search, or automatic routing.
-         */
-        search_type: z.ZodOptional<z.ZodEnum<{
-            fast: "fast";
-            pro: "pro";
-            auto: "auto";
-        }>>;
-        /**
-         * User location for search result personalization.
-         */
         user_location: z.ZodOptional<z.ZodObject<{
             latitude: z.ZodOptional<z.ZodNumber>;
             longitude: z.ZodOptional<z.ZodNumber>;
@@ -189,14 +97,74 @@ declare const perplexityLanguageModelOptions: z.ZodObject<{
             city: z.ZodOptional<z.ZodString>;
             region: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>>;
-        /**
-         * If true, applies enhanced relevance filtering to image results.
-         */
-        image_results_enhanced_relevance: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"fetch_url">;
+        max_urls: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"people_search">;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"finance_search">;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"sandbox">;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"mcp">;
+        server_label: z.ZodString;
+        server_url: z.ZodString;
+        allowed_tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        authorization: z.ZodOptional<z.ZodString>;
+        defer_loading: z.ZodOptional<z.ZodBoolean>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"connector">;
+        id: z.ZodString;
+        server_label: z.ZodString;
+        server_description: z.ZodOptional<z.ZodString>;
+        allowed_tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$loose>]>>>;
+    /** A fallback model list for Agent API routing. */
+    models: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    /** Maximum number of agentic steps. */
+    max_steps: z.ZodOptional<z.ZodNumber>;
+    /** Maximum number of native tool calls. */
+    max_tool_calls: z.ZodOptional<z.ZodNumber>;
+    /** Continue a conversation from an earlier Agent API response. */
+    previous_response_id: z.ZodOptional<z.ZodString>;
+    /**
+     * Whether the response can be retrieved later. Setting this to false does
+     * not disable persistence or prevent previous_response_id continuations.
+     */
+    store: z.ZodOptional<z.ZodBoolean>;
+    /** Preferred response language as an ISO 639-1 language code. */
+    language_preference: z.ZodOptional<z.ZodString>;
+    /** Agent API reasoning configuration. */
+    reasoning: z.ZodOptional<z.ZodObject<{
+        effort: z.ZodOptional<z.ZodEnum<{
+            low: "low";
+            medium: "medium";
+            high: "high";
+            minimal: "minimal";
+            xhigh: "xhigh";
+        }>>;
     }, z.core.$loose>>;
+    /** Agent API skill configuration. */
+    skills: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        type: z.ZodLiteral<"builtin">;
+        name: z.ZodEnum<{
+            office: "office";
+            "office/docx": "office/docx";
+            "office/pdf": "office/pdf";
+            "office/pptx": "office/pptx";
+            "office/xlsx": "office/xlsx";
+        }>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"inline">;
+        name: z.ZodString;
+        description: z.ZodString;
+        instructions: z.ZodString;
+    }, z.core.$loose>]>>>;
 }, z.core.$loose>;
 type PerplexityLanguageModelOptions = z.infer<typeof perplexityLanguageModelOptions>;
 
 declare const VERSION: string;
 
-export { type PerplexityEmbeddingModelId, type PerplexityEmbeddingModelOptions, type PerplexityLanguageModelOptions, type PerplexityProvider, type PerplexityProviderSettings, VERSION, createPerplexity, perplexity };
+export { type PerplexityAgentPreset, type PerplexityEmbeddingModelId, type PerplexityEmbeddingModelOptions, type PerplexityLanguageModelId, type PerplexityLanguageModelOptions, type PerplexityProvider, type PerplexityProviderSettings, VERSION, createPerplexity, perplexity };