@friendliai/ai-provider 0.1.19 → 0.1.21

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @friendliai/ai-provider
 
+## 0.1.21
+
+### Patch Changes
+
+- 89b09de: Built-in tool non-streaming support
+
+## 0.1.20
+
+### Patch Changes
+
+- 7caa63e: ## Updated code to match ai sdk 4.0.10
+
+  - createFriendliAI -> createFriendli
+  - Dependency Update
+  - Updated tool call parsing logic
+  - Improved object creation logic
+  - Added regex output support
+  - delete "content_filter", "function_call" finish reason
+
 ## 0.1.19
 
 ### Patch Changes

package/README.md

@@ -51,6 +51,25 @@ const { text } = await generateText({
 })
 ```
 
+### Example: Using Enforcing Patterns (Regex)
+
+Specify a specific pattern (e.g., CSV), character sets, or specific language characters (e.g., Korean Hangul characters) for your LLM's output.
+
+```ts
+import { friendli } from "@friendliai/ai-provider";
+import { generateText } from "ai";
+
+const { text } = await generateText({
+  model: friendli("meta-llama-3.1-8b-instruct", {
+    regex: "[\n ,.?!0-9\uac00-\ud7af]*",
+  }),
+  maxTokens: 40,
+  prompt: "who is the first king of the Joseon Dynasty?",
+});
+
+console.log(text);
+```
+
 ### Example: Using built-in tools (Beta)
 
 If you use `@friendliai/ai-provider`, you can use the [built-in tools](https://friendli.ai/docs/guides/serverless_endpoints/tools/built_in_tools) via the `tools` option.
@@ -84,7 +103,7 @@ FriendliAI language models can also be used in the `streamText`, `generateObject
 
 ## OpenAI Compatibility
 
-🎯 We can also use `@ai-sdk/openai` with OpenAI compatibility.
+We can also use `@ai-sdk/openai` with OpenAI compatibility.
 
 ```ts
 import { createOpenAI } from "@ai-sdk/openai";

package/dist/index.d.mts

@@ -50,6 +50,10 @@ interface FriendliAIChatSettings {
         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.
   */
@@ -72,10 +76,6 @@ interface FriendliAIProviderSettings {
        */
     baseURL?: string;
     /**
-  @deprecated Use `baseURL` instead.
-       */
-    baseUrl?: string;
-    /**
   API key for authenticating requests.
        */
     apiKey?: string;
@@ -88,12 +88,6 @@ interface FriendliAIProviderSettings {
        */
     headers?: Record<string, string>;
     /**
-  FriendliAI compatibility mode. Should be set to `strict` when using the FriendliAI API,
-  and `compatible` when using 3rd party providers. In `compatible` mode, newer
-  information such as streamOptions are not being sent. Defaults to 'compatible'.
-     */
-    compatibility?: "strict" | "compatible";
-    /**
   Custom fetch implementation. You can use it as a middleware to intercept requests,
   or to provide a custom fetch implementation for e.g. testing.
       */
@@ -102,11 +96,15 @@ interface FriendliAIProviderSettings {
 /**
 Create an FriendliAI provider instance.
  */
-declare function createFriendliAI(options?: FriendliAIProviderSettings): FriendliAIProvider;
+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, createFriendliAI, friendli, friendliai };
+export { type FriendliAIProvider, type FriendliAIProviderSettings, createFriendli, createFriendliAI, friendli, friendliai };

package/dist/index.d.ts

@@ -50,6 +50,10 @@ interface FriendliAIChatSettings {
         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.
   */
@@ -72,10 +76,6 @@ interface FriendliAIProviderSettings {
        */
     baseURL?: string;
     /**
-  @deprecated Use `baseURL` instead.
-       */
-    baseUrl?: string;
-    /**
   API key for authenticating requests.
        */
     apiKey?: string;
@@ -88,12 +88,6 @@ interface FriendliAIProviderSettings {
        */
     headers?: Record<string, string>;
     /**
-  FriendliAI compatibility mode. Should be set to `strict` when using the FriendliAI API,
-  and `compatible` when using 3rd party providers. In `compatible` mode, newer
-  information such as streamOptions are not being sent. Defaults to 'compatible'.
-     */
-    compatibility?: "strict" | "compatible";
-    /**
   Custom fetch implementation. You can use it as a middleware to intercept requests,
   or to provide a custom fetch implementation for e.g. testing.
       */
@@ -102,11 +96,15 @@ interface FriendliAIProviderSettings {
 /**
 Create an FriendliAI provider instance.
  */
-declare function createFriendliAI(options?: FriendliAIProviderSettings): FriendliAIProvider;
+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, createFriendliAI, friendli, friendliai };
+export { type FriendliAIProvider, type FriendliAIProviderSettings, createFriendli, createFriendliAI, friendli, friendliai };