viho-llm 0.1.8 → 0.2.0

package/README.md

@@ -101,12 +101,13 @@ const openai = OpenAIAPI({
   baseURL: 'https://api.openai.com/v1', // or your custom endpoint
 });
 
-// Send a chat message
+// Send a chat message (using native OpenAI API format)
 const response = await openai.chat({
-  modelID: 'gpt-4o',
-  modelThinking: 'enabled', // 'enabled' or 'disabled' for reasoning models
-  systemPrompt: 'You are a helpful assistant.',
-  userPrompt: 'Hello, how are you?',
+  model: 'gpt-4o',
+  messages: [
+    { role: 'system', content: 'You are a helpful assistant.' },
+    { role: 'user', content: 'Hello, how are you?' },
+  ],
 });
 
 console.log(response);
@@ -157,10 +158,14 @@ OpenAI streaming supports thinking/reasoning content for compatible models:
 // Send a chat message with streaming (supports thinking mode)
 await openai.chatWithStreaming(
   {
-    modelID: 'deepseek-reasoner',
-    modelThinking: 'enabled',
-    systemPrompt: 'You are a helpful assistant.',
-    userPrompt: 'Explain how neural networks work',
+    model: 'deepseek-reasoner',
+    messages: [
+      { role: 'system', content: 'You are a helpful assistant.' },
+      { role: 'user', content: 'Explain how neural networks work' },
+    ],
+    thinking: {
+      type: 'enabled', // Enable reasoning mode
+    },
   },
   {
     beginCallback: () => {
@@ -428,11 +433,14 @@ Sends a chat request to the OpenAI API.
 
 **Parameters:**
 
-- `chatOptions` (Object) **required** - Chat configuration
-  - `modelID` (string) **required** - Model identifier (e.g., 'gpt-4o', 'deepseek-reasoner')
-  - `modelThinking` (string) **required** - Thinking mode: 'enabled' or 'disabled'
-  - `systemPrompt` (string) **required** - System instruction/context for the model
-  - `userPrompt` (string) **required** - User's message/question
+- `chatOptions` (Object) **required** - Native OpenAI API chat completion options
+  - `model` (string) **required** - Model identifier (e.g., 'gpt-4o', 'deepseek-reasoner')
+  - `messages` (Array) **required** - Array of message objects
+    - `role` (string) - 'system', 'user', or 'assistant'
+    - `content` (string) - Message content
+  - `thinking` (Object) - Optional thinking/reasoning configuration
+    - `type` (string) - 'enabled' or 'disabled'
+  - ...other OpenAI API parameters
 
 **Returns:**
 
@@ -442,10 +450,11 @@ Sends a chat request to the OpenAI API.
 
 ```javascript
 const response = await openai.chat({
-  modelID: 'gpt-4o',
-  modelThinking: 'disabled',
-  systemPrompt: 'You are a helpful coding assistant.',
-  userPrompt: 'Write a Python function to reverse a string',
+  model: 'gpt-4o',
+  messages: [
+    { role: 'system', content: 'You are a helpful coding assistant.' },
+    { role: 'user', content: 'Write a Python function to reverse a string' },
+  ],
 });
 console.log(response.content);
 ```
@@ -456,11 +465,14 @@ Sends a chat request to the OpenAI API with streaming response and thinking supp
 
 **Parameters:**
 
-- `chatOptions` (Object) **required** - Chat configuration
-  - `modelID` (string) **required** - Model identifier (e.g., 'gpt-4o', 'deepseek-reasoner')
-  - `modelThinking` (string) **required** - Thinking mode: 'enabled' or 'disabled'
-  - `systemPrompt` (string) **required** - System instruction/context for the model
-  - `userPrompt` (string) **required** - User's message/question
+- `chatOptions` (Object) **required** - Native OpenAI API chat completion options
+  - `model` (string) **required** - Model identifier (e.g., 'gpt-4o', 'deepseek-reasoner')
+  - `messages` (Array) **required** - Array of message objects
+    - `role` (string) - 'system', 'user', or 'assistant'
+    - `content` (string) - Message content
+  - `thinking` (Object) - Optional thinking/reasoning configuration
+    - `type` (string) - 'enabled' or 'disabled'
+  - ...other OpenAI API parameters (note: `stream` will be automatically set to `true`)
 
 - `callbackOptions` (Object) **required** - Callback functions for handling stream events
   - `beginCallback` (Function) - Called when the stream begins
@@ -483,10 +495,14 @@ Sends a chat request to the OpenAI API with streaming response and thinking supp
 ```javascript
 await openai.chatWithStreaming(
   {
-    modelID: 'deepseek-reasoner',
-    modelThinking: 'enabled',
-    systemPrompt: 'You are a math tutor.',
-    userPrompt: 'Solve: What is 15% of 240?',
+    model: 'deepseek-reasoner',
+    messages: [
+      { role: 'system', content: 'You are a math tutor.' },
+      { role: 'user', content: 'Solve: What is 15% of 240?' },
+    ],
+    thinking: {
+      type: 'enabled',
+    },
   },
   {
     thinkingCallback: (thinking) => {

package/index.js

@@ -370,10 +370,10 @@ const logger$1 = qiao_log_js.Logger('openai-util.js');
 /**
  * chat
  * @param {*} client
- * @param {*} options
+ * @param {*} chatOptions
  * @returns
  */
-const chat = async (client, options) => {
+const chat = async (client, chatOptions) => {
   const methodName = 'chat';
 
   // check
@@ -381,39 +381,11 @@ const chat = async (client, options) => {
     logger$1.error(methodName, 'need client');
     return;
   }
-  if (!options) {
-    logger$1.error(methodName, 'need options');
-    return;
-  }
-  if (!options.modelID) {
-    logger$1.error(methodName, 'need options.modelID');
-    return;
-  }
-  if (!options.modelThinking) {
-    logger$1.error(methodName, 'need options.modelThinking');
-    return;
-  }
-  if (!options.systemPrompt) {
-    logger$1.error(methodName, 'need options.systemPrompt');
-    return;
-  }
-  if (!options.userPrompt) {
-    logger$1.error(methodName, 'need options.userPrompt');
+  if (!chatOptions) {
+    logger$1.error(methodName, 'need chatOptions');
     return;
   }
 
-  // chat
-  const chatOptions = {
-    model: options.modelID,
-    messages: [
-      { role: 'system', content: options.systemPrompt },
-      { role: 'user', content: options.userPrompt },
-    ],
-    thinking: {
-      type: options.modelThinking,
-    },
-  };
-
   // go
   try {
     const completion = await client.chat.completions.create(chatOptions);
@@ -426,11 +398,11 @@ const chat = async (client, options) => {
 /**
  * chatWithStreaming
  * @param {*} client
- * @param {*} options
+ * @param {*} chatOptions
  * @param {*} callbackOptions
  * @returns
  */
-const chatWithStreaming = async (client, options, callbackOptions) => {
+const chatWithStreaming = async (client, chatOptions, callbackOptions) => {
   const methodName = 'chatWithStreaming';
 
   // check
@@ -438,24 +410,8 @@ const chatWithStreaming = async (client, options, callbackOptions) => {
     logger$1.error(methodName, 'need client');
     return;
   }
-  if (!options) {
-    logger$1.error(methodName, 'need options');
-    return;
-  }
-  if (!options.modelID) {
-    logger$1.error(methodName, 'need options.modelID');
-    return;
-  }
-  if (!options.modelThinking) {
-    logger$1.error(methodName, 'need options.modelThinking');
-    return;
-  }
-  if (!options.systemPrompt) {
-    logger$1.error(methodName, 'need options.systemPrompt');
-    return;
-  }
-  if (!options.userPrompt) {
-    logger$1.error(methodName, 'need options.userPrompt');
+  if (!chatOptions) {
+    logger$1.error(methodName, 'need chatOptions');
     return;
   }
   if (!callbackOptions) {
@@ -472,18 +428,6 @@ const chatWithStreaming = async (client, options, callbackOptions) => {
   const contentCallback = callbackOptions.contentCallback;
   const firstContentCallback = callbackOptions.firstContentCallback;
 
-  // chat
-  const chatOptions = {
-    model: options.modelID,
-    messages: [
-      { role: 'system', content: options.systemPrompt },
-      { role: 'user', content: options.userPrompt },
-    ],
-    thinking: {
-      type: options.modelThinking,
-    },
-  };
-
   // go
   try {
     chatOptions.stream = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "viho-llm",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "description": "Utility library for working with multiple LLM providers (Google Gemini and OpenAI), providing common tools and helpers for AI interactions",
   "keywords": [
     "llm",
@@ -68,5 +68,5 @@
       }
     }
   },
-  "gitHead": "7d413880dd77b08d2f09ebff758510a357f0f095"
+  "gitHead": "38f9238d5c59fe322424ee30e32037b44f6be7d8"
 }

package/src/models/openai-util.js

@@ -5,10 +5,10 @@ const logger = Logger('openai-util.js');
 /**
  * chat
  * @param {*} client
- * @param {*} options
+ * @param {*} chatOptions
  * @returns
  */
-export const chat = async (client, options) => {
+export const chat = async (client, chatOptions) => {
   const methodName = 'chat';
 
   // check
@@ -16,38 +16,10 @@ export const chat = async (client, options) => {
     logger.error(methodName, 'need client');
     return;
   }
-  if (!options) {
-    logger.error(methodName, 'need options');
+  if (!chatOptions) {
+    logger.error(methodName, 'need chatOptions');
     return;
   }
-  if (!options.modelID) {
-    logger.error(methodName, 'need options.modelID');
-    return;
-  }
-  if (!options.modelThinking) {
-    logger.error(methodName, 'need options.modelThinking');
-    return;
-  }
-  if (!options.systemPrompt) {
-    logger.error(methodName, 'need options.systemPrompt');
-    return;
-  }
-  if (!options.userPrompt) {
-    logger.error(methodName, 'need options.userPrompt');
-    return;
-  }
-
-  // chat
-  const chatOptions = {
-    model: options.modelID,
-    messages: [
-      { role: 'system', content: options.systemPrompt },
-      { role: 'user', content: options.userPrompt },
-    ],
-    thinking: {
-      type: options.modelThinking,
-    },
-  };
 
   // go
   try {
@@ -61,11 +33,11 @@ export const chat = async (client, options) => {
 /**
  * chatWithStreaming
  * @param {*} client
- * @param {*} options
+ * @param {*} chatOptions
  * @param {*} callbackOptions
  * @returns
  */
-export const chatWithStreaming = async (client, options, callbackOptions) => {
+export const chatWithStreaming = async (client, chatOptions, callbackOptions) => {
   const methodName = 'chatWithStreaming';
 
   // check
@@ -73,24 +45,8 @@ export const chatWithStreaming = async (client, options, callbackOptions) => {
     logger.error(methodName, 'need client');
     return;
   }
-  if (!options) {
-    logger.error(methodName, 'need options');
-    return;
-  }
-  if (!options.modelID) {
-    logger.error(methodName, 'need options.modelID');
-    return;
-  }
-  if (!options.modelThinking) {
-    logger.error(methodName, 'need options.modelThinking');
-    return;
-  }
-  if (!options.systemPrompt) {
-    logger.error(methodName, 'need options.systemPrompt');
-    return;
-  }
-  if (!options.userPrompt) {
-    logger.error(methodName, 'need options.userPrompt');
+  if (!chatOptions) {
+    logger.error(methodName, 'need chatOptions');
     return;
   }
   if (!callbackOptions) {
@@ -107,18 +63,6 @@ export const chatWithStreaming = async (client, options, callbackOptions) => {
   const contentCallback = callbackOptions.contentCallback;
   const firstContentCallback = callbackOptions.firstContentCallback;
 
-  // chat
-  const chatOptions = {
-    model: options.modelID,
-    messages: [
-      { role: 'system', content: options.systemPrompt },
-      { role: 'user', content: options.userPrompt },
-    ],
-    thinking: {
-      type: options.modelThinking,
-    },
-  };
-
   // go
   try {
     chatOptions.stream = true;