@ahoo-wang/fetcher-openai 3.15.1 → 3.15.3

package/README.md

@@ -298,9 +298,14 @@ interface ChatRequest {
   // Response format
   response_format?: object; // Response format specification
 
-  // Function calling (beta)
-  tools?: any[]; // Available tools/functions
-  tool_choice?: any; // Tool selection strategy
+  // Function/Tool calling
+  // tools should be an array of tool objects: { type: "function", function: { name: string, description?: string, parameters?: object } }[]
+  // Note: The type definition uses string[] but OpenAI expects tool objects
+  tools?: string[];
+  // tool_choice supports: "auto", "none", or { type: "function", function: { name: string } }
+  tool_choice?: { [key: string]: any };
+  // Non-standard parameter (not part of OpenAI API) - likely for internal tracking
+  seen?: number;
 
   // Other OpenAI parameters
   [key: string]: any;
@@ -313,10 +318,11 @@ Represents a single message in the conversation.
 
 ```typescript
 interface Message {
-  role: 'system' | 'user' | 'assistant' | 'function';
-  content: string;
-  name?: string; // For function messages
-  function_call?: any; // For function call results
+  role: 'system' | 'user' | 'assistant' | 'tool';
+  content?: string;
+  name?: string; // For tool messages
+  tool_call_id?: string; // ID of the tool call (for tool role messages)
+  tool_calls?: Array<{ id: string; type: 'function'; function: { name: string; arguments: string } }>; // For assistant messages with tool calls
 }
 ```
 
@@ -669,7 +675,7 @@ const openai = new OpenAI({
 openai.fetcher = customFetcher;
 ```
 
-### Function Calling (Beta)
+### Function/Tool Calling
 
 ```typescript
 import { OpenAI } from '@ahoo-wang/fetcher-openai';
@@ -679,39 +685,42 @@ const openai = new OpenAI({
   apiKey: process.env.OPENAI_API_KEY!,
 });
 
-// Define available functions
-const functions = [
+// Define available tools (use 'function' type for OpenAI compatibility)
+const tools = [
   {
-    name: 'get_weather',
-    description: 'Get the current weather for a location',
-    parameters: {
-      type: 'object',
-      properties: {
-        location: {
-          type: 'string',
-          description: 'The city and state, e.g. San Francisco, CA',
+    type: 'function',
+    function: {
+      name: 'get_weather',
+      description: 'Get the current weather for a location',
+      parameters: {
+        type: 'object',
+        properties: {
+          location: {
+            type: 'string',
+            description: 'The city and state, e.g. San Francisco, CA',
+          },
         },
+        required: ['location'],
       },
-      required: ['location'],
     },
   },
 ];
 
-// Make a request with function calling
+// Make a request with tool calling
 const response = await openai.chat.completions({
   model: 'gpt-4',
   messages: [
     { role: 'user', content: "What's the weather like in San Francisco?" },
   ],
-  functions: functions,
-  function_call: 'auto', // Let the model decide when to call functions
+  tools: tools,
+  tool_choice: 'auto', // Let the model decide when to call tools
 });
 
-// Handle function calls
-if (response.choices[0].message.function_call) {
-  const functionCall = response.choices[0].message.function_call;
-  console.log('Function called:', functionCall.name);
-  console.log('Arguments:', JSON.parse(functionCall.arguments));
+// Handle tool calls
+if (response.choices[0].message.tool_calls) {
+  const toolCall = response.choices[0].message.tool_calls[0];
+  console.log('Tool called:', toolCall.function.name);
+  console.log('Arguments:', JSON.parse(toolCall.function.arguments));
 }
 ```
 

package/README.zh-CN.md

@@ -297,8 +297,13 @@ interface ChatRequest {
   response_format?: object; // 响应格式规范
 
   // 函数调用（测试版）
-  tools?: any[]; // 可用工具/函数
-  tool_choice?: any; // 工具选择策略
+  // tools 应该是工具对象数组: { type: "function", function: { name: string, description?: string, parameters?: object } }[]
+  // 注意: 类型定义使用 string[] 但 OpenAI 期望工具对象
+  tools?: string[];
+  // tool_choice 支持: "auto", "none", 或 { type: "function", function: { name: string } }
+  tool_choice?: { [key: string]: any };
+  // 非标准参数（不属于 OpenAI API）- 可能用于内部跟踪
+  seen?: number;
 
   // 其他 OpenAI 参数
   [key: string]: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-openai",
-  "version": "3.15.1",
+  "version": "3.15.3",
   "description": "Type-safe OpenAI API client for Fetcher ecosystem. Provides seamless integration with OpenAI's Chat Completions API, supporting both streaming and non-streaming responses with full TypeScript support.",
   "keywords": [
     "openai",
@@ -56,18 +56,18 @@
     "@vitest/coverage-v8": "^4.1.4",
     "@vitest/ui": "^4.1.4",
     "eslint": "^9.39.4",
-    "globals": "^17.4.0",
+    "globals": "^17.5.0",
     "prettier": "^3.8.1",
     "typescript": "^6.0.2",
-    "typescript-eslint": "^8.58.1",
+    "typescript-eslint": "^8.58.2",
     "unplugin-dts": "1.0.0-beta.6",
     "vite": "^8.0.8",
     "vite-bundle-analyzer": "^1.3.7",
     "vitest": "^4.1.4",
     "msw": "^2.13.2",
-    "@ahoo-wang/fetcher-storage": "^3.15.1",
-    "@ahoo-wang/fetcher-eventbus": "^3.15.1",
-    "@ahoo-wang/fetcher-react": "^3.15.1"
+    "@ahoo-wang/fetcher-storage": "^3.15.3",
+    "@ahoo-wang/fetcher-react": "^3.15.3",
+    "@ahoo-wang/fetcher-eventbus": "^3.15.3"
   },
   "scripts": {
     "build": "vite build",