@aihubmix/ai-sdk-provider 0.0.2 → 0.0.4

package/README.zh.md

@@ -0,0 +1,301 @@
+# AI SDK - Aihubmix Provider
+
+<div align="center">
+  <a href="README.md">🇺🇸 English</a> | 
+  <a href="README.zh.md">🇨🇳 中文</a> | 
+  <a href="README.ja.md">🇯🇵 日本語</a>
+</div>
+
+> **🎉 10% 折扣！**
+已内置app-code，使用此方式请求所有模型可享受 10% 折扣。
+
+**[Aihubmix 官方网站](https://aihubmix.com/)** | **[模型广场](https://aihubmix.com/models)**
+
+**[Aihubmix provider](https://v5.ai-sdk.dev/providers/community-providers/aihubmix)** 适用于 [AI SDK](https://ai-sdk.dev/docs)
+一个网关，无限模型；一站式请求：OpenAI、Claude、Gemini、DeepSeek、Qwen 以及超过 500 个 AI 模型。
+
+## 支持的功能
+
+Aihubmix provider 支持以下 AI 功能：
+
+- **文本生成**：使用各种模型进行聊天完成
+- **流式文本**：实时文本流式传输
+- **图像生成**：从文本提示创建图像
+- **嵌入**：单个和批量文本嵌入
+- **对象生成**：使用模式的结构化数据生成
+- **流式对象**：实时结构化数据流式传输
+- **语音合成**：文本转语音转换
+- **转录**：语音转文本转换
+- **工具**：网络搜索和其他工具
+
+## 安装
+
+Aihubmix 在 `@aihubmix/ai-sdk-provider` 模块中可用。您可以通过 [@aihubmix/ai-sdk-provider](https://www.npmjs.com/package/@aihubmix/ai-sdk-provider) 安装它
+
+```bash
+npm i @aihubmix/ai-sdk-provider
+```
+
+## Provider 实例
+
+您可以从 `@aihubmix/ai-sdk-provider` 导入默认的 provider 实例 `aihubmix`：
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+```
+
+## 配置
+
+将您的 Aihubmix API 密钥设置为环境变量：
+
+```bash
+export AIHUBMIX_API_KEY="your-api-key-here"
+```
+
+或直接传递给 provider：
+
+```ts
+import { createAihubmix } from '@aihubmix/ai-sdk-provider';
+
+const aihubmix = createAihubmix({
+  apiKey: 'your-api-key-here',
+});
+```
+
+## 使用
+
+首先，导入必要的函数：
+
+```ts
+import { createAihubmix } from '@aihubmix/ai-sdk-provider';
+import { 
+  generateText, 
+  streamText, 
+  generateImage, 
+  embed, 
+  embedMany, 
+  generateObject, 
+  streamObject, 
+  generateSpeech, 
+  transcribe 
+} from 'ai';
+import { z } from 'zod';
+```
+
+### 生成文本
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: aihubmix('o4-mini'),
+  prompt: '为4个人写一个素食千层面食谱。',
+});
+```
+
+### Claude 模型
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: aihubmix('claude-3-7-sonnet-20250219'),
+  prompt: '用简单的术语解释量子计算。',
+});
+```
+
+### Gemini 模型
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: aihubmix('gemini-2.5-flash'),
+  prompt: '创建一个Python脚本来对数字列表进行排序。',
+});
+```
+
+### 图像生成
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { generateImage } from 'ai';
+
+const { image } = await generateImage({
+  model: aihubmix.image('gpt-image-1'),
+  prompt: '山间美丽的日落',
+});
+```
+
+### 嵌入
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { embed } from 'ai';
+
+const { embedding } = await embed({
+  model: aihubmix.embedding('text-embedding-ada-002'),
+  value: '你好，世界！',
+});
+```
+
+### 转录
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { transcribe } from 'ai';
+
+const { text } = await transcribe({
+  model: aihubmix.transcription('whisper-1'),
+  audio: audioFile,
+});
+```
+
+### 流式文本
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { streamText } from 'ai';
+
+const result = streamText({
+  model: aihubmix('gpt-3.5-turbo'),
+  prompt: '写一个关于机器人学习绘画的短故事。',
+  maxOutputTokens: 256,
+  temperature: 0.3,
+  maxRetries: 3,
+});
+
+let fullText = '';
+for await (const textPart of result.textStream) {
+  fullText += textPart;
+  process.stdout.write(textPart);
+}
+
+console.log('\n使用情况:', await result.usage);
+console.log('完成原因:', await result.finishReason);
+```
+
+### 生成对象
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { generateObject } from 'ai';
+import { z } from 'zod';
+
+const result = await generateObject({
+  model: aihubmix('gpt-4o-mini'),
+  schema: z.object({
+    recipe: z.object({
+      name: z.string(),
+      ingredients: z.array(
+        z.object({
+          name: z.string(),
+          amount: z.string(),
+        }),
+      ),
+      steps: z.array(z.string()),
+    }),
+  }),
+  prompt: '生成一个千层面食谱。',
+});
+
+console.log(JSON.stringify(result.object.recipe, null, 2));
+console.log('Token使用情况:', result.usage);
+console.log('完成原因:', result.finishReason);
+```
+
+### 流式对象
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { streamObject } from 'ai';
+import { z } from 'zod';
+
+const result = await streamObject({
+  model: aihubmix('gpt-4o-mini'),
+  schema: z.object({
+    recipe: z.object({
+      name: z.string(),
+      ingredients: z.array(
+        z.object({
+          name: z.string(),
+          amount: z.string(),
+        }),
+      ),
+      steps: z.array(z.string()),
+    }),
+  }),
+  prompt: '生成一个千层面食谱。',
+});
+
+for await (const objectPart of result.partialObjectStream) {
+  console.log(objectPart);
+}
+
+console.log('Token使用情况:', result.usage);
+console.log('最终对象:', result.object);
+```
+
+### 批量嵌入
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { embedMany } from 'ai';
+
+const { embeddings, usage } = await embedMany({
+  model: aihubmix.embedding('text-embedding-3-small'),
+  values: [
+    '海滩上的晴天',
+    '城市里的雨天下午',
+    '山间的雪夜',
+  ],
+});
+
+console.log('嵌入向量:', embeddings);
+console.log('使用情况:', usage);
+```
+
+### 语音合成
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { generateSpeech } from 'ai';
+
+const { audio } = await generateSpeech({
+  model: aihubmix.speech('tts-1'),
+  text: '你好，这是语音合成的测试。',
+});
+
+// 保存音频文件
+await saveAudioFile(audio);
+console.log('音频生成成功:', audio);
+```
+
+### 工具
+
+Aihubmix provider 支持各种工具，包括网络搜索：
+
+```ts
+import { aihubmix } from '@aihubmix/ai-sdk-provider';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: aihubmix('gpt-4'),
+  prompt: 'AI的最新发展是什么？',
+  tools: {
+    webSearchPreview: aihubmix.tools.webSearchPreview({
+      searchContextSize: 'high',
+    }),
+  },
+});
+```
+
+## 附加资源
+
+- [Aihubmix Provider 仓库](https://github.com/inferera/aihubmix)
+- [Aihubmix 文档](https://docs.aihubmix.com/en)
+- [Aihubmix 控制台](https://aihubmix.com)
+- [Aihubmix 商务合作](mailto:business@aihubmix.com) 

package/dist/index.d.mts

@@ -1,26 +1,202 @@
 import { ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV2, SpeechModelV2 } from '@ai-sdk/provider';
+import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
-import { z } from 'zod';
 import { OpenAIProviderSettings } from '@ai-sdk/openai';
 
-declare const WebSearchPreviewParameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-declare function webSearchPreviewTool({ searchContextSize, userLocation, }?: {
-    searchContextSize?: 'low' | 'medium' | 'high';
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    /**
+     * Filters for the search.
+     */
+    filters?: {
+        /**
+         * Allowed domains for the search.
+         * If not provided, all domains are allowed.
+         * Subdomains of the provided domains are allowed as well.
+         */
+        allowedDomains?: string[];
+    };
+    /**
+     * Search context size to use for the web search.
+     * - high: Most comprehensive context, highest cost, slower response
+     * - medium: Balanced context, cost, and latency (default)
+     * - low: Least context, lowest cost, fastest response
+     */
+    searchContextSize?: "low" | "medium" | "high";
+    /**
+     * User location information to provide geographically relevant search results.
+     */
     userLocation?: {
-        type?: 'approximate';
+        /**
+         * Type of location (always 'approximate')
+         */
+        type: "approximate";
+        /**
+         * Two-letter ISO country code (e.g., 'US', 'GB')
+         */
+        country?: string;
+        /**
+         * City name (free text, e.g., 'Minneapolis')
+         */
         city?: string;
+        /**
+         * Region name (free text, e.g., 'Minnesota')
+         */
         region?: string;
-        country?: string;
+        /**
+         * IANA timezone (e.g., 'America/Chicago')
+         */
         timezone?: string;
     };
-}): {
-    type: 'provider-defined';
-    id: 'aihubmix.web_search_preview';
-    args: {};
-    parameters: typeof WebSearchPreviewParameters;
+}>;
+
+/**
+ * A filter used to compare a specified attribute key to a given value using a defined comparison operation.
+ */
+type OpenAIResponsesFileSearchToolComparisonFilter = {
+    /**
+     * The key to compare against the value.
+     */
+    key: string;
+    /**
+     * Specifies the comparison operator: eq, ne, gt, gte, lt, lte.
+     */
+    type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
+    /**
+     * The value to compare against the attribute key; supports string, number, or boolean types.
+     */
+    value: string | number | boolean;
+};
+/**
+ * Combine multiple filters using and or or.
+ */
+type OpenAIResponsesFileSearchToolCompoundFilter = {
+    /**
+     * Type of operation: and or or.
+     */
+    type: 'and' | 'or';
+    /**
+     * Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
+     */
+    filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>;
 };
+
 declare const aihubmixTools: {
-    webSearchPreview: typeof webSearchPreviewTool;
+    /**
+     * The Code Interpreter tool allows models to write and run Python code in a
+     * sandboxed environment to solve complex problems in domains like data analysis,
+     * coding, and math.
+     *
+     * @param container - The container to use for the code interpreter.
+     *
+     * Must have name `code_interpreter`.
+     */
+    codeInterpreter: (args?: {
+        container?: string | {
+            fileIds?: string[];
+        };
+    }) => _ai_sdk_provider_utils.Tool<{
+        code?: string | null;
+        containerId: string;
+    }, {
+        outputs?: Array<{
+            type: "logs";
+            logs: string;
+        } | {
+            type: "image";
+            url: string;
+        }> | null;
+    }>;
+    /**
+     * File search is a tool available in the Responses API. It enables models to
+     * retrieve information in a knowledge base of previously uploaded files through
+     * semantic and keyword search.
+     *
+     * Must have name `file_search`.
+     *
+     * @param vectorStoreIds - The vector store IDs to use for the file search.
+     * @param maxNumResults - The maximum number of results to return.
+     * @param ranking - The ranking options to use for the file search.
+     * @param filters - The filters to use for the file search.
+     */
+    fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+        queries: string[];
+        results: null | {
+            attributes: Record<string, unknown>;
+            fileId: string;
+            filename: string;
+            score: number;
+            text: string;
+        }[];
+    }, {
+        vectorStoreIds: string[];
+        maxNumResults?: number;
+        ranking?: {
+            ranker?: string;
+            scoreThreshold?: number;
+        };
+        filters?: OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter;
+    }>;
+    /**
+     * The image generation tool allows you to generate images using a text prompt,
+     * and optionally image inputs. It leverages the GPT Image model,
+     * and automatically optimizes text inputs for improved performance.
+     *
+     * Must have name `image_generation`.
+     *
+     * @param size - Image dimensions (e.g., 1024x1024, 1024x1536)
+     * @param quality - Rendering quality (e.g. low, medium, high)
+     * @param format - File output format
+     * @param compression - Compression level (0-100%) for JPEG and WebP formats
+     * @param background - Transparent or opaque
+     */
+    imageGeneration: (args?: {
+        background?: "auto" | "opaque" | "transparent";
+        inputFidelity?: "low" | "high";
+        inputImageMask?: {
+            fileId?: string;
+            imageUrl?: string;
+        };
+        model?: string;
+        moderation?: "auto";
+        outputCompression?: number;
+        outputFormat?: "png" | "jpeg" | "webp";
+        quality?: "auto" | "low" | "medium" | "high";
+        size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024";
+    }) => _ai_sdk_provider_utils.Tool<{}, {
+        result: string;
+    }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search_preview`.
+     *
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     *
+     * @deprecated Use `webSearch` instead.
+     */
+    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+        searchContextSize?: "low" | "medium" | "high";
+        userLocation?: {
+            type: "approximate";
+            country?: string;
+            city?: string;
+            region?: string;
+            timezone?: string;
+        };
+    }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search`.
+     *
+     * @param filters - The filters to use for the web search.
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     */
+    webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
 };
 
 interface AihubmixProvider extends ProviderV2 {