@inductiv/node-red-openai-api 1.85.1 → 1.87.3

package/README.md

@@ -40,10 +40,34 @@ After installation, find your node in the **AI** palette category labeled "OpenA
 - **Configurable and Flexible**: Adapt to a wide range of project requirements, making it easy to integrate AI into your IoT solutions.
 - **Powerful Combinations**: Utilize Node-RED's diverse nodes to build complex, AI-driven IoT workflows with ease.
 
-## Release Notes (v1.85.1)
-
-- **Ehancement**: Upgraded the OpenAI API Library dependency from [v4.83.0](https://github.com/openai/openai-node/releases/tag/v4.83.0) to [v4.85.1](https://github.com/openai/openai-node/releases/tag/v4.85.1).
-- Project versioning now aligns with the OpenAI API Library's minor and patch version numbers for easier feature tracking and compatibility (e.g., x.85.1).
+## Release Notes (v1.87.3)
+
+- **Ehancement:** Upgraded the OpenAI API Library dependency from [v4.85.4](https://github.com/openai/openai-node/releases/tag/v4.85.4) to [v4.87.3](https://github.com/openai/openai-node/releases/tag/v4.87.3).
+- **Features:** Implemented [Responses](https://platform.openai.com/docs/api-reference/responses) API capabilities.
+  - OpenAI's most advanced interface for generating model responses.
+  - Create stateful interactions with the model, using the output of previous responses as input and more.
+  - 🔥 Native agentic web search capabilities:
+
+  ```javascript
+  msg.payload = {
+    "model": "gpt-4o-mini",
+    "tools": [{ type: "web_search_preview" }],
+    "input": "What was a positive news story from today?"
+  }
+  ```
+
+  - 🔥 Native agentic computer use capabilities.
+  - 🔥 Reasoning model control properties:
+
+  ```javascript
+  msg.payload = {
+    "model": "o3-mini",
+    "input": "How much wood would a woodchuck chuck?",
+    "reasoning": {
+      "effort": "high"
+    }
+  }
+  ```
 
 ## What's New in Version 1.x
 

package/lib.js

@@ -250,6 +250,61 @@ let OpenaiApi = (function () {
       }
     }
 
+    async getChatCompletion(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const { completion_id, ...options } = parameters.payload;
+
+      const response = await openai.chat.completions.retrieve(
+        completion_id,
+        options
+      );
+
+      return response;
+    }
+
+    async getChatMessages(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const { completion_id, ...options } = parameters.payload;
+
+      const response = await openai.chat.completions.messages.list(
+        completion_id,
+        options
+      );
+
+      return response.data;
+    }
+
+    async listChatCompletions(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const response = await openai.chat.completions.list(parameters.payload);
+
+      return response.data;
+    }
+
+    async updateChatCompletion(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const { completion_id, ...body } = parameters.payload;
+
+      const response = await openai.chat.completions.update(
+        completion_id,
+        body
+      );
+
+      return response;
+    }
+
+    async deleteChatCompletion(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const { completion_id, ...options } = parameters.payload;
+
+      const response = await openai.chat.completions.del(
+        completion_id,
+        options
+      );
+
+      return response;
+    }
+
     async createImage(parameters) {
       const openai = new OpenAI(this.clientParams);
       const response = await openai.images.generate(parameters.payload);
@@ -440,6 +495,59 @@ let OpenaiApi = (function () {
       return response;
     }
 
+    // >>> Begin Responses functions
+    async createModelResponse(parameters) {
+      const { _node, ...params } = parameters;
+      const openai = new OpenAI(this.clientParams);
+      const response = await openai.responses.create(parameters.payload);
+
+      if (params.payload.stream) {
+        _node.status({
+          fill: "green",
+          shape: "dot",
+          text: "OpenaiApi.status.streaming",
+        });
+        for await (const chunk of response) {
+          if (typeof chunk === "object") {
+            const newMsg = { ...parameters.msg, payload: chunk };
+            _node.send(newMsg);
+          }
+        }
+        _node.status({});
+      } else {
+        return response;
+      }
+    }
+
+    async getModelResponse(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const { response_id, ...params } = parameters.payload;
+      const response = await openai.responses.retrieve(
+        response_id,
+        params
+      );
+
+      return response;
+    }
+
+    async deleteModelResponse(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const { response_id, ...params } = parameters.payload;
+      const response = await openai.responses.del(response_id, params);
+
+      return response;
+    }
+
+    async listInputItems(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const { response_id, ...params } = parameters.payload;
+      const list = await openai.responses.inputItems.list(response_id, params);
+
+      return [...list.data];
+    }
+
+    // <<< End Responses functions
+
     async createModeration(parameters) {
       const openai = new OpenAI(this.clientParams);
       const response = await openai.moderations.create(parameters.payload);

package/locales/de-DE/node.json

@@ -35,6 +35,11 @@
             "cancelBatch": "cancel batch",
             "listBatch": "list batch",
             "createChatCompletion": "create chat completion",
+            "getChatCompletion": "get chat completion",
+            "getChatMessages": "get chat messages",
+            "listChatCompletions": "list chat completions",
+            "updateChatCompletion": "update chat completion",
+            "deleteChatCompletion": "delete chat completion",
             "body": "body",
             "request_body": "Request Body",
             "data": "data",

package/locales/en-US/node.json

@@ -35,6 +35,11 @@
             "cancelBatch": "cancel batch",
             "listBatch": "list batch",
             "createChatCompletion": "create chat completion",
+            "getChatCompletion": "get chat completion",
+            "getChatMessages": "get chat messages",
+            "listChatCompletions": "list chat completions",
+            "updateChatCompletion": "update chat completion",
+            "deleteChatCompletion": "delete chat completion",
             "body": "body",
             "request_body": "Request Body",
             "data": "data",
@@ -94,6 +99,10 @@
             "retrieveModel": "retrieve model",
             "deleteModel": "delete fine-tune model",
             "createModeration": "create moderation",
+            "createModelResponse": "create model response",
+            "getModelResponse": "retrieve model response",
+            "deleteModelResponse": "delete model response",
+            "listInputItems": "list input items",
             "listAssistants": "list assistants",
             "order": "order",
             "before": "before",

package/locales/ja/node.json

@@ -35,6 +35,11 @@
             "cancelBatch": "cancel batch",
             "listBatch": "list batch",
             "createChatCompletion": "create chat completion",
+            "getChatCompletion": "get chat completion",
+            "getChatMessages": "get chat messages",
+            "listChatCompletions": "list chat completions",
+            "updateChatCompletion": "update chat completion",
+            "deleteChatCompletion": "delete chat completion",
             "body": "body",
             "request_body": "Request Body",
             "data": "data",

package/locales/zh-CN/node.json

@@ -35,6 +35,11 @@
             "cancelBatch": "cancel batch",
             "listBatch": "list batch",
             "createChatCompletion": "create chat completion",
+            "getChatCompletion": "get chat completion",
+            "getChatMessages": "get chat messages",
+            "listChatCompletions": "list chat completions",
+            "updateChatCompletion": "update chat completion",
+            "deleteChatCompletion": "delete chat completion",
             "body": "body",
             "request_body": "Request Body",
             "data": "data",
@@ -112,9 +117,9 @@
             "getMessage": "retrieve message",
             "message_id": "message id",
             "modifyMessage": "modify message",
-            "createSession": "create session",
             "createUpload": "create upload",
             "addUploadPart": "add upload part",
+            "completeUpload": "complete upload",
             "cancelUpload": "cancel upload",
             "createThreadAndRun": "create thread and run",
             "listRuns": "list runs",