@friendliai/ai-provider 0.1.24 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @friendliai/ai-provider
 
+## 0.2.0
+
+### Minor Changes
+
+- f262011: convert-openai-compatible-components
+
+  - dedicated, serverless automatic switching
+  - /v1/completion available
+  - Improved error parsing logic
+  - Update dependency packages
+  - Liquidate some of the legacy
+  - Other minor bug fixes
+
+### Patch Changes
+
+- bcdf26e: Convert regex input to RegExp type
+
+## 0.1.25
+
+### Patch Changes
+
+- 894764d: fix model list
+
 ## 0.1.24
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,115 +1,96 @@
-import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
+import { LanguageModelV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
+import { OpenAICompatibleChatSettings } from '@ai-sdk/openai-compatible';
+import { z } from 'zod';
 
-type FriendliAIChatModelId = "meta-llama-3.1-8b-instruct" | "meta-llama-3.1-70b-instruct" | "mixtral-8x7b-instruct-v0-1" | (string & {});
-type FriendliAIBetaChatModelId = "llama-3.2-11b-vision-instruct" | "exaone-3.5-7.8b-instruct" | "exaone-3.5-32b-instruct" | (string & {});
-interface FriendliAIChatSettings {
+declare const FriendliAIServerlessModelIds: readonly ["meta-llama-3.1-8b-instruct", "meta-llama-3.1-70b-instruct", "mixtral-8x7b-instruct-v0-1"];
+type FriendliAIServerlessModelId = (typeof FriendliAIServerlessModelIds)[number];
+type FriendliAILanguageModelId = FriendliAIServerlessModelId | (string & {});
+type FriendliAIBetaChatModelId = "llama-3.2-11b-vision-instruct" | (string & {});
+interface FriendliAISharedSettings {
     /**
-  Modify the likelihood of specified tokens appearing in the completion.
-  
-  Accepts a JSON object that maps tokens (specified by their token ID in
-  the GPT tokenizer) to an associated bias value from -100 to 100. You
-  can use this tokenizer tool to convert text to token IDs. Mathematically,
-  the bias is added to the logits generated by the model prior to sampling.
-  The exact effect will vary per model, but values between -1 and 1 should
-  decrease or increase likelihood of selection; values like -100 or 100
-  should result in a ban or exclusive selection of the relevant token.
-  
-  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
-  token from being generated.
-  */
-    logitBias?: Record<number, number>;
-    /**
-  Return the log probabilities of the tokens. Including logprobs will increase
-  the response size and can slow down response times. However, it can
-  be useful to better understand how the model is behaving.
-  
-  Setting to true will return the log probabilities of the tokens that
-  were generated.
-  
-  Setting to a number will return the log probabilities of the top n
-  tokens that were generated.
-  */
-    logprobs?: boolean | number;
-    /**
-  Whether to enable parallel function calling during tool use. Default to true.
+     * Sets the endpoint to which the request will be sent.
+     * auto: automatically selected based on model_id
+     * dedicated: Fixed to "/dedicated/v1"
+     * serverless: automatically selected as one of "/serverless/beta", "/serverless/v1", or "/serverless/tools/v1"
+     * Ignored if baseURL is specified.
      */
-    parallelToolCalls?: boolean;
-    /**
-  Whether to use structured outputs. Defaults to false.
-  
-  When enabled, tool calls and object generation will be strict and follow the provided schema.
-   */
-    structuredOutputs?: boolean;
+    endpoint?: "auto" | "dedicated" | "serverless";
+}
+interface FriendliAIChatSettings extends FriendliAISharedSettings, OpenAICompatibleChatSettings {
     /**
      BETA FEATURE: Include the model's training loss in the response.
      */
     tools?: Array<{
         type: "web:url" | "web:search" | "math:calendar" | "math:statistics" | "math:calculator" | "code:python-interpreter";
-    } | {
-        type: "file:text";
-        files: Array<string>;
     }>;
     /**
-     BETA FEATURE: You can write a regular expression to force output that satisfies that regular expression.
-     */
-    regex?: string;
-    /**
-  A unique identifier representing your end-user, which can help FriendliAI to
-  monitor and detect abuse. Learn more.
-  */
-    user?: string;
+    BETA FEATURE: You can write a regular expression to force output that satisfies that regular expression.
+    */
+    regex?: RegExp;
 }
 
-interface FriendliAIProvider extends ProviderV1 {
-    (modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+interface FriendliAIProviderSettings {
     /**
-     * Creates an FriendliAI model for text generation.
+     * FriendliAI API key. (FRIENDLI__TOKEN)
      */
-    languageModel(modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
-    chat(modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
-    serverless(modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
-    dedicated(modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    apiKey?: string;
     /**
-     * A model that has not yet been officially released
+     * Base URL for the API calls.
      */
-    beta(modelId: FriendliAIBetaChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
-}
-interface FriendliAIProviderSettings {
-    /**
-  Base URL for the FriendliAI API calls.
-       */
     baseURL?: string;
     /**
-  API key for authenticating requests.
-       */
-    apiKey?: string;
+     * Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
     /**
-     FriendliAI Team ID.
+     * FriendliAI Team ID.
      */
     teamId?: 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.
-      */
+     * 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;
 }
+interface FriendliAIProvider {
+    /**
+     * Creates a model for text generation.
+     */
+    (modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    /**
+     * A model that has not yet been officially released
+     */
+    beta(modelId: FriendliAIBetaChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    /**
+     * Creates a chat model for text generation.
+     */
+    chat(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    chatModel(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    /**
+     * Creates a completion model for text generation.
+     */
+    completion(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    completionModel(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    /**
+     * Creates a text embedding model for text generation.
+     */
+    embedding(modelId: string & {}, settings?: FriendliAIChatSettings): LanguageModelV1;
+    textEmbeddingModel(modelId: string & {}, settings?: FriendliAIChatSettings): LanguageModelV1;
+}
 /**
 Create an FriendliAI provider instance.
  */
 declare function createFriendli(options?: FriendliAIProviderSettings): FriendliAIProvider;
 declare const friendli: FriendliAIProvider;
-/**
- * @deprecated Use `friendli` instead.
- */
-declare const friendliai: FriendliAIProvider;
-/**
- * @deprecated Use `createFriendli` instead.
- */
-declare const createFriendliAI: typeof createFriendli;
 
-export { type FriendliAIProvider, type FriendliAIProviderSettings, createFriendli, createFriendliAI, friendli, friendliai };
+declare const friendliaiErrorSchema: z.ZodObject<{
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+}, {
+    message: string;
+}>;
+type FriendliAIErrorData = z.infer<typeof friendliaiErrorSchema>;
+
+export { type FriendliAIErrorData, type FriendliAIProvider, type FriendliAIProviderSettings, createFriendli, friendli };

package/dist/index.d.ts

@@ -1,115 +1,96 @@
-import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
+import { LanguageModelV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
+import { OpenAICompatibleChatSettings } from '@ai-sdk/openai-compatible';
+import { z } from 'zod';
 
-type FriendliAIChatModelId = "meta-llama-3.1-8b-instruct" | "meta-llama-3.1-70b-instruct" | "mixtral-8x7b-instruct-v0-1" | (string & {});
-type FriendliAIBetaChatModelId = "llama-3.2-11b-vision-instruct" | "exaone-3.5-7.8b-instruct" | "exaone-3.5-32b-instruct" | (string & {});
-interface FriendliAIChatSettings {
+declare const FriendliAIServerlessModelIds: readonly ["meta-llama-3.1-8b-instruct", "meta-llama-3.1-70b-instruct", "mixtral-8x7b-instruct-v0-1"];
+type FriendliAIServerlessModelId = (typeof FriendliAIServerlessModelIds)[number];
+type FriendliAILanguageModelId = FriendliAIServerlessModelId | (string & {});
+type FriendliAIBetaChatModelId = "llama-3.2-11b-vision-instruct" | (string & {});
+interface FriendliAISharedSettings {
     /**
-  Modify the likelihood of specified tokens appearing in the completion.
-  
-  Accepts a JSON object that maps tokens (specified by their token ID in
-  the GPT tokenizer) to an associated bias value from -100 to 100. You
-  can use this tokenizer tool to convert text to token IDs. Mathematically,
-  the bias is added to the logits generated by the model prior to sampling.
-  The exact effect will vary per model, but values between -1 and 1 should
-  decrease or increase likelihood of selection; values like -100 or 100
-  should result in a ban or exclusive selection of the relevant token.
-  
-  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
-  token from being generated.
-  */
-    logitBias?: Record<number, number>;
-    /**
-  Return the log probabilities of the tokens. Including logprobs will increase
-  the response size and can slow down response times. However, it can
-  be useful to better understand how the model is behaving.
-  
-  Setting to true will return the log probabilities of the tokens that
-  were generated.
-  
-  Setting to a number will return the log probabilities of the top n
-  tokens that were generated.
-  */
-    logprobs?: boolean | number;
-    /**
-  Whether to enable parallel function calling during tool use. Default to true.
+     * Sets the endpoint to which the request will be sent.
+     * auto: automatically selected based on model_id
+     * dedicated: Fixed to "/dedicated/v1"
+     * serverless: automatically selected as one of "/serverless/beta", "/serverless/v1", or "/serverless/tools/v1"
+     * Ignored if baseURL is specified.
      */
-    parallelToolCalls?: boolean;
-    /**
-  Whether to use structured outputs. Defaults to false.
-  
-  When enabled, tool calls and object generation will be strict and follow the provided schema.
-   */
-    structuredOutputs?: boolean;
+    endpoint?: "auto" | "dedicated" | "serverless";
+}
+interface FriendliAIChatSettings extends FriendliAISharedSettings, OpenAICompatibleChatSettings {
     /**
      BETA FEATURE: Include the model's training loss in the response.
      */
     tools?: Array<{
         type: "web:url" | "web:search" | "math:calendar" | "math:statistics" | "math:calculator" | "code:python-interpreter";
-    } | {
-        type: "file:text";
-        files: Array<string>;
     }>;
     /**
-     BETA FEATURE: You can write a regular expression to force output that satisfies that regular expression.
-     */
-    regex?: string;
-    /**
-  A unique identifier representing your end-user, which can help FriendliAI to
-  monitor and detect abuse. Learn more.
-  */
-    user?: string;
+    BETA FEATURE: You can write a regular expression to force output that satisfies that regular expression.
+    */
+    regex?: RegExp;
 }
 
-interface FriendliAIProvider extends ProviderV1 {
-    (modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+interface FriendliAIProviderSettings {
     /**
-     * Creates an FriendliAI model for text generation.
+     * FriendliAI API key. (FRIENDLI__TOKEN)
      */
-    languageModel(modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
-    chat(modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
-    serverless(modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
-    dedicated(modelId: FriendliAIChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    apiKey?: string;
     /**
-     * A model that has not yet been officially released
+     * Base URL for the API calls.
      */
-    beta(modelId: FriendliAIBetaChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
-}
-interface FriendliAIProviderSettings {
-    /**
-  Base URL for the FriendliAI API calls.
-       */
     baseURL?: string;
     /**
-  API key for authenticating requests.
-       */
-    apiKey?: string;
+     * Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
     /**
-     FriendliAI Team ID.
+     * FriendliAI Team ID.
      */
     teamId?: 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.
-      */
+     * 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;
 }
+interface FriendliAIProvider {
+    /**
+     * Creates a model for text generation.
+     */
+    (modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    /**
+     * A model that has not yet been officially released
+     */
+    beta(modelId: FriendliAIBetaChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    /**
+     * Creates a chat model for text generation.
+     */
+    chat(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    chatModel(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    /**
+     * Creates a completion model for text generation.
+     */
+    completion(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    completionModel(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
+    /**
+     * Creates a text embedding model for text generation.
+     */
+    embedding(modelId: string & {}, settings?: FriendliAIChatSettings): LanguageModelV1;
+    textEmbeddingModel(modelId: string & {}, settings?: FriendliAIChatSettings): LanguageModelV1;
+}
 /**
 Create an FriendliAI provider instance.
  */
 declare function createFriendli(options?: FriendliAIProviderSettings): FriendliAIProvider;
 declare const friendli: FriendliAIProvider;
-/**
- * @deprecated Use `friendli` instead.
- */
-declare const friendliai: FriendliAIProvider;
-/**
- * @deprecated Use `createFriendli` instead.
- */
-declare const createFriendliAI: typeof createFriendli;
 
-export { type FriendliAIProvider, type FriendliAIProviderSettings, createFriendli, createFriendliAI, friendli, friendliai };
+declare const friendliaiErrorSchema: z.ZodObject<{
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+}, {
+    message: string;
+}>;
+type FriendliAIErrorData = z.infer<typeof friendliaiErrorSchema>;
+
+export { type FriendliAIErrorData, type FriendliAIProvider, type FriendliAIProviderSettings, createFriendli, friendli };