npm - @inductiv/node-red-openai-api - Versions diffs - 1.85.4 → 1.89.0 - Mend

@inductiv/node-red-openai-api 1.85.4 → 1.89.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/README.md CHANGED Viewed

@@ -40,10 +40,13 @@ 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.4)
+## Release Notes (v1.89.0)
-- **Ehancement:** Upgraded the OpenAI API Library dependency from [v4.85.1](https://github.com/openai/openai-node/releases/tag/v4.85.1) to [v4.85.4](https://github.com/openai/openai-node/releases/tag/v4.85.4).
-- **Enhancement:** Implemented [Chat Completion storage methods](https://platform.openai.com/docs/api-reference/chat).
+- **Ehancements:**
+  - Upgraded the OpenAI API Library dependency from [v4.87.3](https://github.com/openai/openai-node/releases/tag/v4.87.3) to [v4.89.0](https://github.com/openai/openai-node/releases/tag/v4.89.0)
+- **Features:**
+  - New audio helpers
+  - New API models for TTS, STT, + new audio features for Realtime
 ## What's New in Version 1.x

package/lib.js CHANGED Viewed

@@ -254,7 +254,10 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(this.clientParams);
       const { completion_id, ...options } = parameters.payload;
-      const response = await openai.chat.completions.retrieve(completion_id, options);
+      const response = await openai.chat.completions.retrieve(
+        completion_id,
+        options
+      );
       return response;
     }
@@ -263,7 +266,10 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(this.clientParams);
       const { completion_id, ...options } = parameters.payload;
-      const response = await openai.chat.completions.messages.list(completion_id, options);
+      const response = await openai.chat.completions.messages.list(
+        completion_id,
+        options
+      );
       return response.data;
     }
@@ -279,7 +285,10 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(this.clientParams);
       const { completion_id, ...body } = parameters.payload;
-      const response = await openai.chat.completions.update(completion_id, body);
+      const response = await openai.chat.completions.update(
+        completion_id,
+        body
+      );
       return response;
     }
@@ -288,7 +297,10 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(this.clientParams);
       const { completion_id, ...options } = parameters.payload;
-      const response = await openai.chat.completions.del(completion_id, options);
+      const response = await openai.chat.completions.del(
+        completion_id,
+        options
+      );
       return response;
     }
@@ -483,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/en-US/node.json CHANGED Viewed

@@ -99,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/node.html CHANGED Viewed

@@ -153,7 +153,7 @@
         ></option>
       </optgroup>
-      <optgroup style="font-style: normal;" label="🗨️ Chat">
+      <optgroup style="font-style: normal;" label="💬 Chat">
         <option
           value="createChatCompletion"
           data-i18n="OpenaiApi.parameters.createChatCompletion"
@@ -289,7 +289,28 @@
           data-i18n="OpenaiApi.parameters.createModeration"
         ></option>
       </optgroup>
+      <optgroup style="font-style: normal;" label="🗨️ Responses">
+        <option
+          value="createModelResponse"
+          data-i18n="OpenaiApi.parameters.createModelResponse"
+        ></option>
+        <option
+        value="getModelResponse"
+        data-i18n="OpenaiApi.parameters.getModelResponse"
+        ></option>
+        <option
+        value="deleteModelResponse"
+        data-i18n="OpenaiApi.parameters.deleteModelResponse"
+        ></option>
+        <option
+        value="listInputItems"
+        data-i18n="OpenaiApi.parameters.listInputItems"
+        ></option>
+      </optgroup>
       <optgroup style="font-style: normal;" label="🔄 Runs (Beta)">
         <option
           value="createThreadAndRun"
@@ -928,25 +949,27 @@
         <h4>msg.payload Properties</h4>
         <dt>
-          model
+          input
           <a
-            href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-model"
+            href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-input"
             target="_blank"
             ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
           ></a>
           <span class="property-type">string</span>
         </dt>
-        <dd>One of the available TTS models: tts-1 or tts-1-hd</dd>
+        <dd>The text to generate audio for.</dd>
         <dt>
-          input
+          model
           <a
-            href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-input"
+            href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-model"
             target="_blank"
             ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
           ></a>
           <span class="property-type">string</span>
         </dt>
-        <dd>The text to generate audio for.</dd>
+        <dd>One of the available TTS models: <code>tts-1</code>, <code>tts-1-hd</code> or <code>gpt-4o-mini-tts</code>.</dd>
         <dt>
           voice
           <a
@@ -957,9 +980,22 @@
           <span class="property-type">string</span>
         </dt>
         <dd>
-          The voice to use when generating the audio. Supported voices are alloy,
-          echo, fable, onyx, nova, and shimmer.
+          The voice to use when generating the audio. Supported voices are <code>alloy</code>, <code>ash</code>, <code>coral</code>, <code>echo</code>, <code>fable</code>, <code>onyx</code>, <code>nova</code>, <code>sage</code> and <code>shimmer</code>.
+        </dd>
+        <dt class="optional">
+          instructions
+          <a
+            href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-instructions"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">string</span>
+        </dt>
+        <dd>
+          Control the voice of your generated audio with additional instructions. Does not work with <code>tts-1</code> or <code>tts-1-hd</code>.
         </dd>
         <dt class="optional">
           response_format
           <a
@@ -972,6 +1008,7 @@
         <dd>
           The format to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm.
         </dd>
         <dt class="optional">
           speed
           <a
@@ -1269,7 +1306,7 @@
   <section>
     <details>
-      <summary style="font-weight: bold;">🗨️ Chat</summary>
+      <summary style="font-weight: bold;">💬 Chat</summary>
       <a
         href="https://platform.openai.com/docs/api-reference/chat"
         target="_blank"
@@ -2914,6 +2951,333 @@
     </details>
   </section>
+  <!-- End Moderations docs -->
+  <!-- Begin Responses docs -->
+  <section>
+    <details>
+          <summary style="font-weight: bold;">🗨️ Responses</summary>
+          <a
+            href="https://platform.openai.com/docs/api-reference/responses"
+            target="_blank"
+            >Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <h4 style="font-weight: bolder;"> ⋙ Create Model Response</h4>
+          <p>Creates a model response.</p>
+          <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+              input
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-input"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string | array</span>
+            </dt>
+            <dd>Text, image, or file inputs to the model, used to generate a response.</dd>
+            <dt>
+              model
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-model"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>Model ID used to generate the response.</dd>
+            <dt class="optional">
+              include
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-include"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">array</span>
+            </dt>
+            <dd>Specify additional output data to include in the model response.</dd>
+            <dt class="optional">
+              instructions
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-instructions"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>Inserts a system (or developer) message as the first item in the model's context.</dd>
+            <dt class="optional">
+              max_output_tokens
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-max_output_tokens"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">integer</span>
+            </dt>
+            <dd>An upper bound for the number of tokens that can be generated for a response.</dd>
+            <dt class="optional">
+              metadata
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-metadata"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">object</span>
+            </dt>
+            <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
+            <dt class="optional">
+              parallel_tool_calls
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-parallel_tool_calls"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">boolean</span>
+            </dt>
+            <dd>Whether to allow the model to run tool calls in parallel.</dd>
+            <dt class="optional">
+              parallel_tool_calls
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-parallel_tool_calls"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">boolean</span>
+            </dt>
+            <dd>Whether to allow the model to run tool calls in parallel.</dd>
+            <dt class="optional">
+              previous_response_id
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-previous_response_id"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>The unique ID of the previous response to the model.</dd>
+            <dt class="optional">
+              reasoning
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-reasoning"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">object</span>
+            </dt>
+            <dd>o-series models only. See official docs for option properties.</dd>
+            <dt class="optional">
+              store
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-store"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">boolean</span>
+            </dt>
+            <dd>Whether to store the generated model response for later retrieval via API.</dd>
+            <dt class="optional">
+              stream
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-stream"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">boolean</span>
+            </dt>
+            <dd>If set to true, the model response data will be streamed to the client as it is generated using server-sent events.</dd>
+            <dt class="optional">
+              temperature
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-temperature"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">number</span>
+            </dt>
+            <dd>What sampling temperature to use, between 0 and 2.</dd>
+            <dt class="optional">
+              text
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-text"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">object</span>
+            </dt>
+            <dd>Configuration options for a text response from the model.</dd>
+            <dt class="optional">
+              tool_choice
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-tool_choice"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string or object</span>
+            </dt>
+            <dd>How the model should select which tool (or tools) to use when generating a response.</dd>
+            <dt class="optional">
+              tools
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">array</span>
+            </dt>
+            <dd>An array of tools the model may call while generating a response.</dd>
+            <dt class="optional">
+              top_p
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-top_p"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">number</span>
+            </dt>
+            <dd>An alternative to sampling with temperature, called nucleus sampling.</dd>
+            <dt class="optional">
+              truncation
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-truncation"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>The truncation strategy to use for the model response.</dd>
+            <dt class="optional">
+              user
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-user"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.</dd>
+          </dl>
+          <h4 style="font-weight: bolder;"> ⋙ Get Model Response</h4>
+          <p>Retrieves a model response with the given ID.</p>
+          <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+              response_id
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/get#responses-get-response_id"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the response to retrieve.</dd>
+          </dl>
+          <h4 style="font-weight: bolder;"> ⋙ Delete Model Response</h4>
+          <p>Deletes a model response with the given ID.</p>
+          <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+              response_id
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/delete#responses-delete-response_id"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the response to delete.</dd>
+          </dl>
+          <h4 style="font-weight: bolder;"> ⋙ List Input Items</h4>
+          <p>Returns a list of input items for a given response.</p>
+          <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+              response_id
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-response_id"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the response to retrieve input items for.</dd>
+            <dt class="optional">
+              after
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-after"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>An item ID to list items after, used in pagination.</dd>
+            <dt class="optional">
+              before
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-before"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>An item ID to list items before, used in pagination.</dd>
+            <dt class="optional">
+              limit
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-limit"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">integer</span>
+            </dt>
+            <dd>A limit on the number of objects to be returned.</dd>
+            <dt class="optional">
+              order
+              <a
+                href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-order"
+                target="_blank"
+                ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+              ></a>
+              <span class="property-type">string</span>
+            </dt>
+            <dd>The order to return the input items in. Default is <code>asc</code>.</dd>
+          </dl>
+    </details>
+  </section>
+  <!-- End Responses docs -->
   <!-- Begin Runs docs -->
   <section>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@inductiv/node-red-openai-api",
-  "version": "1.85.4",
+  "version": "1.89.0",
   "description": "Enhance your Node-RED projects with advanced AI capabilities.",
   "main": "node.js",
   "engines": {
@@ -30,7 +30,7 @@
     "low-code"
   ],
   "dependencies": {
-    "openai": "~4.85.4"
+    "openai": "~4.89.0"
   },
   "author": "Allan Bunch",
   "license": "MIT",