@ai-sdk/huggingface 1.0.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @ai-sdk/huggingface
+
+## 1.0.0-beta.0
+
+### Major Changes
+
+- ec640c6: feat(huggingface): add responses api support
+
+### Patch Changes
+
+- Updated dependencies [8dac895]
+- Updated dependencies [10c1322]
+  - @ai-sdk/openai-compatible@1.1.0-beta.5
+  - @ai-sdk/provider-utils@3.1.0-beta.5
+  - @ai-sdk/provider@2.1.0-beta.3

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,35 @@
+# Vercel AI SDK - Hugging Face Provider
+
+The **[Hugging Face Inference Providers](https://huggingface.co/docs/inference-providers/index)** for the [Vercel AI SDK](https://ai-sdk.dev/docs) contains language model support for thousands of models through multiple inference providers via the Hugging Face router API.
+
+## Setup
+
+The Hugging Face provider is available in the `@ai-sdk/huggingface` module. You can install it with:
+
+```bash
+npm i @ai-sdk/huggingface
+```
+
+## Provider Instance
+
+You can import the default provider instance `huggingface` from `@ai-sdk/huggingface`:
+
+```ts
+import { huggingface } from '@ai-sdk/huggingface';
+```
+
+## Example
+
+```ts
+import { huggingface } from '@ai-sdk/huggingface';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: huggingface('meta-llama/Llama-3.1-8B-Instruct'),
+  prompt: 'Write a vegetarian lasagna recipe.',
+});
+```
+
+## Documentation
+
+Please check out the **[Hugging Face provider documentation](https://ai-sdk.dev/providers/ai-sdk-providers/huggingface)** for more information.

package/dist/index.d.mts

@@ -0,0 +1,55 @@
+import { ProviderV3, LanguageModelV3 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+export { OpenAICompatibleErrorData as HuggingFaceErrorData } from '@ai-sdk/openai-compatible';
+
+type HuggingFaceResponsesModelId = 'meta-llama/Llama-3.1-8B-Instruct' | 'meta-llama/Llama-3.1-70B-Instruct' | 'meta-llama/Llama-3.1-405B-Instruct' | 'meta-llama/Llama-3.3-70B-Instruct' | 'meta-llama/Meta-Llama-3-8B-Instruct' | 'meta-llama/Meta-Llama-3-70B-Instruct' | 'meta-llama/Llama-3.2-3B-Instruct' | 'meta-llama/Llama-4-Maverick-17B-128E-Instruct' | 'meta-llama/Llama-4-Maverick-17B-128E-Instruct-FP8' | 'meta-llama/Llama-Guard-4-12B' | 'deepseek-ai/DeepSeek-V3.1' | 'deepseek-ai/DeepSeek-V3-0324' | 'deepseek-ai/DeepSeek-R1' | 'deepseek-ai/DeepSeek-R1-0528' | 'deepseek-ai/DeepSeek-R1-Distill-Qwen-1.5B' | 'deepseek-ai/DeepSeek-R1-Distill-Qwen-7B' | 'deepseek-ai/DeepSeek-R1-Distill-Qwen-14B' | 'deepseek-ai/DeepSeek-R1-Distill-Qwen-32B' | 'deepseek-ai/DeepSeek-R1-Distill-Llama-8B' | 'deepseek-ai/DeepSeek-R1-Distill-Llama-70B' | 'deepseek-ai/DeepSeek-Prover-V2-671B' | 'Qwen/Qwen3-32B' | 'Qwen/Qwen3-14B' | 'Qwen/Qwen3-8B' | 'Qwen/Qwen3-4B' | 'Qwen/Qwen3-Coder-480B-A35B-Instruct' | 'Qwen/Qwen3-Coder-480B-A35B-Instruct-FP8' | 'Qwen/Qwen3-30B-A3B' | 'Qwen/Qwen2.5-VL-7B-Instruct' | 'Qwen/Qwen2.5-7B-Instruct' | 'Qwen/Qwen2.5-Coder-7B-Instruct' | 'Qwen/Qwen2.5-Coder-32B-Instruct' | 'google/gemma-2-9b-it' | 'google/gemma-3-27b-it' | 'moonshotai/Kimi-K2-Instruct' | (string & {});
+interface HuggingFaceResponsesSettings {
+    metadata?: Record<string, string>;
+    instructions?: string;
+    strictJsonSchema?: boolean;
+}
+
+interface HuggingFaceProviderSettings {
+    /**
+  Hugging Face API key.
+  */
+    apiKey?: string;
+    /**
+  Base URL for the API calls.
+  */
+    baseURL?: 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.
+  */
+    fetch?: FetchFunction;
+    generateId?: () => string;
+}
+interface HuggingFaceProvider extends ProviderV3 {
+    /**
+  Creates a Hugging Face responses model for text generation.
+  */
+    (modelId: HuggingFaceResponsesModelId): LanguageModelV3;
+    /**
+  Creates a Hugging Face responses model for text generation.
+  */
+    languageModel(modelId: HuggingFaceResponsesModelId): LanguageModelV3;
+    /**
+  Creates a Hugging Face responses model for text generation.
+  */
+    responses(modelId: HuggingFaceResponsesModelId): LanguageModelV3;
+}
+/**
+Create a Hugging Face provider instance.
+ */
+declare function createHuggingFace(options?: HuggingFaceProviderSettings): HuggingFaceProvider;
+/**
+Default Hugging Face provider instance.
+ */
+declare const huggingface: HuggingFaceProvider;
+
+export { type HuggingFaceProvider, type HuggingFaceProviderSettings, type HuggingFaceResponsesModelId, type HuggingFaceResponsesSettings, createHuggingFace, huggingface };

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+import { ProviderV3, LanguageModelV3 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+export { OpenAICompatibleErrorData as HuggingFaceErrorData } from '@ai-sdk/openai-compatible';
+
+type HuggingFaceResponsesModelId = 'meta-llama/Llama-3.1-8B-Instruct' | 'meta-llama/Llama-3.1-70B-Instruct' | 'meta-llama/Llama-3.1-405B-Instruct' | 'meta-llama/Llama-3.3-70B-Instruct' | 'meta-llama/Meta-Llama-3-8B-Instruct' | 'meta-llama/Meta-Llama-3-70B-Instruct' | 'meta-llama/Llama-3.2-3B-Instruct' | 'meta-llama/Llama-4-Maverick-17B-128E-Instruct' | 'meta-llama/Llama-4-Maverick-17B-128E-Instruct-FP8' | 'meta-llama/Llama-Guard-4-12B' | 'deepseek-ai/DeepSeek-V3.1' | 'deepseek-ai/DeepSeek-V3-0324' | 'deepseek-ai/DeepSeek-R1' | 'deepseek-ai/DeepSeek-R1-0528' | 'deepseek-ai/DeepSeek-R1-Distill-Qwen-1.5B' | 'deepseek-ai/DeepSeek-R1-Distill-Qwen-7B' | 'deepseek-ai/DeepSeek-R1-Distill-Qwen-14B' | 'deepseek-ai/DeepSeek-R1-Distill-Qwen-32B' | 'deepseek-ai/DeepSeek-R1-Distill-Llama-8B' | 'deepseek-ai/DeepSeek-R1-Distill-Llama-70B' | 'deepseek-ai/DeepSeek-Prover-V2-671B' | 'Qwen/Qwen3-32B' | 'Qwen/Qwen3-14B' | 'Qwen/Qwen3-8B' | 'Qwen/Qwen3-4B' | 'Qwen/Qwen3-Coder-480B-A35B-Instruct' | 'Qwen/Qwen3-Coder-480B-A35B-Instruct-FP8' | 'Qwen/Qwen3-30B-A3B' | 'Qwen/Qwen2.5-VL-7B-Instruct' | 'Qwen/Qwen2.5-7B-Instruct' | 'Qwen/Qwen2.5-Coder-7B-Instruct' | 'Qwen/Qwen2.5-Coder-32B-Instruct' | 'google/gemma-2-9b-it' | 'google/gemma-3-27b-it' | 'moonshotai/Kimi-K2-Instruct' | (string & {});
+interface HuggingFaceResponsesSettings {
+    metadata?: Record<string, string>;
+    instructions?: string;
+    strictJsonSchema?: boolean;
+}
+
+interface HuggingFaceProviderSettings {
+    /**
+  Hugging Face API key.
+  */
+    apiKey?: string;
+    /**
+  Base URL for the API calls.
+  */
+    baseURL?: 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.
+  */
+    fetch?: FetchFunction;
+    generateId?: () => string;
+}
+interface HuggingFaceProvider extends ProviderV3 {
+    /**
+  Creates a Hugging Face responses model for text generation.
+  */
+    (modelId: HuggingFaceResponsesModelId): LanguageModelV3;
+    /**
+  Creates a Hugging Face responses model for text generation.
+  */
+    languageModel(modelId: HuggingFaceResponsesModelId): LanguageModelV3;
+    /**
+  Creates a Hugging Face responses model for text generation.
+  */
+    responses(modelId: HuggingFaceResponsesModelId): LanguageModelV3;
+}
+/**
+Create a Hugging Face provider instance.
+ */
+declare function createHuggingFace(options?: HuggingFaceProviderSettings): HuggingFaceProvider;
+/**
+Default Hugging Face provider instance.
+ */
+declare const huggingface: HuggingFaceProvider;
+
+export { type HuggingFaceProvider, type HuggingFaceProviderSettings, type HuggingFaceResponsesModelId, type HuggingFaceResponsesSettings, createHuggingFace, huggingface };