@ai-sdk/perplexity 3.0.63 → 3.1.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @ai-sdk/perplexity
 
+## 3.1.1
+
+### Patch Changes
+
+- Updated dependencies [29dc427]
+  - @ai-sdk/provider-utils@4.0.56
+
+## 3.1.0
+
+### Minor Changes
+
+- 289e3cf: BREAKING: Migrate language generation from the Sonar Chat Completions API (supported by Perplexity only until September 27, 2026) 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. Reasoning effort is configured through `providerOptions.perplexity.reasoning`. Embeddings are unchanged. Agent API stream events with `null` fields are accepted.
+
+### Patch Changes
+
+- Updated dependencies [3983fea]
+  - @ai-sdk/provider@3.0.18
+  - @ai-sdk/provider-utils@4.0.55
+
 ## 3.0.63
 
 ### 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,23 @@ 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 3.1.0 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 (the notes refer to the Sonar-based
+releases as v4 and the Agent API releases as v5; for AI SDK 6 these are
+3.0.63 and earlier, and 3.1.0 and later).
+
+Perplexity supports Sonar Chat Completions only until September 27, 2026.
+Remaining on version 3.0.63 or earlier 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.mts

@@ -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 ProviderV3 {
     /**
-     * Creates an Perplexity chat model for text generation.
+     * Creates a Perplexity Agent API model or preset for text generation.
      */
     (modelId: PerplexityLanguageModelId): LanguageModelV3;
     /**
-     * Creates an Perplexity language model for text generation.
+     * Creates a Perplexity Agent API model or preset for text generation.
      */
     languageModel(modelId: PerplexityLanguageModelId): LanguageModelV3;
     /**
@@ -38,7 +39,7 @@ interface PerplexityProvider extends ProviderV3 {
 }
 interface PerplexityProviderSettings {
     /**
-     * Base URL for the perplexity API calls.
+     * Base URL for Perplexity API calls.
      */
     baseURL?: string;
     /**
@@ -58,6 +59,112 @@ interface PerplexityProviderSettings {
 declare function createPerplexity(options?: PerplexityProviderSettings): PerplexityProvider;
 declare const perplexity: PerplexityProvider;
 
+declare const perplexityLanguageModelOptions: z.ZodObject<{
+    /** 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>>;
+        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";
+        }>>;
+        user_location: z.ZodOptional<z.ZodObject<{
+            latitude: z.ZodOptional<z.ZodNumber>;
+            longitude: z.ZodOptional<z.ZodNumber>;
+            country: z.ZodOptional<z.ZodString>;
+            city: z.ZodOptional<z.ZodString>;
+            region: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
+    }, 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 PerplexityProvider, type PerplexityProviderSettings, VERSION, createPerplexity, perplexity };
+export { type PerplexityAgentPreset, type PerplexityEmbeddingModelId, type PerplexityEmbeddingModelOptions, type PerplexityLanguageModelId, type PerplexityLanguageModelOptions, type PerplexityProvider, type PerplexityProviderSettings, VERSION, createPerplexity, perplexity };

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 ProviderV3 {
     /**
-     * Creates an Perplexity chat model for text generation.
+     * Creates a Perplexity Agent API model or preset for text generation.
      */
     (modelId: PerplexityLanguageModelId): LanguageModelV3;
     /**
-     * Creates an Perplexity language model for text generation.
+     * Creates a Perplexity Agent API model or preset for text generation.
      */
     languageModel(modelId: PerplexityLanguageModelId): LanguageModelV3;
     /**
@@ -38,7 +39,7 @@ interface PerplexityProvider extends ProviderV3 {
 }
 interface PerplexityProviderSettings {
     /**
-     * Base URL for the perplexity API calls.
+     * Base URL for Perplexity API calls.
      */
     baseURL?: string;
     /**
@@ -58,6 +59,112 @@ interface PerplexityProviderSettings {
 declare function createPerplexity(options?: PerplexityProviderSettings): PerplexityProvider;
 declare const perplexity: PerplexityProvider;
 
+declare const perplexityLanguageModelOptions: z.ZodObject<{
+    /** 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>>;
+        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";
+        }>>;
+        user_location: z.ZodOptional<z.ZodObject<{
+            latitude: z.ZodOptional<z.ZodNumber>;
+            longitude: z.ZodOptional<z.ZodNumber>;
+            country: z.ZodOptional<z.ZodString>;
+            city: z.ZodOptional<z.ZodString>;
+            region: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
+    }, 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 PerplexityProvider, type PerplexityProviderSettings, VERSION, createPerplexity, perplexity };
+export { type PerplexityAgentPreset, type PerplexityEmbeddingModelId, type PerplexityEmbeddingModelOptions, type PerplexityLanguageModelId, type PerplexityLanguageModelOptions, type PerplexityProvider, type PerplexityProviderSettings, VERSION, createPerplexity, perplexity };