@ai-sdk/perplexity 0.0.7 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @ai-sdk/perplexity
 
+## 1.0.0
+
+### Major Changes
+
+- 2e898b4: feat (provider/perplexity): rewrite provider and support sources
+
+### Patch Changes
+
+- Updated dependencies [2e898b4]
+  - @ai-sdk/provider-utils@2.1.8
+
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies [3ff4ef8]
+  - @ai-sdk/provider-utils@2.1.7
+  - @ai-sdk/openai-compatible@0.1.9
+
 ## 0.0.7
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,36 +1,17 @@
 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 {
-}
+type PerplexityLanguageModelId = 'sonar-reasoning-pro' | 'sonar-reasoning' | 'sonar-pro' | 'sonar' | (string & {});
 
-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;
+    (modelId: PerplexityLanguageModelId): 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;
+    languageModel(modelId: PerplexityLanguageModelId): LanguageModelV1;
 }
 interface PerplexityProviderSettings {
     /**
@@ -54,4 +35,4 @@ interface PerplexityProviderSettings {
 declare function createPerplexity(options?: PerplexityProviderSettings): PerplexityProvider;
 declare const perplexity: PerplexityProvider;
 
-export { type PerplexityErrorData, type PerplexityProvider, type PerplexityProviderSettings, createPerplexity, perplexity };
+export { type PerplexityProvider, type PerplexityProviderSettings, createPerplexity, perplexity };

package/dist/index.d.ts

@@ -1,36 +1,17 @@
 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 {
-}
+type PerplexityLanguageModelId = 'sonar-reasoning-pro' | 'sonar-reasoning' | 'sonar-pro' | 'sonar' | (string & {});
 
-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;
+    (modelId: PerplexityLanguageModelId): 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;
+    languageModel(modelId: PerplexityLanguageModelId): LanguageModelV1;
 }
 interface PerplexityProviderSettings {
     /**
@@ -54,4 +35,4 @@ interface PerplexityProviderSettings {
 declare function createPerplexity(options?: PerplexityProviderSettings): PerplexityProvider;
 declare const perplexity: PerplexityProvider;
 
-export { type PerplexityErrorData, type PerplexityProvider, type PerplexityProviderSettings, createPerplexity, perplexity };
+export { type PerplexityProvider, type PerplexityProviderSettings, createPerplexity, perplexity };

package/dist/index.js

@@ -26,115 +26,405 @@ __export(src_exports, {
 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_provider3 = require("@ai-sdk/provider");
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
-var import_zod2 = require("zod");
 
-// src/perplexity-metadata-extractor.ts
+// src/perplexity-language-model.ts
+var import_provider2 = require("@ai-sdk/provider");
 var import_provider_utils = require("@ai-sdk/provider-utils");
 var import_zod = require("zod");
-var perplexityMetadataExtractor = {
-  extractMetadata: ({ parsedBody }) => {
-    var _a, _b, _c;
-    const parsed = (0, import_provider_utils.safeValidateTypes)({
-      value: parsedBody,
-      schema: perplexityResponseSchema
+
+// src/convert-to-perplexity-messages.ts
+var import_provider = require("@ai-sdk/provider");
+function convertToPerplexityMessages(prompt) {
+  const messages = [];
+  for (const { role, content } of prompt) {
+    switch (role) {
+      case "system": {
+        messages.push({ role: "system", content });
+        break;
+      }
+      case "user":
+      case "assistant": {
+        messages.push({
+          role,
+          content: content.map((part) => {
+            switch (part.type) {
+              case "text": {
+                return part.text;
+              }
+              case "image": {
+                throw new import_provider.UnsupportedFunctionalityError({
+                  functionality: "Image content parts in user messages"
+                });
+              }
+              case "file": {
+                throw new import_provider.UnsupportedFunctionalityError({
+                  functionality: "File content parts in user messages"
+                });
+              }
+              case "tool-call": {
+                throw new import_provider.UnsupportedFunctionalityError({
+                  functionality: "Tool calls in assistant messages"
+                });
+              }
+              default: {
+                const _exhaustiveCheck = part;
+                throw new Error(`Unsupported part: ${_exhaustiveCheck}`);
+              }
+            }
+          }).join("")
+        });
+        break;
+      }
+      case "tool": {
+        throw new import_provider.UnsupportedFunctionalityError({
+          functionality: "Tool messages"
+        });
+      }
+      default: {
+        const _exhaustiveCheck = role;
+        throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
+      }
+    }
+  }
+  return messages;
+}
+
+// src/map-perplexity-finish-reason.ts
+function mapPerplexityFinishReason(finishReason) {
+  switch (finishReason) {
+    case "stop":
+    case "length":
+      return finishReason;
+    default:
+      return "unknown";
+  }
+}
+
+// src/perplexity-language-model.ts
+var PerplexityLanguageModel = class {
+  constructor(modelId, config) {
+    this.specificationVersion = "v1";
+    this.defaultObjectGenerationMode = "json";
+    this.supportsStructuredOutputs = true;
+    this.supportsImageUrls = false;
+    this.provider = "perplexity";
+    this.modelId = modelId;
+    this.config = config;
+  }
+  getArgs({
+    mode,
+    prompt,
+    maxTokens,
+    temperature,
+    topP,
+    topK,
+    frequencyPenalty,
+    presencePenalty,
+    stopSequences,
+    responseFormat,
+    seed,
+    providerMetadata
+  }) {
+    var _a;
+    const type = mode.type;
+    const warnings = [];
+    if (topK != null) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "topK"
+      });
+    }
+    if (stopSequences != null) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "stopSequences"
+      });
+    }
+    if (seed != null) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "seed"
+      });
+    }
+    const baseArgs = {
+      // model id:
+      model: this.modelId,
+      // standardized settings:
+      frequency_penalty: frequencyPenalty,
+      max_tokens: maxTokens,
+      presence_penalty: presencePenalty,
+      temperature,
+      top_k: topK,
+      top_p: topP,
+      // response format:
+      response_format: (responseFormat == null ? void 0 : responseFormat.type) === "json" ? {
+        type: "json_schema",
+        json_schema: { schema: responseFormat.schema }
+      } : void 0,
+      // provider extensions
+      ...(_a = providerMetadata == null ? void 0 : providerMetadata.perplexity) != null ? _a : {},
+      // messages:
+      messages: convertToPerplexityMessages(prompt)
+    };
+    switch (type) {
+      case "regular": {
+        return { args: baseArgs, warnings };
+      }
+      case "object-json": {
+        return {
+          args: {
+            ...baseArgs,
+            response_format: {
+              type: "json_schema",
+              json_schema: { schema: mode.schema }
+            }
+          },
+          warnings
+        };
+      }
+      case "object-tool": {
+        throw new import_provider2.UnsupportedFunctionalityError({
+          functionality: "tool-mode object generation"
+        });
+      }
+      default: {
+        const _exhaustiveCheck = type;
+        throw new Error(`Unsupported type: ${_exhaustiveCheck}`);
+      }
+    }
+  }
+  async doGenerate(options) {
+    var _a, _b, _c, _d;
+    const { args, warnings } = this.getArgs(options);
+    const { responseHeaders, value: response } = await (0, import_provider_utils.postJsonToApi)({
+      url: `${this.config.baseURL}/chat/completions`,
+      headers: (0, import_provider_utils.combineHeaders)(this.config.headers(), options.headers),
+      body: args,
+      failedResponseHandler: (0, import_provider_utils.createJsonErrorResponseHandler)({
+        errorSchema: perplexityErrorSchema,
+        errorToMessage: (data) => data.error
+      }),
+      successfulResponseHandler: (0, import_provider_utils.createJsonResponseHandler)(
+        perplexityResponseSchema
+      ),
+      abortSignal: options.abortSignal,
+      fetch: this.config.fetch
     });
-    return !parsed.success ? void 0 : buildPerplexityMetadata(
-      (_a = parsed.value.citations) != null ? _a : void 0,
-      (_b = parsed.value.images) != null ? _b : void 0,
-      (_c = parsed.value.usage) != null ? _c : void 0
-    );
-  },
-  createStreamExtractor: () => {
-    let citations;
-    let images;
-    let usage;
+    const { messages: rawPrompt, ...rawSettings } = args;
+    const choice = response.choices[0];
+    const text = choice.message.content;
     return {
-      processChunk: (chunk) => {
-        var _a, _b, _c;
-        const parsed = (0, import_provider_utils.safeValidateTypes)({
-          value: chunk,
-          schema: perplexityStreamChunkSchema
-        });
-        if (parsed.success) {
-          citations = (_a = parsed.value.citations) != null ? _a : citations;
-          images = (_b = parsed.value.images) != null ? _b : images;
-          usage = (_c = parsed.value.usage) != null ? _c : usage;
-        }
+      text,
+      toolCalls: [],
+      finishReason: mapPerplexityFinishReason(choice.finish_reason),
+      usage: {
+        promptTokens: response.usage.prompt_tokens,
+        completionTokens: response.usage.completion_tokens
       },
-      buildMetadata: () => buildPerplexityMetadata(citations, images, usage)
+      rawCall: { rawPrompt, rawSettings },
+      rawResponse: { headers: responseHeaders },
+      request: { body: JSON.stringify(args) },
+      response: getResponseMetadata(response),
+      warnings,
+      sources: response.citations.map((url) => ({
+        sourceType: "url",
+        id: this.config.generateId(),
+        url
+      })),
+      providerMetadata: {
+        perplexity: {
+          images: (_b = (_a = response.images) == null ? void 0 : _a.map((image) => ({
+            imageUrl: image.image_url,
+            originUrl: image.origin_url,
+            height: image.height,
+            width: image.width
+          }))) != null ? _b : null,
+          usage: {
+            citationTokens: (_c = response.usage.citation_tokens) != null ? _c : null,
+            numSearchQueries: (_d = response.usage.num_search_queries) != null ? _d : null
+          }
+        }
+      }
     };
   }
-};
-var buildPerplexityMetadata = (citations, images, usage) => {
-  var _a, _b;
-  return citations || images || usage ? {
-    perplexity: {
-      ...citations && { citations },
-      ...images && {
-        images: images.map((image) => ({
-          imageUrl: image.image_url,
-          originUrl: image.origin_url,
-          height: image.height,
-          width: image.width
-        }))
-      },
-      ...usage && {
+  async doStream(options) {
+    const { args, warnings } = this.getArgs(options);
+    const body = { ...args, stream: true };
+    const { responseHeaders, value: response } = await (0, import_provider_utils.postJsonToApi)({
+      url: `${this.config.baseURL}/chat/completions`,
+      headers: (0, import_provider_utils.combineHeaders)(this.config.headers(), options.headers),
+      body,
+      failedResponseHandler: (0, import_provider_utils.createJsonErrorResponseHandler)({
+        errorSchema: perplexityErrorSchema,
+        errorToMessage: (data) => data.error
+      }),
+      successfulResponseHandler: (0, import_provider_utils.createEventSourceResponseHandler)(
+        perplexityChunkSchema
+      ),
+      abortSignal: options.abortSignal,
+      fetch: this.config.fetch
+    });
+    const { messages: rawPrompt, ...rawSettings } = args;
+    let finishReason = "unknown";
+    let usage = {
+      promptTokens: Number.NaN,
+      completionTokens: Number.NaN
+    };
+    const providerMetadata = {
+      perplexity: {
         usage: {
-          citationTokens: (_a = usage.citation_tokens) != null ? _a : NaN,
-          numSearchQueries: (_b = usage.num_search_queries) != null ? _b : NaN
-        }
+          citationTokens: null,
+          numSearchQueries: null
+        },
+        images: null
       }
-    }
-  } : void 0;
+    };
+    let isFirstChunk = true;
+    const self = this;
+    return {
+      stream: response.pipeThrough(
+        new TransformStream({
+          transform(chunk, controller) {
+            var _a, _b, _c;
+            if (!chunk.success) {
+              controller.enqueue({ type: "error", error: chunk.error });
+              return;
+            }
+            const value = chunk.value;
+            if (isFirstChunk) {
+              controller.enqueue({
+                type: "response-metadata",
+                ...getResponseMetadata(value)
+              });
+              (_a = value.citations) == null ? void 0 : _a.forEach((url) => {
+                controller.enqueue({
+                  type: "source",
+                  source: {
+                    sourceType: "url",
+                    id: self.config.generateId(),
+                    url
+                  }
+                });
+              });
+              isFirstChunk = false;
+            }
+            if (value.usage != null) {
+              usage = {
+                promptTokens: value.usage.prompt_tokens,
+                completionTokens: value.usage.completion_tokens
+              };
+              providerMetadata.perplexity.usage = {
+                citationTokens: (_b = value.usage.citation_tokens) != null ? _b : null,
+                numSearchQueries: (_c = value.usage.num_search_queries) != null ? _c : null
+              };
+            }
+            if (value.images != null) {
+              providerMetadata.perplexity.images = value.images.map((image) => ({
+                imageUrl: image.image_url,
+                originUrl: image.origin_url,
+                height: image.height,
+                width: image.width
+              }));
+            }
+            const choice = value.choices[0];
+            if ((choice == null ? void 0 : choice.finish_reason) != null) {
+              finishReason = mapPerplexityFinishReason(choice.finish_reason);
+            }
+            if ((choice == null ? void 0 : choice.delta) == null) {
+              return;
+            }
+            const delta = choice.delta;
+            const textContent = delta.content;
+            if (textContent != null) {
+              controller.enqueue({
+                type: "text-delta",
+                textDelta: textContent
+              });
+            }
+          },
+          flush(controller) {
+            controller.enqueue({
+              type: "finish",
+              finishReason,
+              usage,
+              providerMetadata
+            });
+          }
+        })
+      ),
+      rawCall: { rawPrompt, rawSettings },
+      rawResponse: { headers: responseHeaders },
+      request: { body: JSON.stringify(body) },
+      warnings
+    };
+  }
 };
-var perplexityCitationSchema = import_zod.z.array(import_zod.z.string());
+function getResponseMetadata({
+  id,
+  model,
+  created
+}) {
+  return {
+    id,
+    modelId: model,
+    timestamp: new Date(created * 1e3)
+  };
+}
+var perplexityUsageSchema = import_zod.z.object({
+  prompt_tokens: import_zod.z.number(),
+  completion_tokens: import_zod.z.number(),
+  citation_tokens: import_zod.z.number().nullish(),
+  num_search_queries: import_zod.z.number().nullish()
+});
 var perplexityImageSchema = import_zod.z.object({
   image_url: import_zod.z.string(),
   origin_url: import_zod.z.string(),
   height: import_zod.z.number(),
   width: import_zod.z.number()
 });
-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(),
+  id: import_zod.z.string(),
+  created: import_zod.z.number(),
+  model: import_zod.z.string(),
+  choices: import_zod.z.array(
+    import_zod.z.object({
+      message: import_zod.z.object({
+        role: import_zod.z.literal("assistant"),
+        content: import_zod.z.string()
+      }),
+      finish_reason: import_zod.z.string()
+    })
+  ),
+  citations: import_zod.z.array(import_zod.z.string()),
   images: import_zod.z.array(perplexityImageSchema).nullish(),
-  usage: perplexityUsageSchema.nullish()
+  usage: perplexityUsageSchema
 });
-var perplexityStreamChunkSchema = import_zod.z.object({
+var perplexityChunkSchema = import_zod.z.object({
+  id: import_zod.z.string(),
+  created: import_zod.z.number(),
+  model: import_zod.z.string(),
   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(),
+        role: import_zod.z.literal("assistant"),
         content: import_zod.z.string()
-      }).nullish()
+      }),
+      finish_reason: import_zod.z.string().nullish()
     })
-  ).nullish(),
-  citations: perplexityCitationSchema.nullish(),
+  ),
+  citations: import_zod.z.array(import_zod.z.string()).nullish(),
   images: import_zod.z.array(perplexityImageSchema).nullish(),
   usage: perplexityUsageSchema.nullish()
 });
+var perplexityErrorSchema = import_zod.z.object({
+  code: import_zod.z.string(),
+  error: import_zod.z.string()
+});
 
 // 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,
@@ -143,23 +433,21 @@ function createPerplexity(options = {}) {
     })}`,
     ...options.headers
   });
-  const createLanguageModel = (modelId, settings = {}) => {
-    return new import_openai_compatible.OpenAICompatibleChatLanguageModel(modelId, settings, {
-      provider: "perplexity.chat",
-      url: ({ path }) => `${baseURL}${path}`,
+  const createLanguageModel = (modelId) => {
+    var _a;
+    return new PerplexityLanguageModel(modelId, {
+      baseURL: (0, import_provider_utils2.withoutTrailingSlash)(
+        (_a = options.baseURL) != null ? _a : "https://api.perplexity.ai"
+      ),
       headers: getHeaders,
-      fetch: options.fetch,
-      defaultObjectGenerationMode: "json",
-      errorStructure: perplexityErrorStructure,
-      metadataExtractor: perplexityMetadataExtractor,
-      supportsStructuredOutputs: true
+      generateId: import_provider_utils2.generateId,
+      fetch: options.fetch
     });
   };
-  const provider = (modelId, settings) => createLanguageModel(modelId, settings);
+  const provider = (modelId) => createLanguageModel(modelId);
   provider.languageModel = createLanguageModel;
-  provider.chat = createLanguageModel;
   provider.textEmbeddingModel = (modelId) => {
-    throw new import_provider.NoSuchModelError({ modelId, modelType: "textEmbeddingModel" });
+    throw new import_provider3.NoSuchModelError({ modelId, modelType: "textEmbeddingModel" });
   };
   return provider;
 }