@ai-sdk/perplexity 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @ai-sdk/perplexity
+
+## 0.0.1
+
+### Patch Changes
+
+- 5a5b668: feat (provider/perplexity): add Perplexity provider
+- Updated dependencies [361fd08]
+  - @ai-sdk/openai-compatible@0.1.3

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,47 @@
+# AI SDK - Perplexity Provider
+
+The **[Perplexity provider](https://sdk.vercel.ai/providers/ai-sdk-providers/perplexity)** for the [AI SDK](https://sdk.vercel.ai/docs)
+contains language model support for Perplexity's Sonar API - a powerful answer engine with real-time web search capabilities.
+
+## 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
+
+## Setup
+
+The Perplexity provider is available in the `@ai-sdk/perplexity` module. You can install it with:
+
+```bash
+npm i @ai-sdk/perplexity
+```
+
+## Provider Instance
+
+You can import the default provider instance `perplexity` from `@ai-sdk/perplexity`:
+
+```ts
+import { perplexity } from '@ai-sdk/perplexity';
+```
+
+## Example
+
+```ts
+import { perplexity } from '@ai-sdk/perplexity';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: perplexity('sonar-pro'),
+  prompt: 'What are the latest developments in quantum computing?',
+});
+```
+
+## Documentation
+
+Please check out the **[Perplexity provider documentation](https://sdk.vercel.ai/providers/ai-sdk-providers/perplexity)** for more information.

package/dist/index.d.mts

@@ -0,0 +1,57 @@
+import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+import { OpenAICompatibleChatSettings } from '@ai-sdk/openai-compatible';
+import { z } from 'zod';
+
+type PerplexityChatModelId = 'sonar-pro' | 'sonar' | (string & {});
+interface PerplexityChatSettings extends OpenAICompatibleChatSettings {
+}
+
+declare const perplexityErrorSchema: z.ZodObject<{
+    code: z.ZodString;
+    error: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+    error: string;
+}, {
+    code: string;
+    error: string;
+}>;
+type PerplexityErrorData = z.infer<typeof perplexityErrorSchema>;
+interface PerplexityProvider extends ProviderV1 {
+    /**
+  Creates an Perplexity chat model for text generation.
+     */
+    (modelId: PerplexityChatModelId, settings?: PerplexityChatSettings): LanguageModelV1;
+    /**
+  Creates an Perplexity language model for text generation.
+     */
+    languageModel(modelId: PerplexityChatModelId, settings?: PerplexityChatSettings): LanguageModelV1;
+    /**
+  Creates an Perplexity chat model for text generation.
+     */
+    chat: (modelId: PerplexityChatModelId, settings?: PerplexityChatSettings) => LanguageModelV1;
+}
+interface PerplexityProviderSettings {
+    /**
+  Base URL for the perplexity API calls.
+       */
+    baseURL?: string;
+    /**
+  API key for authenticating requests.
+     */
+    apiKey?: string;
+    /**
+  Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
+    /**
+  Custom fetch implementation. You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+    */
+    fetch?: FetchFunction;
+}
+declare function createPerplexity(options?: PerplexityProviderSettings): PerplexityProvider;
+declare const perplexity: PerplexityProvider;
+
+export { type PerplexityErrorData, type PerplexityProvider, type PerplexityProviderSettings, createPerplexity, perplexity };

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+import { OpenAICompatibleChatSettings } from '@ai-sdk/openai-compatible';
+import { z } from 'zod';
+
+type PerplexityChatModelId = 'sonar-pro' | 'sonar' | (string & {});
+interface PerplexityChatSettings extends OpenAICompatibleChatSettings {
+}
+
+declare const perplexityErrorSchema: z.ZodObject<{
+    code: z.ZodString;
+    error: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+    error: string;
+}, {
+    code: string;
+    error: string;
+}>;
+type PerplexityErrorData = z.infer<typeof perplexityErrorSchema>;
+interface PerplexityProvider extends ProviderV1 {
+    /**
+  Creates an Perplexity chat model for text generation.
+     */
+    (modelId: PerplexityChatModelId, settings?: PerplexityChatSettings): LanguageModelV1;
+    /**
+  Creates an Perplexity language model for text generation.
+     */
+    languageModel(modelId: PerplexityChatModelId, settings?: PerplexityChatSettings): LanguageModelV1;
+    /**
+  Creates an Perplexity chat model for text generation.
+     */
+    chat: (modelId: PerplexityChatModelId, settings?: PerplexityChatSettings) => LanguageModelV1;
+}
+interface PerplexityProviderSettings {
+    /**
+  Base URL for the perplexity API calls.
+       */
+    baseURL?: string;
+    /**
+  API key for authenticating requests.
+     */
+    apiKey?: string;
+    /**
+  Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
+    /**
+  Custom fetch implementation. You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+    */
+    fetch?: FetchFunction;
+}
+declare function createPerplexity(options?: PerplexityProviderSettings): PerplexityProvider;
+declare const perplexity: PerplexityProvider;
+
+export { type PerplexityErrorData, type PerplexityProvider, type PerplexityProviderSettings, createPerplexity, perplexity };

package/dist/index.js

@@ -0,0 +1,156 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  createPerplexity: () => createPerplexity,
+  perplexity: () => perplexity
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/perplexity-provider.ts
+var import_provider = require("@ai-sdk/provider");
+var import_openai_compatible = require("@ai-sdk/openai-compatible");
+var import_provider_utils2 = require("@ai-sdk/provider-utils");
+var import_zod2 = require("zod");
+
+// src/perplexity-metadata-extractor.ts
+var import_provider_utils = require("@ai-sdk/provider-utils");
+var import_zod = require("zod");
+var buildPerplexityMetadata = (citations, usage) => {
+  var _a, _b;
+  return citations || usage ? {
+    perplexity: {
+      ...citations && { citations },
+      ...usage && {
+        usage: {
+          citationTokens: (_a = usage.citation_tokens) != null ? _a : NaN,
+          numSearchQueries: (_b = usage.num_search_queries) != null ? _b : NaN
+        }
+      }
+    }
+  } : void 0;
+};
+var perplexityMetadataExtractor = {
+  extractMetadata: ({ parsedBody }) => {
+    var _a, _b;
+    const parsed = (0, import_provider_utils.safeValidateTypes)({
+      value: parsedBody,
+      schema: perplexityResponseSchema
+    });
+    return !parsed.success ? void 0 : buildPerplexityMetadata(
+      (_a = parsed.value.citations) != null ? _a : void 0,
+      (_b = parsed.value.usage) != null ? _b : void 0
+    );
+  },
+  createStreamExtractor: () => {
+    let citations;
+    let usage;
+    return {
+      processChunk: (chunk) => {
+        const parsed = (0, import_provider_utils.safeValidateTypes)({
+          value: chunk,
+          schema: perplexityStreamChunkSchema
+        });
+        if (parsed.success) {
+          if (parsed.value.citations) {
+            citations = parsed.value.citations;
+          }
+          if (parsed.value.usage) {
+            usage = parsed.value.usage;
+          }
+        }
+      },
+      buildMetadata: () => buildPerplexityMetadata(citations, usage)
+    };
+  }
+};
+var perplexityCitationSchema = import_zod.z.array(import_zod.z.string());
+var perplexityUsageSchema = import_zod.z.object({
+  citation_tokens: import_zod.z.number().nullish(),
+  num_search_queries: import_zod.z.number().nullish()
+});
+var perplexityResponseSchema = import_zod.z.object({
+  citations: perplexityCitationSchema.nullish(),
+  usage: perplexityUsageSchema.nullish()
+});
+var perplexityStreamChunkSchema = import_zod.z.object({
+  choices: import_zod.z.array(
+    import_zod.z.object({
+      finish_reason: import_zod.z.string().nullish(),
+      delta: import_zod.z.object({
+        role: import_zod.z.string(),
+        content: import_zod.z.string()
+      }).nullish()
+    })
+  ).nullish(),
+  citations: perplexityCitationSchema.nullish(),
+  usage: perplexityUsageSchema.nullish()
+});
+
+// src/perplexity-provider.ts
+var perplexityErrorSchema = import_zod2.z.object({
+  code: import_zod2.z.string(),
+  error: import_zod2.z.string()
+});
+var perplexityErrorStructure = {
+  errorSchema: perplexityErrorSchema,
+  errorToMessage: (data) => data.error
+};
+function createPerplexity(options = {}) {
+  var _a;
+  const baseURL = (0, import_provider_utils2.withoutTrailingSlash)(
+    (_a = options.baseURL) != null ? _a : "https://api.perplexity.ai"
+  );
+  const getHeaders = () => ({
+    Authorization: `Bearer ${(0, import_provider_utils2.loadApiKey)({
+      apiKey: options.apiKey,
+      environmentVariableName: "PERPLEXITY_API_KEY",
+      description: "Perplexity"
+    })}`,
+    ...options.headers
+  });
+  const createLanguageModel = (modelId, settings = {}) => {
+    return new import_openai_compatible.OpenAICompatibleChatLanguageModel(modelId, settings, {
+      provider: "perplexity.chat",
+      url: ({ path }) => `${baseURL}${path}`,
+      headers: getHeaders,
+      fetch: options.fetch,
+      defaultObjectGenerationMode: "json",
+      errorStructure: perplexityErrorStructure,
+      metadataExtractor: perplexityMetadataExtractor,
+      supportsStructuredOutputs: true
+    });
+  };
+  const provider = (modelId, settings) => createLanguageModel(modelId, settings);
+  provider.languageModel = createLanguageModel;
+  provider.chat = createLanguageModel;
+  provider.textEmbeddingModel = (modelId) => {
+    throw new import_provider.NoSuchModelError({ modelId, modelType: "textEmbeddingModel" });
+  };
+  return provider;
+}
+var perplexity = createPerplexity();
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createPerplexity,
+  perplexity
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/perplexity-provider.ts","../src/perplexity-metadata-extractor.ts"],"sourcesContent":["export { createPerplexity, perplexity } from './perplexity-provider';\nexport type {\n  PerplexityErrorData,\n  PerplexityProvider,\n  PerplexityProviderSettings,\n} from './perplexity-provider';\n","import {\n  LanguageModelV1,\n  NoSuchModelError,\n  ProviderV1,\n} from '@ai-sdk/provider';\nimport { OpenAICompatibleChatLanguageModel } from '@ai-sdk/openai-compatible';\nimport {\n  FetchFunction,\n  loadApiKey,\n  withoutTrailingSlash,\n} from '@ai-sdk/provider-utils';\nimport {\n  PerplexityChatModelId,\n  PerplexityChatSettings,\n} from './perplexity-chat-settings';\nimport { z } from 'zod';\nimport { ProviderErrorStructure } from '@ai-sdk/openai-compatible';\nimport { perplexityMetadataExtractor } from './perplexity-metadata-extractor';\n\n// Add error schema and structure\nconst perplexityErrorSchema = z.object({\n  code: z.string(),\n  error: z.string(),\n});\n\nexport type PerplexityErrorData = z.infer<typeof perplexityErrorSchema>;\n\nconst perplexityErrorStructure: ProviderErrorStructure<PerplexityErrorData> = {\n  errorSchema: perplexityErrorSchema,\n  errorToMessage: data => data.error,\n};\n\nexport interface PerplexityProvider extends ProviderV1 {\n  /**\nCreates an Perplexity chat model for text generation.\n   */\n  (\n    modelId: PerplexityChatModelId,\n    settings?: PerplexityChatSettings,\n  ): LanguageModelV1;\n\n  /**\nCreates an Perplexity language model for text generation.\n   */\n  languageModel(\n    modelId: PerplexityChatModelId,\n    settings?: PerplexityChatSettings,\n  ): LanguageModelV1;\n\n  /**\nCreates an Perplexity chat model for text generation.\n   */\n  chat: (\n    modelId: PerplexityChatModelId,\n    settings?: PerplexityChatSettings,\n  ) => LanguageModelV1;\n}\n\nexport interface PerplexityProviderSettings {\n  /**\nBase URL for the perplexity API calls.\n     */\n  baseURL?: string;\n\n  /**\nAPI key for authenticating requests.\n   */\n  apiKey?: string;\n\n  /**\nCustom headers to include in the requests.\n   */\n  headers?: Record<string, string>;\n\n  /**\nCustom fetch implementation. You can use it as a middleware to intercept requests,\nor to provide a custom fetch implementation for e.g. testing.\n  */\n  fetch?: FetchFunction;\n}\n\nexport function createPerplexity(\n  options: PerplexityProviderSettings = {},\n): PerplexityProvider {\n  const baseURL = withoutTrailingSlash(\n    options.baseURL ?? 'https://api.perplexity.ai',\n  );\n  const getHeaders = () => ({\n    Authorization: `Bearer ${loadApiKey({\n      apiKey: options.apiKey,\n      environmentVariableName: 'PERPLEXITY_API_KEY',\n      description: 'Perplexity',\n    })}`,\n    ...options.headers,\n  });\n\n  const createLanguageModel = (\n    modelId: PerplexityChatModelId,\n    settings: PerplexityChatSettings = {},\n  ) => {\n    return new OpenAICompatibleChatLanguageModel(modelId, settings, {\n      provider: 'perplexity.chat',\n      url: ({ path }) => `${baseURL}${path}`,\n      headers: getHeaders,\n      fetch: options.fetch,\n      defaultObjectGenerationMode: 'json',\n      errorStructure: perplexityErrorStructure,\n      metadataExtractor: perplexityMetadataExtractor,\n      supportsStructuredOutputs: true,\n    });\n  };\n\n  const provider = (\n    modelId: PerplexityChatModelId,\n    settings?: PerplexityChatSettings,\n  ) => createLanguageModel(modelId, settings);\n\n  provider.languageModel = createLanguageModel;\n  provider.chat = createLanguageModel;\n  provider.textEmbeddingModel = (modelId: string) => {\n    throw new NoSuchModelError({ modelId, modelType: 'textEmbeddingModel' });\n  };\n\n  return provider as PerplexityProvider;\n}\n\nexport const perplexity = createPerplexity();\n","import { MetadataExtractor } from '@ai-sdk/openai-compatible';\nimport { safeValidateTypes } from '@ai-sdk/provider-utils';\nimport { z } from 'zod';\n\nconst buildPerplexityMetadata = (\n  citations: string[] | undefined,\n  usage: z.infer<typeof perplexityUsageSchema> | undefined,\n) => {\n  return citations || usage\n    ? {\n        perplexity: {\n          ...(citations && { citations }),\n          ...(usage && {\n            usage: {\n              citationTokens: usage.citation_tokens ?? NaN,\n              numSearchQueries: usage.num_search_queries ?? NaN,\n            },\n          }),\n        },\n      }\n    : undefined;\n};\n\nexport const perplexityMetadataExtractor: MetadataExtractor = {\n  extractMetadata: ({ parsedBody }: { parsedBody: unknown }) => {\n    const parsed = safeValidateTypes({\n      value: parsedBody,\n      schema: perplexityResponseSchema,\n    });\n\n    return !parsed.success\n      ? undefined\n      : buildPerplexityMetadata(\n          parsed.value.citations ?? undefined,\n          parsed.value.usage ?? undefined,\n        );\n  },\n\n  createStreamExtractor: () => {\n    let citations: string[] | undefined;\n    let usage: z.infer<typeof perplexityUsageSchema> | undefined;\n\n    return {\n      processChunk: (chunk: unknown) => {\n        const parsed = safeValidateTypes({\n          value: chunk,\n          schema: perplexityStreamChunkSchema,\n        });\n\n        if (parsed.success) {\n          // Update citations and usage with latest data from each chunk\n          if (parsed.value.citations) {\n            citations = parsed.value.citations;\n          }\n          if (parsed.value.usage) {\n            usage = parsed.value.usage;\n          }\n        }\n      },\n      buildMetadata: () => buildPerplexityMetadata(citations, usage),\n    };\n  },\n};\n\n// Schema for citations\nconst perplexityCitationSchema = z.array(z.string());\n\nconst perplexityUsageSchema = z.object({\n  citation_tokens: z.number().nullish(),\n  num_search_queries: z.number().nullish(),\n});\n\n// Update response schema to include usage\nconst perplexityResponseSchema = z.object({\n  citations: perplexityCitationSchema.nullish(),\n  usage: perplexityUsageSchema.nullish(),\n});\n\n// Update stream chunk schema to match example format\nconst perplexityStreamChunkSchema = z.object({\n  choices: z\n    .array(\n      z.object({\n        finish_reason: z.string().nullish(),\n        delta: z\n          .object({\n            role: z.string(),\n            content: z.string(),\n          })\n          .nullish(),\n      }),\n    )\n    .nullish(),\n  citations: perplexityCitationSchema.nullish(),\n  usage: perplexityUsageSchema.nullish(),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,sBAIO;AACP,+BAAkD;AAClD,IAAAA,yBAIO;AAKP,IAAAC,cAAkB;;;ACdlB,4BAAkC;AAClC,iBAAkB;AAElB,IAAM,0BAA0B,CAC9B,WACA,UACG;AAPL;AAQE,SAAO,aAAa,QAChB;AAAA,IACE,YAAY;AAAA,MACV,GAAI,aAAa,EAAE,UAAU;AAAA,MAC7B,GAAI,SAAS;AAAA,QACX,OAAO;AAAA,UACL,iBAAgB,WAAM,oBAAN,YAAyB;AAAA,UACzC,mBAAkB,WAAM,uBAAN,YAA4B;AAAA,QAChD;AAAA,MACF;AAAA,IACF;AAAA,EACF,IACA;AACN;AAEO,IAAM,8BAAiD;AAAA,EAC5D,iBAAiB,CAAC,EAAE,WAAW,MAA+B;AAxBhE;AAyBI,UAAM,aAAS,yCAAkB;AAAA,MAC/B,OAAO;AAAA,MACP,QAAQ;AAAA,IACV,CAAC;AAED,WAAO,CAAC,OAAO,UACX,SACA;AAAA,OACE,YAAO,MAAM,cAAb,YAA0B;AAAA,OAC1B,YAAO,MAAM,UAAb,YAAsB;AAAA,IACxB;AAAA,EACN;AAAA,EAEA,uBAAuB,MAAM;AAC3B,QAAI;AACJ,QAAI;AAEJ,WAAO;AAAA,MACL,cAAc,CAAC,UAAmB;AAChC,cAAM,aAAS,yCAAkB;AAAA,UAC/B,OAAO;AAAA,UACP,QAAQ;AAAA,QACV,CAAC;AAED,YAAI,OAAO,SAAS;AAElB,cAAI,OAAO,MAAM,WAAW;AAC1B,wBAAY,OAAO,MAAM;AAAA,UAC3B;AACA,cAAI,OAAO,MAAM,OAAO;AACtB,oBAAQ,OAAO,MAAM;AAAA,UACvB;AAAA,QACF;AAAA,MACF;AAAA,MACA,eAAe,MAAM,wBAAwB,WAAW,KAAK;AAAA,IAC/D;AAAA,EACF;AACF;AAGA,IAAM,2BAA2B,aAAE,MAAM,aAAE,OAAO,CAAC;AAEnD,IAAM,wBAAwB,aAAE,OAAO;AAAA,EACrC,iBAAiB,aAAE,OAAO,EAAE,QAAQ;AAAA,EACpC,oBAAoB,aAAE,OAAO,EAAE,QAAQ;AACzC,CAAC;AAGD,IAAM,2BAA2B,aAAE,OAAO;AAAA,EACxC,WAAW,yBAAyB,QAAQ;AAAA,EAC5C,OAAO,sBAAsB,QAAQ;AACvC,CAAC;AAGD,IAAM,8BAA8B,aAAE,OAAO;AAAA,EAC3C,SAAS,aACN;AAAA,IACC,aAAE,OAAO;AAAA,MACP,eAAe,aAAE,OAAO,EAAE,QAAQ;AAAA,MAClC,OAAO,aACJ,OAAO;AAAA,QACN,MAAM,aAAE,OAAO;AAAA,QACf,SAAS,aAAE,OAAO;AAAA,MACpB,CAAC,EACA,QAAQ;AAAA,IACb,CAAC;AAAA,EACH,EACC,QAAQ;AAAA,EACX,WAAW,yBAAyB,QAAQ;AAAA,EAC5C,OAAO,sBAAsB,QAAQ;AACvC,CAAC;;;AD3ED,IAAM,wBAAwB,cAAE,OAAO;AAAA,EACrC,MAAM,cAAE,OAAO;AAAA,EACf,OAAO,cAAE,OAAO;AAClB,CAAC;AAID,IAAM,2BAAwE;AAAA,EAC5E,aAAa;AAAA,EACb,gBAAgB,UAAQ,KAAK;AAC/B;AAmDO,SAAS,iBACd,UAAsC,CAAC,GACnB;AAnFtB;AAoFE,QAAM,cAAU;AAAA,KACd,aAAQ,YAAR,YAAmB;AAAA,EACrB;AACA,QAAM,aAAa,OAAO;AAAA,IACxB,eAAe,cAAU,mCAAW;AAAA,MAClC,QAAQ,QAAQ;AAAA,MAChB,yBAAyB;AAAA,MACzB,aAAa;AAAA,IACf,CAAC,CAAC;AAAA,IACF,GAAG,QAAQ;AAAA,EACb;AAEA,QAAM,sBAAsB,CAC1B,SACA,WAAmC,CAAC,MACjC;AACH,WAAO,IAAI,2DAAkC,SAAS,UAAU;AAAA,MAC9D,UAAU;AAAA,MACV,KAAK,CAAC,EAAE,KAAK,MAAM,GAAG,OAAO,GAAG,IAAI;AAAA,MACpC,SAAS;AAAA,MACT,OAAO,QAAQ;AAAA,MACf,6BAA6B;AAAA,MAC7B,gBAAgB;AAAA,MAChB,mBAAmB;AAAA,MACnB,2BAA2B;AAAA,IAC7B,CAAC;AAAA,EACH;AAEA,QAAM,WAAW,CACf,SACA,aACG,oBAAoB,SAAS,QAAQ;AAE1C,WAAS,gBAAgB;AACzB,WAAS,OAAO;AAChB,WAAS,qBAAqB,CAAC,YAAoB;AACjD,UAAM,IAAI,iCAAiB,EAAE,SAAS,WAAW,qBAAqB,CAAC;AAAA,EACzE;AAEA,SAAO;AACT;AAEO,IAAM,aAAa,iBAAiB;","names":["import_provider_utils","import_zod"]}

package/dist/index.mjs

@@ -0,0 +1,133 @@
+// src/perplexity-provider.ts
+import {
+  NoSuchModelError
+} from "@ai-sdk/provider";
+import { OpenAICompatibleChatLanguageModel } from "@ai-sdk/openai-compatible";
+import {
+  loadApiKey,
+  withoutTrailingSlash
+} from "@ai-sdk/provider-utils";
+import { z as z2 } from "zod";
+
+// src/perplexity-metadata-extractor.ts
+import { safeValidateTypes } from "@ai-sdk/provider-utils";
+import { z } from "zod";
+var buildPerplexityMetadata = (citations, usage) => {
+  var _a, _b;
+  return citations || usage ? {
+    perplexity: {
+      ...citations && { citations },
+      ...usage && {
+        usage: {
+          citationTokens: (_a = usage.citation_tokens) != null ? _a : NaN,
+          numSearchQueries: (_b = usage.num_search_queries) != null ? _b : NaN
+        }
+      }
+    }
+  } : void 0;
+};
+var perplexityMetadataExtractor = {
+  extractMetadata: ({ parsedBody }) => {
+    var _a, _b;
+    const parsed = safeValidateTypes({
+      value: parsedBody,
+      schema: perplexityResponseSchema
+    });
+    return !parsed.success ? void 0 : buildPerplexityMetadata(
+      (_a = parsed.value.citations) != null ? _a : void 0,
+      (_b = parsed.value.usage) != null ? _b : void 0
+    );
+  },
+  createStreamExtractor: () => {
+    let citations;
+    let usage;
+    return {
+      processChunk: (chunk) => {
+        const parsed = safeValidateTypes({
+          value: chunk,
+          schema: perplexityStreamChunkSchema
+        });
+        if (parsed.success) {
+          if (parsed.value.citations) {
+            citations = parsed.value.citations;
+          }
+          if (parsed.value.usage) {
+            usage = parsed.value.usage;
+          }
+        }
+      },
+      buildMetadata: () => buildPerplexityMetadata(citations, usage)
+    };
+  }
+};
+var perplexityCitationSchema = z.array(z.string());
+var perplexityUsageSchema = z.object({
+  citation_tokens: z.number().nullish(),
+  num_search_queries: z.number().nullish()
+});
+var perplexityResponseSchema = z.object({
+  citations: perplexityCitationSchema.nullish(),
+  usage: perplexityUsageSchema.nullish()
+});
+var perplexityStreamChunkSchema = z.object({
+  choices: z.array(
+    z.object({
+      finish_reason: z.string().nullish(),
+      delta: z.object({
+        role: z.string(),
+        content: z.string()
+      }).nullish()
+    })
+  ).nullish(),
+  citations: perplexityCitationSchema.nullish(),
+  usage: perplexityUsageSchema.nullish()
+});
+
+// src/perplexity-provider.ts
+var perplexityErrorSchema = z2.object({
+  code: z2.string(),
+  error: z2.string()
+});
+var perplexityErrorStructure = {
+  errorSchema: perplexityErrorSchema,
+  errorToMessage: (data) => data.error
+};
+function createPerplexity(options = {}) {
+  var _a;
+  const baseURL = withoutTrailingSlash(
+    (_a = options.baseURL) != null ? _a : "https://api.perplexity.ai"
+  );
+  const getHeaders = () => ({
+    Authorization: `Bearer ${loadApiKey({
+      apiKey: options.apiKey,
+      environmentVariableName: "PERPLEXITY_API_KEY",
+      description: "Perplexity"
+    })}`,
+    ...options.headers
+  });
+  const createLanguageModel = (modelId, settings = {}) => {
+    return new OpenAICompatibleChatLanguageModel(modelId, settings, {
+      provider: "perplexity.chat",
+      url: ({ path }) => `${baseURL}${path}`,
+      headers: getHeaders,
+      fetch: options.fetch,
+      defaultObjectGenerationMode: "json",
+      errorStructure: perplexityErrorStructure,
+      metadataExtractor: perplexityMetadataExtractor,
+      supportsStructuredOutputs: true
+    });
+  };
+  const provider = (modelId, settings) => createLanguageModel(modelId, settings);
+  provider.languageModel = createLanguageModel;
+  provider.chat = createLanguageModel;
+  provider.textEmbeddingModel = (modelId) => {
+    throw new NoSuchModelError({ modelId, modelType: "textEmbeddingModel" });
+  };
+  return provider;
+}
+var perplexity = createPerplexity();
+export {
+  createPerplexity,
+  perplexity
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/perplexity-provider.ts","../src/perplexity-metadata-extractor.ts"],"sourcesContent":["import {\n  LanguageModelV1,\n  NoSuchModelError,\n  ProviderV1,\n} from '@ai-sdk/provider';\nimport { OpenAICompatibleChatLanguageModel } from '@ai-sdk/openai-compatible';\nimport {\n  FetchFunction,\n  loadApiKey,\n  withoutTrailingSlash,\n} from '@ai-sdk/provider-utils';\nimport {\n  PerplexityChatModelId,\n  PerplexityChatSettings,\n} from './perplexity-chat-settings';\nimport { z } from 'zod';\nimport { ProviderErrorStructure } from '@ai-sdk/openai-compatible';\nimport { perplexityMetadataExtractor } from './perplexity-metadata-extractor';\n\n// Add error schema and structure\nconst perplexityErrorSchema = z.object({\n  code: z.string(),\n  error: z.string(),\n});\n\nexport type PerplexityErrorData = z.infer<typeof perplexityErrorSchema>;\n\nconst perplexityErrorStructure: ProviderErrorStructure<PerplexityErrorData> = {\n  errorSchema: perplexityErrorSchema,\n  errorToMessage: data => data.error,\n};\n\nexport interface PerplexityProvider extends ProviderV1 {\n  /**\nCreates an Perplexity chat model for text generation.\n   */\n  (\n    modelId: PerplexityChatModelId,\n    settings?: PerplexityChatSettings,\n  ): LanguageModelV1;\n\n  /**\nCreates an Perplexity language model for text generation.\n   */\n  languageModel(\n    modelId: PerplexityChatModelId,\n    settings?: PerplexityChatSettings,\n  ): LanguageModelV1;\n\n  /**\nCreates an Perplexity chat model for text generation.\n   */\n  chat: (\n    modelId: PerplexityChatModelId,\n    settings?: PerplexityChatSettings,\n  ) => LanguageModelV1;\n}\n\nexport interface PerplexityProviderSettings {\n  /**\nBase URL for the perplexity API calls.\n     */\n  baseURL?: string;\n\n  /**\nAPI key for authenticating requests.\n   */\n  apiKey?: string;\n\n  /**\nCustom headers to include in the requests.\n   */\n  headers?: Record<string, string>;\n\n  /**\nCustom fetch implementation. You can use it as a middleware to intercept requests,\nor to provide a custom fetch implementation for e.g. testing.\n  */\n  fetch?: FetchFunction;\n}\n\nexport function createPerplexity(\n  options: PerplexityProviderSettings = {},\n): PerplexityProvider {\n  const baseURL = withoutTrailingSlash(\n    options.baseURL ?? 'https://api.perplexity.ai',\n  );\n  const getHeaders = () => ({\n    Authorization: `Bearer ${loadApiKey({\n      apiKey: options.apiKey,\n      environmentVariableName: 'PERPLEXITY_API_KEY',\n      description: 'Perplexity',\n    })}`,\n    ...options.headers,\n  });\n\n  const createLanguageModel = (\n    modelId: PerplexityChatModelId,\n    settings: PerplexityChatSettings = {},\n  ) => {\n    return new OpenAICompatibleChatLanguageModel(modelId, settings, {\n      provider: 'perplexity.chat',\n      url: ({ path }) => `${baseURL}${path}`,\n      headers: getHeaders,\n      fetch: options.fetch,\n      defaultObjectGenerationMode: 'json',\n      errorStructure: perplexityErrorStructure,\n      metadataExtractor: perplexityMetadataExtractor,\n      supportsStructuredOutputs: true,\n    });\n  };\n\n  const provider = (\n    modelId: PerplexityChatModelId,\n    settings?: PerplexityChatSettings,\n  ) => createLanguageModel(modelId, settings);\n\n  provider.languageModel = createLanguageModel;\n  provider.chat = createLanguageModel;\n  provider.textEmbeddingModel = (modelId: string) => {\n    throw new NoSuchModelError({ modelId, modelType: 'textEmbeddingModel' });\n  };\n\n  return provider as PerplexityProvider;\n}\n\nexport const perplexity = createPerplexity();\n","import { MetadataExtractor } from '@ai-sdk/openai-compatible';\nimport { safeValidateTypes } from '@ai-sdk/provider-utils';\nimport { z } from 'zod';\n\nconst buildPerplexityMetadata = (\n  citations: string[] | undefined,\n  usage: z.infer<typeof perplexityUsageSchema> | undefined,\n) => {\n  return citations || usage\n    ? {\n        perplexity: {\n          ...(citations && { citations }),\n          ...(usage && {\n            usage: {\n              citationTokens: usage.citation_tokens ?? NaN,\n              numSearchQueries: usage.num_search_queries ?? NaN,\n            },\n          }),\n        },\n      }\n    : undefined;\n};\n\nexport const perplexityMetadataExtractor: MetadataExtractor = {\n  extractMetadata: ({ parsedBody }: { parsedBody: unknown }) => {\n    const parsed = safeValidateTypes({\n      value: parsedBody,\n      schema: perplexityResponseSchema,\n    });\n\n    return !parsed.success\n      ? undefined\n      : buildPerplexityMetadata(\n          parsed.value.citations ?? undefined,\n          parsed.value.usage ?? undefined,\n        );\n  },\n\n  createStreamExtractor: () => {\n    let citations: string[] | undefined;\n    let usage: z.infer<typeof perplexityUsageSchema> | undefined;\n\n    return {\n      processChunk: (chunk: unknown) => {\n        const parsed = safeValidateTypes({\n          value: chunk,\n          schema: perplexityStreamChunkSchema,\n        });\n\n        if (parsed.success) {\n          // Update citations and usage with latest data from each chunk\n          if (parsed.value.citations) {\n            citations = parsed.value.citations;\n          }\n          if (parsed.value.usage) {\n            usage = parsed.value.usage;\n          }\n        }\n      },\n      buildMetadata: () => buildPerplexityMetadata(citations, usage),\n    };\n  },\n};\n\n// Schema for citations\nconst perplexityCitationSchema = z.array(z.string());\n\nconst perplexityUsageSchema = z.object({\n  citation_tokens: z.number().nullish(),\n  num_search_queries: z.number().nullish(),\n});\n\n// Update response schema to include usage\nconst perplexityResponseSchema = z.object({\n  citations: perplexityCitationSchema.nullish(),\n  usage: perplexityUsageSchema.nullish(),\n});\n\n// Update stream chunk schema to match example format\nconst perplexityStreamChunkSchema = z.object({\n  choices: z\n    .array(\n      z.object({\n        finish_reason: z.string().nullish(),\n        delta: z\n          .object({\n            role: z.string(),\n            content: z.string(),\n          })\n          .nullish(),\n      }),\n    )\n    .nullish(),\n  citations: perplexityCitationSchema.nullish(),\n  usage: perplexityUsageSchema.nullish(),\n});\n"],"mappings":";AAAA;AAAA,EAEE;AAAA,OAEK;AACP,SAAS,yCAAyC;AAClD;AAAA,EAEE;AAAA,EACA;AAAA,OACK;AAKP,SAAS,KAAAA,UAAS;;;ACdlB,SAAS,yBAAyB;AAClC,SAAS,SAAS;AAElB,IAAM,0BAA0B,CAC9B,WACA,UACG;AAPL;AAQE,SAAO,aAAa,QAChB;AAAA,IACE,YAAY;AAAA,MACV,GAAI,aAAa,EAAE,UAAU;AAAA,MAC7B,GAAI,SAAS;AAAA,QACX,OAAO;AAAA,UACL,iBAAgB,WAAM,oBAAN,YAAyB;AAAA,UACzC,mBAAkB,WAAM,uBAAN,YAA4B;AAAA,QAChD;AAAA,MACF;AAAA,IACF;AAAA,EACF,IACA;AACN;AAEO,IAAM,8BAAiD;AAAA,EAC5D,iBAAiB,CAAC,EAAE,WAAW,MAA+B;AAxBhE;AAyBI,UAAM,SAAS,kBAAkB;AAAA,MAC/B,OAAO;AAAA,MACP,QAAQ;AAAA,IACV,CAAC;AAED,WAAO,CAAC,OAAO,UACX,SACA;AAAA,OACE,YAAO,MAAM,cAAb,YAA0B;AAAA,OAC1B,YAAO,MAAM,UAAb,YAAsB;AAAA,IACxB;AAAA,EACN;AAAA,EAEA,uBAAuB,MAAM;AAC3B,QAAI;AACJ,QAAI;AAEJ,WAAO;AAAA,MACL,cAAc,CAAC,UAAmB;AAChC,cAAM,SAAS,kBAAkB;AAAA,UAC/B,OAAO;AAAA,UACP,QAAQ;AAAA,QACV,CAAC;AAED,YAAI,OAAO,SAAS;AAElB,cAAI,OAAO,MAAM,WAAW;AAC1B,wBAAY,OAAO,MAAM;AAAA,UAC3B;AACA,cAAI,OAAO,MAAM,OAAO;AACtB,oBAAQ,OAAO,MAAM;AAAA,UACvB;AAAA,QACF;AAAA,MACF;AAAA,MACA,eAAe,MAAM,wBAAwB,WAAW,KAAK;AAAA,IAC/D;AAAA,EACF;AACF;AAGA,IAAM,2BAA2B,EAAE,MAAM,EAAE,OAAO,CAAC;AAEnD,IAAM,wBAAwB,EAAE,OAAO;AAAA,EACrC,iBAAiB,EAAE,OAAO,EAAE,QAAQ;AAAA,EACpC,oBAAoB,EAAE,OAAO,EAAE,QAAQ;AACzC,CAAC;AAGD,IAAM,2BAA2B,EAAE,OAAO;AAAA,EACxC,WAAW,yBAAyB,QAAQ;AAAA,EAC5C,OAAO,sBAAsB,QAAQ;AACvC,CAAC;AAGD,IAAM,8BAA8B,EAAE,OAAO;AAAA,EAC3C,SAAS,EACN;AAAA,IACC,EAAE,OAAO;AAAA,MACP,eAAe,EAAE,OAAO,EAAE,QAAQ;AAAA,MAClC,OAAO,EACJ,OAAO;AAAA,QACN,MAAM,EAAE,OAAO;AAAA,QACf,SAAS,EAAE,OAAO;AAAA,MACpB,CAAC,EACA,QAAQ;AAAA,IACb,CAAC;AAAA,EACH,EACC,QAAQ;AAAA,EACX,WAAW,yBAAyB,QAAQ;AAAA,EAC5C,OAAO,sBAAsB,QAAQ;AACvC,CAAC;;;AD3ED,IAAM,wBAAwBC,GAAE,OAAO;AAAA,EACrC,MAAMA,GAAE,OAAO;AAAA,EACf,OAAOA,GAAE,OAAO;AAClB,CAAC;AAID,IAAM,2BAAwE;AAAA,EAC5E,aAAa;AAAA,EACb,gBAAgB,UAAQ,KAAK;AAC/B;AAmDO,SAAS,iBACd,UAAsC,CAAC,GACnB;AAnFtB;AAoFE,QAAM,UAAU;AAAA,KACd,aAAQ,YAAR,YAAmB;AAAA,EACrB;AACA,QAAM,aAAa,OAAO;AAAA,IACxB,eAAe,UAAU,WAAW;AAAA,MAClC,QAAQ,QAAQ;AAAA,MAChB,yBAAyB;AAAA,MACzB,aAAa;AAAA,IACf,CAAC,CAAC;AAAA,IACF,GAAG,QAAQ;AAAA,EACb;AAEA,QAAM,sBAAsB,CAC1B,SACA,WAAmC,CAAC,MACjC;AACH,WAAO,IAAI,kCAAkC,SAAS,UAAU;AAAA,MAC9D,UAAU;AAAA,MACV,KAAK,CAAC,EAAE,KAAK,MAAM,GAAG,OAAO,GAAG,IAAI;AAAA,MACpC,SAAS;AAAA,MACT,OAAO,QAAQ;AAAA,MACf,6BAA6B;AAAA,MAC7B,gBAAgB;AAAA,MAChB,mBAAmB;AAAA,MACnB,2BAA2B;AAAA,IAC7B,CAAC;AAAA,EACH;AAEA,QAAM,WAAW,CACf,SACA,aACG,oBAAoB,SAAS,QAAQ;AAE1C,WAAS,gBAAgB;AACzB,WAAS,OAAO;AAChB,WAAS,qBAAqB,CAAC,YAAoB;AACjD,UAAM,IAAI,iBAAiB,EAAE,SAAS,WAAW,qBAAqB,CAAC;AAAA,EACzE;AAEA,SAAO;AACT;AAEO,IAAM,aAAa,iBAAiB;","names":["z","z"]}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@ai-sdk/perplexity",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*",
+    "CHANGELOG.md"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@ai-sdk/openai-compatible": "0.1.3",
+    "@ai-sdk/provider": "1.0.6",
+    "@ai-sdk/provider-utils": "2.1.2"
+  },
+  "devDependencies": {
+    "@types/node": "^18",
+    "tsup": "^8",
+    "typescript": "5.6.3",
+    "zod": "3.23.8",
+    "@vercel/ai-tsconfig": "0.0.0"
+  },
+  "peerDependencies": {
+    "zod": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://sdk.vercel.ai/docs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vercel/ai.git"
+  },
+  "bugs": {
+    "url": "https://github.com/vercel/ai/issues"
+  },
+  "keywords": [
+    "ai"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "clean": "rm -rf dist",
+    "lint": "eslint \"./**/*.ts*\"",
+    "type-check": "tsc --noEmit",
+    "prettier-check": "prettier --check \"./**/*.ts*\"",
+    "test": "pnpm test:node && pnpm test:edge",
+    "test:edge": "vitest --config vitest.edge.config.js --run",
+    "test:node": "vitest --config vitest.node.config.js --run"
+  }
+}