@friendliai/ai-provider 0.2.6 → 0.2.7-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @friendliai/ai-provider
2
2
 
3
+ ## 0.2.7-alpha.1
4
+
5
+ ### Patch Changes
6
+
7
+ - dda6520: Added supported type model to friendli-provider
8
+
9
+ ## 0.2.7-alpha.0
10
+
11
+ ### Patch Changes
12
+
13
+ - 5ec8524: Initial build for ai sdk v5 support (broken Friendli compatibility)
14
+
3
15
  ## 0.2.6
4
16
 
5
17
  ### Patch Changes
package/README.md CHANGED
@@ -12,7 +12,7 @@ npm i @friendliai/ai-provider
12
12
 
13
13
  ## Credentials
14
14
 
15
- The tokens required for model usage can be obtained from the [Friendli suite](https://suite.friendli.ai/).
15
+ The tokens required for model usage can be obtained from the [Friendli suite](https://friendli.ai/suite/).
16
16
 
17
17
  To use the provider, you need to set the `FRIENDLI_TOKEN` environment variable with your personal access token.
18
18
 
package/dist/index.d.mts CHANGED
@@ -1,42 +1,14 @@
1
- import { LanguageModelV1 } from '@ai-sdk/provider';
1
+ import { ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV1, SpeechModelV1 } from '@ai-sdk/provider';
2
2
  import { FetchFunction } from '@ai-sdk/provider-utils';
3
- import { OpenAICompatibleChatSettings } from '@ai-sdk/openai-compatible';
4
3
  import { z } from 'zod';
5
4
 
6
5
  declare const FriendliAIServerlessModelIds: readonly ["meta-llama-3.1-8b-instruct", "meta-llama-3.3-70b-instruct", "deepseek-r1"];
7
6
  type FriendliAIServerlessModelId = (typeof FriendliAIServerlessModelIds)[number];
8
7
  type FriendliAILanguageModelId = FriendliAIServerlessModelId | (string & {});
9
- type FriendliAIBetaChatModelId = string & {};
10
- interface FriendliAISharedSettings {
11
- /**
12
- * Sets the endpoint to which the request will be sent.
13
- * auto: automatically selected based on model_id
14
- * dedicated: Fixed to "/dedicated/v1"
15
- * serverless: automatically selected as one of "/serverless/beta", "/serverless/v1", or "/serverless/tools/v1"
16
- * Ignored if baseURL is specified.
17
- */
18
- endpoint?: 'auto' | 'dedicated' | 'serverless';
19
- }
20
- interface FriendliAIChatSettings extends FriendliAISharedSettings, OpenAICompatibleChatSettings {
21
- /**
22
- * BETA FEATURE: Include the model's training loss in the response.
23
- */
24
- tools?: Array<{
25
- type: 'web:url' | 'web:search' | 'math:calendar' | 'math:statistics' | 'math:calculator' | 'code:python-interpreter';
26
- }>;
27
- /**
28
- * Whether to enable parallel function calling during tool use. Default to true.
29
- */
30
- parallelToolCalls?: boolean;
31
- /**
32
- * BETA FEATURE: You can write a regular expression to force output that satisfies that regular expression.
33
- */
34
- regex?: RegExp;
35
- }
36
8
 
37
9
  interface FriendliAIProviderSettings {
38
10
  /**
39
- * FriendliAI API key. (FRIENDLI__TOKEN)
11
+ * FriendliAI API key. (FRIENDLI_TOKEN)
40
12
  */
41
13
  apiKey?: string;
42
14
  /**
@@ -57,35 +29,52 @@ interface FriendliAIProviderSettings {
57
29
  */
58
30
  fetch?: FetchFunction;
59
31
  }
60
- interface FriendliAIProvider {
32
+ interface FriendliAIProvider extends ProviderV2 {
61
33
  /**
62
34
  * Creates a model for text generation.
63
35
  */
64
- (modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
36
+ (modelId: FriendliAILanguageModelId): LanguageModelV2;
65
37
  /**
66
- * A model that has not yet been officially released
38
+ * Creates a chat model for text generation.
67
39
  */
68
- beta(modelId: FriendliAIBetaChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
40
+ languageModel(modelId: FriendliAILanguageModelId): LanguageModelV2;
69
41
  /**
70
42
  * Creates a chat model for text generation.
71
43
  */
72
- chat(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
73
- chatModel(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
44
+ chat(modelId: FriendliAILanguageModelId): LanguageModelV2;
74
45
  /**
75
46
  * Creates a completion model for text generation.
76
47
  */
77
- completion(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
78
- completionModel(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
48
+ completion(modelId: FriendliAILanguageModelId): LanguageModelV2;
79
49
  /**
80
50
  * Creates a text embedding model for text generation.
51
+ * TODO: Implement for Dedicated users
52
+ */
53
+ embedding(modelId: string & {}): EmbeddingModelV2<string>;
54
+ textEmbeddingModel(modelId: string & {}): EmbeddingModelV2<string>;
55
+ /**
56
+ * Creates a model for image generation.
57
+ * TODO: Implement for Dedicated users
58
+ */
59
+ imageModel(modelId: string & {}): ImageModelV2;
60
+ /**
61
+ * Creates a model for transcription.
62
+ * TODO: Implement for Dedicated users
81
63
  */
82
- embedding(modelId: string & {}, settings?: FriendliAIChatSettings): LanguageModelV1;
83
- textEmbeddingModel(modelId: string & {}, settings?: FriendliAIChatSettings): LanguageModelV1;
64
+ transcription(modelId: string & {}): TranscriptionModelV1;
65
+ /**
66
+ * Creates a model for speech generation.
67
+ * TODO: Implement for Dedicated users
68
+ */
69
+ speech(modelId: string & {}): SpeechModelV1;
84
70
  }
85
71
  /**
86
72
  Create an FriendliAI provider instance.
87
73
  */
88
74
  declare function createFriendli(options?: FriendliAIProviderSettings): FriendliAIProvider;
75
+ /**
76
+ * Default FriendliAI provider instance.
77
+ */
89
78
  declare const friendli: FriendliAIProvider;
90
79
 
91
80
  declare const friendliaiErrorSchema: z.ZodObject<{
package/dist/index.d.ts CHANGED
@@ -1,42 +1,14 @@
1
- import { LanguageModelV1 } from '@ai-sdk/provider';
1
+ import { ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV1, SpeechModelV1 } from '@ai-sdk/provider';
2
2
  import { FetchFunction } from '@ai-sdk/provider-utils';
3
- import { OpenAICompatibleChatSettings } from '@ai-sdk/openai-compatible';
4
3
  import { z } from 'zod';
5
4
 
6
5
  declare const FriendliAIServerlessModelIds: readonly ["meta-llama-3.1-8b-instruct", "meta-llama-3.3-70b-instruct", "deepseek-r1"];
7
6
  type FriendliAIServerlessModelId = (typeof FriendliAIServerlessModelIds)[number];
8
7
  type FriendliAILanguageModelId = FriendliAIServerlessModelId | (string & {});
9
- type FriendliAIBetaChatModelId = string & {};
10
- interface FriendliAISharedSettings {
11
- /**
12
- * Sets the endpoint to which the request will be sent.
13
- * auto: automatically selected based on model_id
14
- * dedicated: Fixed to "/dedicated/v1"
15
- * serverless: automatically selected as one of "/serverless/beta", "/serverless/v1", or "/serverless/tools/v1"
16
- * Ignored if baseURL is specified.
17
- */
18
- endpoint?: 'auto' | 'dedicated' | 'serverless';
19
- }
20
- interface FriendliAIChatSettings extends FriendliAISharedSettings, OpenAICompatibleChatSettings {
21
- /**
22
- * BETA FEATURE: Include the model's training loss in the response.
23
- */
24
- tools?: Array<{
25
- type: 'web:url' | 'web:search' | 'math:calendar' | 'math:statistics' | 'math:calculator' | 'code:python-interpreter';
26
- }>;
27
- /**
28
- * Whether to enable parallel function calling during tool use. Default to true.
29
- */
30
- parallelToolCalls?: boolean;
31
- /**
32
- * BETA FEATURE: You can write a regular expression to force output that satisfies that regular expression.
33
- */
34
- regex?: RegExp;
35
- }
36
8
 
37
9
  interface FriendliAIProviderSettings {
38
10
  /**
39
- * FriendliAI API key. (FRIENDLI__TOKEN)
11
+ * FriendliAI API key. (FRIENDLI_TOKEN)
40
12
  */
41
13
  apiKey?: string;
42
14
  /**
@@ -57,35 +29,52 @@ interface FriendliAIProviderSettings {
57
29
  */
58
30
  fetch?: FetchFunction;
59
31
  }
60
- interface FriendliAIProvider {
32
+ interface FriendliAIProvider extends ProviderV2 {
61
33
  /**
62
34
  * Creates a model for text generation.
63
35
  */
64
- (modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
36
+ (modelId: FriendliAILanguageModelId): LanguageModelV2;
65
37
  /**
66
- * A model that has not yet been officially released
38
+ * Creates a chat model for text generation.
67
39
  */
68
- beta(modelId: FriendliAIBetaChatModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
40
+ languageModel(modelId: FriendliAILanguageModelId): LanguageModelV2;
69
41
  /**
70
42
  * Creates a chat model for text generation.
71
43
  */
72
- chat(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
73
- chatModel(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
44
+ chat(modelId: FriendliAILanguageModelId): LanguageModelV2;
74
45
  /**
75
46
  * Creates a completion model for text generation.
76
47
  */
77
- completion(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
78
- completionModel(modelId: FriendliAILanguageModelId, settings?: FriendliAIChatSettings): LanguageModelV1;
48
+ completion(modelId: FriendliAILanguageModelId): LanguageModelV2;
79
49
  /**
80
50
  * Creates a text embedding model for text generation.
51
+ * TODO: Implement for Dedicated users
52
+ */
53
+ embedding(modelId: string & {}): EmbeddingModelV2<string>;
54
+ textEmbeddingModel(modelId: string & {}): EmbeddingModelV2<string>;
55
+ /**
56
+ * Creates a model for image generation.
57
+ * TODO: Implement for Dedicated users
58
+ */
59
+ imageModel(modelId: string & {}): ImageModelV2;
60
+ /**
61
+ * Creates a model for transcription.
62
+ * TODO: Implement for Dedicated users
81
63
  */
82
- embedding(modelId: string & {}, settings?: FriendliAIChatSettings): LanguageModelV1;
83
- textEmbeddingModel(modelId: string & {}, settings?: FriendliAIChatSettings): LanguageModelV1;
64
+ transcription(modelId: string & {}): TranscriptionModelV1;
65
+ /**
66
+ * Creates a model for speech generation.
67
+ * TODO: Implement for Dedicated users
68
+ */
69
+ speech(modelId: string & {}): SpeechModelV1;
84
70
  }
85
71
  /**
86
72
  Create an FriendliAI provider instance.
87
73
  */
88
74
  declare function createFriendli(options?: FriendliAIProviderSettings): FriendliAIProvider;
75
+ /**
76
+ * Default FriendliAI provider instance.
77
+ */
89
78
  declare const friendli: FriendliAIProvider;
90
79
 
91
80
  declare const friendliaiErrorSchema: z.ZodObject<{