@ai-sdk/huggingface 1.0.16 → 1.0.18

package/src/responses/huggingface-responses-prepare-tools.ts

@@ -0,0 +1,91 @@
+import { LanguageModelV3CallOptions, SharedV3Warning } from '@ai-sdk/provider';
+
+export type HuggingFaceResponsesTool = {
+  type: 'function';
+  name: string;
+  description?: string;
+  parameters: unknown;
+};
+
+export type HuggingFaceResponsesToolChoice =
+  | 'auto'
+  | 'required'
+  | { type: 'function'; function: { name: string } };
+
+export function prepareResponsesTools({
+  tools,
+  toolChoice,
+}: {
+  tools: LanguageModelV3CallOptions['tools'];
+  toolChoice?: LanguageModelV3CallOptions['toolChoice'];
+}): {
+  tools?: HuggingFaceResponsesTool[];
+  toolChoice?: HuggingFaceResponsesToolChoice;
+  toolWarnings: SharedV3Warning[];
+} {
+  // when the tools array is empty, change it to undefined to prevent errors:
+  tools = tools?.length ? tools : undefined;
+
+  const toolWarnings: SharedV3Warning[] = [];
+
+  if (tools == null) {
+    return { tools: undefined, toolChoice: undefined, toolWarnings };
+  }
+
+  const huggingfaceTools: HuggingFaceResponsesTool[] = [];
+
+  for (const tool of tools) {
+    switch (tool.type) {
+      case 'function':
+        huggingfaceTools.push({
+          type: 'function',
+          name: tool.name,
+          description: tool.description,
+          parameters: tool.inputSchema,
+        });
+        break;
+      case 'provider':
+        toolWarnings.push({
+          type: 'unsupported',
+          feature: `provider-defined tool ${tool.id}`,
+        });
+        break;
+      default: {
+        const _exhaustiveCheck: never = tool;
+        throw new Error(`Unsupported tool type: ${_exhaustiveCheck}`);
+      }
+    }
+  }
+
+  // prepare tool choice:
+  let mappedToolChoice: HuggingFaceResponsesToolChoice | undefined = undefined;
+  if (toolChoice) {
+    switch (toolChoice.type) {
+      case 'auto':
+        mappedToolChoice = 'auto';
+        break;
+      case 'required':
+        mappedToolChoice = 'required';
+        break;
+      case 'none':
+        // not supported, ignore
+        break;
+      case 'tool':
+        mappedToolChoice = {
+          type: 'function',
+          function: { name: toolChoice.toolName },
+        };
+        break;
+      default: {
+        const _exhaustiveCheck: never = toolChoice;
+        throw new Error(`Unsupported tool choice type: ${_exhaustiveCheck}`);
+      }
+    }
+  }
+
+  return {
+    tools: huggingfaceTools,
+    toolChoice: mappedToolChoice,
+    toolWarnings,
+  };
+}

package/src/responses/huggingface-responses-settings.ts

@@ -0,0 +1,44 @@
+export type HuggingFaceResponsesModelId =
+  // https://router.huggingface.co/v1/models
+  | '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 & {});
+
+export interface HuggingFaceResponsesSettings {
+  metadata?: Record<string, string>;
+  instructions?: string;
+  strictJsonSchema?: boolean;
+}

package/src/responses/map-huggingface-responses-finish-reason.ts

@@ -0,0 +1,20 @@
+import { LanguageModelV3FinishReason } from '@ai-sdk/provider';
+
+export function mapHuggingFaceResponsesFinishReason(
+  finishReason: string | null | undefined,
+): LanguageModelV3FinishReason['unified'] {
+  switch (finishReason) {
+    case 'stop':
+      return 'stop';
+    case 'length':
+      return 'length';
+    case 'content_filter':
+      return 'content-filter';
+    case 'tool_calls':
+      return 'tool-calls';
+    case 'error':
+      return 'error';
+    default:
+      return 'other';
+  }
+}