@friendliai/ai-provider 0.2.7-alpha.0 → 0.2.7-alpha.2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @friendliai/ai-provider
 
+## 0.2.7-alpha.2
+
+### Patch Changes
+
+- 07b0162: enable regex on v5 (beta)
+- 3f15a05: enable support Tool Assisted API
+
+## 0.2.7-alpha.1
+
+### Patch Changes
+
+- dda6520: Added supported type model to friendli-provider
+
 ## 0.2.7-alpha.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,21 +1,35 @@
-import { LanguageModelV2 } from '@ai-sdk/provider';
+import { LanguageModelV1ProviderDefinedTool, ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV1, SpeechModelV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
 
 declare const FriendliAIServerlessModelIds: readonly ["meta-llama-3.1-8b-instruct", "meta-llama-3.3-70b-instruct", "deepseek-r1"];
 type FriendliAIServerlessModelId = (typeof FriendliAIServerlessModelIds)[number];
 type FriendliAILanguageModelId = FriendliAIServerlessModelId | (string & {});
-type FriendliAIBetaChatModelId = string & {};
+
+declare function webUrlBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function webSearchBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function mathCalendarBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function mathStatisticsBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function mathCalculatorBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function codePythonInterpreterBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare const friendliTools: {
+    webSearchBetaTool: typeof webSearchBetaTool;
+    webUrlBetaTool: typeof webUrlBetaTool;
+    mathCalendarBetaTool: typeof mathCalendarBetaTool;
+    mathStatisticsBetaTool: typeof mathStatisticsBetaTool;
+    mathCalculatorBetaTool: typeof mathCalculatorBetaTool;
+    codePythonInterpreterBetaTool: typeof codePythonInterpreterBetaTool;
+};
 
 interface FriendliAIProviderSettings {
     /**
-     * FriendliAI API key. (FRIENDLI__TOKEN)
+     * FriendliAI API key. (FRIENDLI_TOKEN)
      */
     apiKey?: string;
     /**
      * Base URL for the API calls.
      */
-    baseURL?: string;
+    baseURL?: string | 'auto' | 'dedicated' | 'serverless' | 'serverless-tools';
     /**
      * Custom headers to include in the requests.
      */
@@ -30,35 +44,56 @@ interface FriendliAIProviderSettings {
      */
     fetch?: FetchFunction;
 }
-interface FriendliAIProvider {
+interface FriendliAIProvider extends ProviderV2 {
     /**
      * Creates a model for text generation.
      */
     (modelId: FriendliAILanguageModelId): LanguageModelV2;
     /**
-     * A model that has not yet been officially released
+     * Creates a chat model for text generation.
      */
-    beta(modelId: FriendliAIBetaChatModelId): LanguageModelV2;
+    languageModel(modelId: FriendliAILanguageModelId): LanguageModelV2;
     /**
      * Creates a chat model for text generation.
      */
     chat(modelId: FriendliAILanguageModelId): LanguageModelV2;
-    chatModel(modelId: FriendliAILanguageModelId): LanguageModelV2;
     /**
      * Creates a completion model for text generation.
      */
     completion(modelId: FriendliAILanguageModelId): LanguageModelV2;
-    completionModel(modelId: FriendliAILanguageModelId): LanguageModelV2;
     /**
      * Creates a text embedding model for text generation.
+     * TODO: Implement for Dedicated users
+     */
+    embedding(modelId: string & {}): EmbeddingModelV2<string>;
+    textEmbeddingModel(modelId: string & {}): EmbeddingModelV2<string>;
+    /**
+     * Creates a model for image generation.
+     * TODO: Implement for Dedicated users
+     */
+    imageModel(modelId: string & {}): ImageModelV2;
+    /**
+     * Creates a model for transcription.
+     * TODO: Implement for Dedicated users
      */
-    embedding(modelId: string & {}): LanguageModelV2;
-    textEmbeddingModel(modelId: string & {}): LanguageModelV2;
+    transcription(modelId: string & {}): TranscriptionModelV1;
+    /**
+     * Creates a model for speech generation.
+     * TODO: Implement for Dedicated users
+     */
+    speech(modelId: string & {}): SpeechModelV1;
+    /**
+     * Friendli-specific tools.
+     */
+    tools: typeof friendliTools;
 }
 /**
 Create an FriendliAI provider instance.
  */
 declare function createFriendli(options?: FriendliAIProviderSettings): FriendliAIProvider;
+/**
+ * Default FriendliAI provider instance.
+ */
 declare const friendli: FriendliAIProvider;
 
 declare const friendliaiErrorSchema: z.ZodObject<{

package/dist/index.d.ts

@@ -1,21 +1,35 @@
-import { LanguageModelV2 } from '@ai-sdk/provider';
+import { LanguageModelV1ProviderDefinedTool, ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV1, SpeechModelV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
 
 declare const FriendliAIServerlessModelIds: readonly ["meta-llama-3.1-8b-instruct", "meta-llama-3.3-70b-instruct", "deepseek-r1"];
 type FriendliAIServerlessModelId = (typeof FriendliAIServerlessModelIds)[number];
 type FriendliAILanguageModelId = FriendliAIServerlessModelId | (string & {});
-type FriendliAIBetaChatModelId = string & {};
+
+declare function webUrlBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function webSearchBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function mathCalendarBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function mathStatisticsBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function mathCalculatorBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare function codePythonInterpreterBetaTool(): LanguageModelV1ProviderDefinedTool;
+declare const friendliTools: {
+    webSearchBetaTool: typeof webSearchBetaTool;
+    webUrlBetaTool: typeof webUrlBetaTool;
+    mathCalendarBetaTool: typeof mathCalendarBetaTool;
+    mathStatisticsBetaTool: typeof mathStatisticsBetaTool;
+    mathCalculatorBetaTool: typeof mathCalculatorBetaTool;
+    codePythonInterpreterBetaTool: typeof codePythonInterpreterBetaTool;
+};
 
 interface FriendliAIProviderSettings {
     /**
-     * FriendliAI API key. (FRIENDLI__TOKEN)
+     * FriendliAI API key. (FRIENDLI_TOKEN)
      */
     apiKey?: string;
     /**
      * Base URL for the API calls.
      */
-    baseURL?: string;
+    baseURL?: string | 'auto' | 'dedicated' | 'serverless' | 'serverless-tools';
     /**
      * Custom headers to include in the requests.
      */
@@ -30,35 +44,56 @@ interface FriendliAIProviderSettings {
      */
     fetch?: FetchFunction;
 }
-interface FriendliAIProvider {
+interface FriendliAIProvider extends ProviderV2 {
     /**
      * Creates a model for text generation.
      */
     (modelId: FriendliAILanguageModelId): LanguageModelV2;
     /**
-     * A model that has not yet been officially released
+     * Creates a chat model for text generation.
      */
-    beta(modelId: FriendliAIBetaChatModelId): LanguageModelV2;
+    languageModel(modelId: FriendliAILanguageModelId): LanguageModelV2;
     /**
      * Creates a chat model for text generation.
      */
     chat(modelId: FriendliAILanguageModelId): LanguageModelV2;
-    chatModel(modelId: FriendliAILanguageModelId): LanguageModelV2;
     /**
      * Creates a completion model for text generation.
      */
     completion(modelId: FriendliAILanguageModelId): LanguageModelV2;
-    completionModel(modelId: FriendliAILanguageModelId): LanguageModelV2;
     /**
      * Creates a text embedding model for text generation.
+     * TODO: Implement for Dedicated users
+     */
+    embedding(modelId: string & {}): EmbeddingModelV2<string>;
+    textEmbeddingModel(modelId: string & {}): EmbeddingModelV2<string>;
+    /**
+     * Creates a model for image generation.
+     * TODO: Implement for Dedicated users
+     */
+    imageModel(modelId: string & {}): ImageModelV2;
+    /**
+     * Creates a model for transcription.
+     * TODO: Implement for Dedicated users
      */
-    embedding(modelId: string & {}): LanguageModelV2;
-    textEmbeddingModel(modelId: string & {}): LanguageModelV2;
+    transcription(modelId: string & {}): TranscriptionModelV1;
+    /**
+     * Creates a model for speech generation.
+     * TODO: Implement for Dedicated users
+     */
+    speech(modelId: string & {}): SpeechModelV1;
+    /**
+     * Friendli-specific tools.
+     */
+    tools: typeof friendliTools;
 }
 /**
 Create an FriendliAI provider instance.
  */
 declare function createFriendli(options?: FriendliAIProviderSettings): FriendliAIProvider;
+/**
+ * Default FriendliAI provider instance.
+ */
 declare const friendli: FriendliAIProvider;
 
 declare const friendliaiErrorSchema: z.ZodObject<{

package/dist/index.js

@@ -64,6 +64,7 @@ function prepareTools({
   tools,
   toolChoice
 }) {
+  var _a;
   tools = (tools == null ? void 0 : tools.length) ? tools : void 0;
   const toolWarnings = [];
   if (tools == null) {
@@ -72,7 +73,10 @@ function prepareTools({
   const openaiCompatTools = [];
   for (const tool of tools) {
     if (tool.type === "provider-defined") {
-      toolWarnings.push({ type: "unsupported-tool", tool });
+      openaiCompatTools.push({
+        // NOTE: It would be better to use tool.name, but since ":" is replaced with "_", the following code is used instead
+        type: (_a = tool.id.split(".")[1]) != null ? _a : "unknown"
+      });
     } else {
       openaiCompatTools.push({
         type: "function",
@@ -143,18 +147,24 @@ var FriendliAIChatLanguageModel = class {
     topK,
     frequencyPenalty,
     presencePenalty,
-    // providerOptions,
+    providerOptions,
     stopSequences,
     responseFormat,
     seed,
     toolChoice,
-    tools
+    tools,
+    stream
   }) {
     var _a;
     const warnings = [];
     if (topK != null) {
       warnings.push({ type: "unsupported-setting", setting: "topK" });
     }
+    const friendliOptions = await (0, import_provider_utils2.parseProviderOptions)({
+      provider: "friendli",
+      providerOptions,
+      schema: friendliProviderOptionsSchema
+    });
     if ((responseFormat == null ? void 0 : responseFormat.type) === "json" && responseFormat.schema != null && !this.supportsStructuredOutputs) {
       warnings.push({
         type: "unsupported-setting",
@@ -177,6 +187,7 @@ var FriendliAIChatLanguageModel = class {
         // model specific settings:
         // user: compatibleOptions.user,
         // standardized settings:
+        stream,
         max_tokens: maxOutputTokens,
         temperature,
         top_p: topP,
@@ -189,7 +200,10 @@ var FriendliAIChatLanguageModel = class {
             name: (_a = responseFormat.name) != null ? _a : "response",
             description: responseFormat.description
           }
-        } : { type: "json_object" } : void 0,
+        } : { type: "json_object" } : (friendliOptions == null ? void 0 : friendliOptions.regex) != null ? {
+          type: "regex",
+          schema: friendliOptions.regex
+        } : void 0,
         stop: stopSequences,
         seed,
         // ...providerOptions?.[this.providerOptionsName],
@@ -198,14 +212,15 @@ var FriendliAIChatLanguageModel = class {
         messages: (0, import_internal.convertToOpenAICompatibleChatMessages)(prompt),
         // tools:
         tools: openaiTools,
-        tool_choice: openaiToolChoice
+        tool_choice: openaiToolChoice,
+        parallel_tool_calls: friendliOptions == null ? void 0 : friendliOptions.parallelToolCalls
       },
       warnings: [...warnings, ...toolWarnings]
     };
   }
   async doGenerate(options) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m;
-    const { args, warnings } = await this.getArgs({ ...options });
+    const { args, warnings } = await this.getArgs({ ...options, stream: false });
     const body = JSON.stringify(args);
     const {
       responseHeaders,
@@ -271,7 +286,7 @@ var FriendliAIChatLanguageModel = class {
   }
   async doStream(options) {
     var _a;
-    const { args, warnings } = await this.getArgs({ ...options });
+    const { args, warnings } = await this.getArgs({ ...options, stream: true });
     const body = {
       ...args,
       stream: true,
@@ -647,6 +662,75 @@ var createOpenAICompatibleChatChunkSchema = (errorSchema) => import_zod2.z.union
   }),
   errorSchema
 ]);
+var friendliProviderOptionsSchema = import_zod2.z.object({
+  /**
+   * Whether to enable parallel function calling during tool use. Default to true.
+   */
+  parallelToolCalls: import_zod2.z.boolean().nullish(),
+  /**
+   * BETA FEATURE: You can write a regular expression to force output that satisfies that regular expression.
+   */
+  // regex: z.instanceof(RegExp).nullish(),
+  regex: import_zod2.z.string().nullish()
+});
+
+// src/friendli-tools.ts
+function webUrlBetaTool() {
+  return {
+    type: "provider-defined",
+    id: "friendli.web:url",
+    name: "web:url",
+    args: {}
+  };
+}
+function webSearchBetaTool() {
+  return {
+    type: "provider-defined",
+    id: "friendli.web:search",
+    name: "web:search",
+    args: {}
+  };
+}
+function mathCalendarBetaTool() {
+  return {
+    type: "provider-defined",
+    id: "friendli.math:calendar",
+    name: "math:calendar",
+    args: {}
+  };
+}
+function mathStatisticsBetaTool() {
+  return {
+    type: "provider-defined",
+    id: "friendli.math:statistics",
+    name: "math:statistics",
+    args: {}
+  };
+}
+function mathCalculatorBetaTool() {
+  return {
+    type: "provider-defined",
+    id: "friendli.math:calculator",
+    name: "math:calculator",
+    args: {}
+  };
+}
+function codePythonInterpreterBetaTool() {
+  return {
+    type: "provider-defined",
+    id: "friendli.code:python-interpreter",
+    name: "code:python-interpreter",
+    args: {}
+  };
+}
+var friendliTools = {
+  webSearchBetaTool,
+  webUrlBetaTool,
+  mathCalendarBetaTool,
+  mathStatisticsBetaTool,
+  mathCalculatorBetaTool,
+  codePythonInterpreterBetaTool
+};
 
 // src/friendli-provider.ts
 function createFriendli(options = {}) {
@@ -659,54 +743,50 @@ function createFriendli(options = {}) {
     "X-Friendli-Team": options.teamId,
     ...options.headers
   });
-  const baseURLAutoSelect = (modelId, endpoint, baseURL, tools) => {
-    const customBaseURL = (0, import_provider_utils3.withoutTrailingSlash)(baseURL);
-    if (typeof customBaseURL === "string") {
-      return { baseURL: customBaseURL, type: "custom" };
-    }
+  const baseURLAutoSelect = (modelId, baseURL) => {
     const FriendliBaseURL = {
-      beta: "https://api.friendli.ai/serverless/beta",
       serverless: "https://api.friendli.ai/serverless/v1",
-      tools: "https://api.friendli.ai/serverless/tools/v1",
+      serverless_tools: "https://api.friendli.ai/serverless/tools/v1",
       dedicated: "https://api.friendli.ai/dedicated/v1"
     };
-    if (endpoint === "beta") {
-      return {
-        baseURL: FriendliBaseURL.beta,
-        type: "beta"
-      };
+    const customBaseURL = (0, import_provider_utils3.withoutTrailingSlash)(baseURL);
+    if (typeof customBaseURL === "string" && customBaseURL !== "dedicated" && customBaseURL !== "serverless" && customBaseURL !== "serverless-tools") {
+      return { baseURL: customBaseURL, type: "custom" };
     }
-    if (
-      // If the endpoint setting is serverless or auto and the model is floating on serverless,
-      endpoint === "serverless" || endpoint === "auto" && Object.values(FriendliAIServerlessModelIds).includes(
-        modelId
-      )
-    ) {
-      if (tools && tools.length > 0) {
+    switch (baseURL) {
+      case "dedicated":
         return {
-          baseURL: FriendliBaseURL.tools,
-          type: "tools"
+          baseURL: FriendliBaseURL.dedicated,
+          type: "dedicated"
         };
-      }
-      return {
-        baseURL: FriendliBaseURL.serverless,
-        type: "serverless"
-      };
-    } else {
-      return {
-        baseURL: FriendliBaseURL.dedicated,
-        type: "dedicated"
-      };
+      case "serverless":
+        return {
+          baseURL: FriendliBaseURL.serverless,
+          type: "serverless"
+        };
+      case "serverless-tools":
+        return {
+          baseURL: FriendliBaseURL.serverless_tools,
+          type: "serverless-tools"
+        };
+      default:
+        if (FriendliAIServerlessModelIds.includes(
+          modelId
+        )) {
+          return {
+            baseURL: FriendliBaseURL.serverless,
+            type: "serverless"
+          };
+        } else {
+          return {
+            baseURL: FriendliBaseURL.dedicated,
+            type: "dedicated"
+          };
+        }
     }
   };
-  const createChatModel = (modelId) => {
-    const { baseURL, type } = baseURLAutoSelect(
-      modelId,
-      // settings.endpoint || 'auto',
-      "auto",
-      options.baseURL
-      // settings.tools,
-    );
+  const createLanguageModel = (modelId) => {
+    const { baseURL, type } = baseURLAutoSelect(modelId, options.baseURL);
     return new FriendliAIChatLanguageModel(modelId, {
       provider: `friendliai.${type}.chat`,
       url: ({ path }) => `${baseURL}${path}`,
@@ -715,12 +795,7 @@ function createFriendli(options = {}) {
     });
   };
   const createCompletionModel = (modelId) => {
-    const { baseURL, type } = baseURLAutoSelect(
-      modelId,
-      // settings.endpoint || 'auto',
-      "auto",
-      options.baseURL
-    );
+    const { baseURL, type } = baseURLAutoSelect(modelId, options.baseURL);
     return new import_openai_compatible.OpenAICompatibleCompletionLanguageModel(modelId, {
       provider: `friendliai.${type}.completion`,
       url: ({ path }) => `${baseURL}${path}`,
@@ -729,35 +804,31 @@ function createFriendli(options = {}) {
       errorStructure: friendliaiErrorStructure
     });
   };
-  const createBetaModel = (modelId) => {
-    const { baseURL, type } = baseURLAutoSelect(
-      modelId,
-      "beta",
-      options.baseURL
-    );
-    return new FriendliAIChatLanguageModel(modelId, {
-      provider: `friendliai.${type}.chat`,
-      url: ({ path }) => `${baseURL}${path}`,
-      headers: getHeaders,
-      fetch: options.fetch
-    });
-  };
   const createTextEmbeddingModel = (modelId) => {
     throw new import_provider3.NoSuchModelError({ modelId, modelType: "textEmbeddingModel" });
   };
-  const provider = function(modelId) {
-    return createChatModel(modelId);
+  const createImageModel = (modelId) => {
+    throw new import_provider3.NoSuchModelError({ modelId, modelType: "imageModel" });
+  };
+  const createTranscriptionModel = (modelId) => {
+    throw new import_provider3.NoSuchModelError({ modelId, modelType: "languageModel" });
+  };
+  const createSpeechModel = (modelId) => {
+    throw new import_provider3.NoSuchModelError({ modelId, modelType: "languageModel" });
   };
-  provider.beta = createBetaModel;
-  provider.chat = createChatModel;
-  provider.chatModel = createChatModel;
+  const provider = (modelId) => createLanguageModel(modelId);
+  provider.languageModel = createLanguageModel;
+  provider.chat = createLanguageModel;
   provider.completion = createCompletionModel;
-  provider.completionModel = createCompletionModel;
   provider.embedding = createTextEmbeddingModel;
   provider.textEmbeddingModel = createTextEmbeddingModel;
+  provider.imageModel = createImageModel;
+  provider.transcription = createTranscriptionModel;
+  provider.speech = createSpeechModel;
+  provider.tools = friendliTools;
   return provider;
 }
-var friendli = createFriendli({});
+var friendli = createFriendli();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createFriendli,