@inductiv/node-red-openai-api 1.103.0 → 6.27.0

package/src/node.html

@@ -84,17 +84,23 @@
         @@include('./chat/template.html')
         @@include('./container-files/template.html')
         @@include('./containers/template.html')
+        @@include('./conversations/template.html')
         @@include('./embeddings/template.html')
+        @@include('./evals/template.html')
         @@include('./files/template.html')
         @@include('./fine-tuning/template.html')
         @@include('./images/template.html')
         @@include('./messages/template.html')
         @@include('./models/template.html')
         @@include('./moderations/template.html')
+        @@include('./realtime/template.html')
         @@include('./responses/template.html')
         @@include('./runs/template.html')
+        @@include('./skills/template.html')
         @@include('./threads/template.html')
         @@include('./uploads/template.html')
+        @@include('./videos/template.html')
+        @@include('./webhooks/template.html')
         @@include('./vector-stores/template.html')
         @@include('./vector-store-files/template.html')
         @@include('./vector-store-file-batches/template.html')
@@ -105,7 +111,7 @@
 <script type="text/html" data-help-name="OpenAI API">
   <p>
     OpenAI Platform Services API. Please see the
-    <a href="https://platform.openai.com/docs/api-reference" target="_blank"
+    <a href="https://developers.openai.com/api/reference" target="_blank"
       >OpenAI API Reference</a
     >
     for more details.
@@ -118,17 +124,23 @@
   @@include('./chat/help.html')
   @@include('./container-files/help.html')
   @@include('./containers/help.html')
+  @@include('./conversations/help.html')
   @@include('./embeddings/help.html')
+  @@include('./evals/help.html')
   @@include('./files/help.html')
   @@include('./fine-tuning/help.html')
   @@include('./images/help.html')
   @@include('./messages/help.html')
   @@include('./models/help.html')
   @@include('./moderations/help.html')
+  @@include('./realtime/help.html')
   @@include('./responses/help.html')
   @@include('./runs/help.html')
+  @@include('./skills/help.html')
   @@include('./threads/help.html')
   @@include('./uploads/help.html')
+  @@include('./videos/help.html')
+  @@include('./webhooks/help.html')
   @@include('./vector-stores/help.html')
   @@include('./vector-store-files/help.html')
   @@include('./vector-store-file-batches/help.html')
@@ -139,9 +151,14 @@
     category: "config",
     defaults: {
       apiBase: { value: "https://api.openai.com/v1", required: true },
+      apiBaseType: { value: "str" },
       secureApiKeyHeaderOrQueryName: { value: "Authorization" },
+      secureApiKeyHeaderOrQueryNameType: { value: "str" },
       organizationId: { value: "" },
+      organizationIdType: { value: "str" },
       secureApiKeyIsQuery: { value: false },
+      secureApiKeyValueType: { value: "cred" },
+      secureApiKeyValueRef: { value: "" },
       name: { value: "" },
     },
     credentials: {
@@ -162,61 +179,132 @@
       );
       if (!selected.val()) {
         $("#node-config-input-secureApiKeyIsQuery").val(false);
+      }
+
+      const apiKeyInput = $("#node-config-input-secureApiKeyValue");
+      const apiKeyType = $("#node-config-input-secureApiKeyValueType");
+      const apiKeyRef = $("#node-config-input-secureApiKeyValueRef");
+
+      // Preserve existing credential value before initializing typedInput
+      const existingCredValue = apiKeyInput.val();
+
+      apiKeyInput.typedInput({
+        default: "cred",
+        types: ["cred", "env", "msg", "flow", "global"],
+        typeField: "#node-config-input-secureApiKeyValueType",
+      });
+
+      // Restore credential value if it was populated by Node-RED
+      if (apiKeyType.val() === "cred" && existingCredValue) {
+        apiKeyInput.typedInput("value", existingCredValue);
+      }
+
+      let previousApiKeyType = apiKeyInput.typedInput("type");
+      const syncApiKeyInputValue = function () {
+        const selectedType = apiKeyInput.typedInput("type");
+        const currentValue = apiKeyInput.typedInput("value");
+
+        if (selectedType !== "cred" && currentValue === "__PWRD__") {
+          apiKeyInput.typedInput("value", apiKeyRef.val() || "");
+        }
+
+        // Prevent moving a non-credential reference value into credentials.
+        if (selectedType === "cred" && previousApiKeyType !== "cred") {
+          if (currentValue === apiKeyRef.val()) {
+            apiKeyInput.typedInput("value", "");
+          }
+        }
+
+        previousApiKeyType = selectedType;
       };
+
+      if (apiKeyType.val() === "str") {
+        apiKeyInput.typedInput("type", "cred");
+        apiKeyType.val("cred");
+      }
+
+      if (apiKeyType.val() !== "cred" && apiKeyRef.val()) {
+        apiKeyInput.typedInput("value", apiKeyRef.val());
+      }
+      syncApiKeyInputValue();
+      apiKeyInput.on("change", function () {
+        syncApiKeyInputValue();
+      });
+
+      [
+        { input: "#node-config-input-apiBase", type: "#node-config-input-apiBaseType" },
+        { input: "#node-config-input-secureApiKeyHeaderOrQueryName", type: "#node-config-input-secureApiKeyHeaderOrQueryNameType" },
+        { input: "#node-config-input-organizationId", type: "#node-config-input-organizationIdType" }
+      ].forEach(function (field) {
+        $(field.input).typedInput({
+          default: "str",
+          types: ["str", "env", "msg", "flow", "global"],
+          typeField: field.type,
+        });
+      });
+    },
+    oneditsave: function () {
+      const apiKeyInput = $("#node-config-input-secureApiKeyValue");
+      const apiKeyType = $("#node-config-input-secureApiKeyValueType");
+      const apiKeyRef = $("#node-config-input-secureApiKeyValueRef");
+      const selectedType = apiKeyInput.typedInput("type");
+
+      apiKeyType.val(selectedType);
+
+      if (selectedType !== "cred") {
+        const inputValue = apiKeyInput.typedInput("value");
+        if (inputValue && inputValue !== "__PWRD__") {
+          apiKeyRef.val(inputValue);
+          apiKeyInput.typedInput("value", "");
+        }
+      } else {
+        apiKeyRef.val("");
+      }
     },
   });
 </script>
 
 <script type="text/html" data-template-name="Service Host">
   <div class="form-row">
-    <label id="node-config-input-apiBase-label" for="node-config-input-apiBase"
-      ><i class="fa fa-list"></i>
-      <span data-i18n="OpenaiApi.label.apiBase"></span
-    ></label>
+    <label id="node-config-input-apiBase-label" for="node-config-input-apiBase">
+      <i class="fa fa-list"></i>
+      <span data-i18n="OpenaiApi.label.apiBase"></span>
+    </label>
     <input
       type="text"
       id="node-config-input-apiBase"
       placeholder="https://api.openai.com/v1"
     />
+    <input type="hidden" id="node-config-input-apiBaseType" />
   </div>
   <div class="form-row">
-    <label
-      id="node-config-input-secureApiKeyHeaderOrQueryName-label"
-      for="node-config-input-secureApiKeyHeaderOrQueryName"
-      ><i class="fa fa-list"></i>
-      <span data-i18n="OpenaiApi.label.header"></span
-    ></label>
+    <label id="node-config-input-secureApiKeyHeaderOrQueryName-label" for="node-config-input-secureApiKeyHeaderOrQueryName">
+      <i class="fa fa-list"></i>
+      <span data-i18n="OpenaiApi.label.header"></span>
+    </label>
     <input
       type="text"
       id="node-config-input-secureApiKeyHeaderOrQueryName"
-      placeholder=""
+      placeholder="Authorization"
     />
+    <input type="hidden" id="node-config-input-secureApiKeyHeaderOrQueryNameType" />
   </div>
   <div class="form-row">
-    <label
-      id="node-config-input-secureApiKeyValue-label"
-      for="node-config-input-secureApiKeyValue"
-      ><i class="fa fa-lock"></i>
-      <span data-i18n="OpenaiApi.label.apiKey"></span
-    ></label>
-    <input
-      type="password"
-      id="node-config-input-secureApiKeyValue"
-      placeholder=""
-    />
+    <label id="node-config-input-secureApiKeyValue-label" for="node-config-input-secureApiKeyValue">
+      <i class="fa fa-lock"></i>
+      <span data-i18n="OpenaiApi.label.apiKey"></span>
+    </label>
+    <input type="text" id="node-config-input-secureApiKeyValue" placeholder="" />
+    <input type="hidden" id="node-config-input-secureApiKeyValueType" />
+    <input type="hidden" id="node-config-input-secureApiKeyValueRef" />
   </div>
   <div class="form-row">
-    <label
-      id="node-config-input-organizationId-label"
-      for="node-config-input-organizationId"
-      ><i class="fa fa-list"></i>
-      <span data-i18n="OpenaiApi.label.organizationId"></span
-    ></label>
-    <input
-      type="text"
-      id="node-config-input-organizationId"
-      placeholder="OpenAI Organization Id"
-    />
+    <label id="node-config-input-organizationId-label" for="node-config-input-organizationId">
+      <i class="fa fa-list"></i>
+      <span data-i18n="OpenaiApi.label.organizationId"></span>
+    </label>
+    <input type="text" id="node-config-input-organizationId" />
+    <input type="hidden" id="node-config-input-organizationIdType" />
   </div>
   <div class="form-row">
     <label
@@ -245,6 +333,7 @@
 </script>
 
 <script type="text/html" data-help-name="Service Host">
-  <p><b>Header</b>: Variable name to set API key</p>
-  <p><b>Value</b>: Value of API key</p>
-</script>
+  <p><b>Auth Header</b>: Header name used to send the API key. Defaults to <code>Authorization</code>.</p>
+  <p><b>isQuery</b>: When true, the API key is sent as a query parameter using the Auth Header value as the parameter name.</p>
+  <p><b>API Key</b>: API key value or typed reference.</p>
+</script>

package/src/realtime/help.html

@@ -0,0 +1,209 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">📞 Realtime</summary>
+        <a href="https://developers.openai.com/api/reference/typescript/resources/realtime/" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Realtime Client Secret</h4>
+        <p>Create an ephemeral client secret for browser/mobile realtime sessions.</p>
+        <p>Put Realtime session configuration inside <code>msg.payload.session</code>. Top-level
+            <code>msg.payload</code> is reserved for client-secret options such as
+            <code>expires_after</code>.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt class="optional">
+                expires_after
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Optional client-secret expiration config, for example
+                <code>{ "anchor": "created_at", "seconds": 600 }</code>.</dd>
+            <dt class="optional">
+                session
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Realtime session configuration to attach to the generated client secret.</dd>
+            <dt>
+                session.type
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Must be <code>realtime</code> for a Realtime session.</dd>
+            <dt class="optional">
+                session.model
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Realtime model id, including newer SDK-supported ids such as
+                <code>gpt-realtime-1.5</code> and <code>gpt-audio-1.5</code>.</dd>
+            <dt class="optional">
+                session.instructions
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Default system instructions for the session.</dd>
+            <dt class="optional">
+                session.include
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Additional server output fields to include, such as
+                <code>item.input_audio_transcription.logprobs</code>.</dd>
+            <dt class="optional">
+                session.max_output_tokens
+                <span class="property-type">integer | string</span>
+            </dt>
+            <dd>Maximum output tokens per assistant response, or <code>inf</code>.</dd>
+            <dt class="optional">
+                session.output_modalities
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Output modalities such as <code>text</code> or <code>audio</code>.</dd>
+            <dt class="optional">
+                session.audio
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Input/output audio config for the session.</dd>
+            <dt class="optional">
+                session.prompt
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Reusable prompt reference and variables for the session.</dd>
+            <dt class="optional">
+                session.tools
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Tools available to the realtime model.</dd>
+            <dt class="optional">
+                session.tool_choice
+                <span class="property-type">string | object</span>
+            </dt>
+            <dd>How tools are selected.</dd>
+            <dt class="optional">
+                session.tracing
+                <span class="property-type">string | object | null</span>
+            </dt>
+            <dd>Trace configuration for the realtime session.</dd>
+            <dt class="optional">
+                session.truncation
+                <span class="property-type">string | object</span>
+            </dt>
+            <dd>Conversation truncation behavior for the session.</dd>
+        </dl>
+        <p>Successful responses are returned in <code>msg.payload</code> with top-level
+            <code>value</code>, <code>expires_at</code>, and <code>session</code> fields.</p>
+
+        <h4 style="font-weight: bolder;"> ⋙ Accept Realtime Call</h4>
+        <p>Accept an incoming SIP call and attach it to a realtime session.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                call_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The incoming call id.</dd>
+            <dt>
+                type
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Must be <code>realtime</code>.</dd>
+            <dt class="optional">
+                include
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Additional server output fields to include, such as
+                <code>item.input_audio_transcription.logprobs</code>.</dd>
+            <dt class="optional">
+                model
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Realtime model id for the accepted call, including newer SDK-supported ids such as
+                <code>gpt-realtime-1.5</code> and <code>gpt-audio-1.5</code>.</dd>
+            <dt class="optional">
+                instructions
+                <span class="property-type">string</span>
+            </dt>
+            <dd>System instructions for the call session.</dd>
+            <dt class="optional">
+                max_output_tokens
+                <span class="property-type">integer | string</span>
+            </dt>
+            <dd>Maximum output tokens per assistant response, or <code>inf</code>.</dd>
+            <dt class="optional">
+                output_modalities
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Output modalities such as <code>text</code> or <code>audio</code>.</dd>
+            <dt class="optional">
+                audio
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Input/output audio config for the accepted call session.</dd>
+            <dt class="optional">
+                prompt
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Reusable prompt reference and variables for the call session.</dd>
+            <dt class="optional">
+                tools
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Tools available in the call session.</dd>
+            <dt class="optional">
+                tool_choice
+                <span class="property-type">string | object</span>
+            </dt>
+            <dd>Tool selection strategy.</dd>
+            <dt class="optional">
+                tracing
+                <span class="property-type">string | object | null</span>
+            </dt>
+            <dd>Trace configuration for the accepted call session.</dd>
+            <dt class="optional">
+                truncation
+                <span class="property-type">string | object</span>
+            </dt>
+            <dd>Conversation truncation behavior for the call session.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Hangup Realtime Call</h4>
+        <p>Hang up an active realtime call.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                call_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The call id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Refer Realtime Call</h4>
+        <p>Transfer an active call using SIP REFER.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                call_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The call id.</dd>
+            <dt>
+                target_uri
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Transfer target URI, for example <code>tel:+14155550123</code>.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Reject Realtime Call</h4>
+        <p>Reject an incoming call.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                call_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The call id.</dd>
+            <dt class="optional">
+                status_code
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Optional SIP status code. Default is <code>603</code>.</dd>
+        </dl>
+
+        <p>Call operations return a small confirmation object in <code>msg.payload</code> when successful.</p>
+    </details>
+</section>

package/src/realtime/methods.js

@@ -0,0 +1,45 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createRealtimeClientSecret(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.realtime.clientSecrets.create(
+    parameters.payload
+  );
+  return response;
+}
+
+async function acceptRealtimeCall(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { call_id, ...body } = parameters.payload;
+  await openai.realtime.calls.accept(call_id, body);
+  return { call_id, status: "accepted" };
+}
+
+async function hangupRealtimeCall(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { call_id, ...params } = parameters.payload;
+  await openai.realtime.calls.hangup(call_id, params);
+  return { call_id, status: "hung_up" };
+}
+
+async function referRealtimeCall(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { call_id, ...body } = parameters.payload;
+  await openai.realtime.calls.refer(call_id, body);
+  return { call_id, status: "referred" };
+}
+
+async function rejectRealtimeCall(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { call_id, ...body } = parameters.payload;
+  await openai.realtime.calls.reject(call_id, body);
+  return { call_id, status: "rejected" };
+}
+
+module.exports = {
+  createRealtimeClientSecret,
+  acceptRealtimeCall,
+  hangupRealtimeCall,
+  referRealtimeCall,
+  rejectRealtimeCall,
+};

package/src/realtime/template.html

@@ -0,0 +1,7 @@
+<optgroup style="font-style: normal;" label="📞 Realtime">
+    <option value="createRealtimeClientSecret" data-i18n="OpenaiApi.parameters.createRealtimeClientSecret"></option>
+    <option value="acceptRealtimeCall" data-i18n="OpenaiApi.parameters.acceptRealtimeCall"></option>
+    <option value="hangupRealtimeCall" data-i18n="OpenaiApi.parameters.hangupRealtimeCall"></option>
+    <option value="referRealtimeCall" data-i18n="OpenaiApi.parameters.referRealtimeCall"></option>
+    <option value="rejectRealtimeCall" data-i18n="OpenaiApi.parameters.rejectRealtimeCall"></option>
+</optgroup>