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

package/src/evals/help.html

@@ -0,0 +1,249 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">📊 Evals</summary>
+        <a href="https://developers.openai.com/api/reference/typescript/resources/evals/" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Evals</h4>
+        <p>List evaluations for a project.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt class="optional">
+                after
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Pagination cursor for items after this id.</dd>
+            <dt class="optional">
+                limit
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Maximum number of evals to return.</dd>
+            <dt class="optional">
+                order
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Sort order by creation time. Use <code>asc</code> or <code>desc</code>.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Eval</h4>
+        <p>Create an eval definition with data source config and testing criteria.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                name
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval name.</dd>
+            <dt>
+                data_source_config
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Data source config schema used by eval runs.</dd>
+            <dt>
+                testing_criteria
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Grader criteria used to score results.</dd>
+            <dt class="optional">
+                metadata
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Optional metadata key-value pairs.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Eval</h4>
+        <p>Retrieve an eval by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Modify Eval</h4>
+        <p>Update mutable eval fields.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+            <dt class="optional">
+                name
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Updated eval name.</dd>
+            <dt class="optional">
+                metadata
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Updated metadata.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Eval</h4>
+        <p>Delete an eval by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Eval Runs</h4>
+        <p>List runs for an eval.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+            <dt class="optional">
+                after
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Pagination cursor for items after this id.</dd>
+            <dt class="optional">
+                limit
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Maximum number of runs to return.</dd>
+            <dt class="optional">
+                order
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Sort order by creation time. Use <code>asc</code> or <code>desc</code>.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Eval Run</h4>
+        <p>Create a run for an eval.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+            <dt>
+                data_source
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Run data source config.</dd>
+            <dt class="optional">
+                model
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Model used for the run when applicable.</dd>
+            <dt class="optional">
+                metadata
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Optional run metadata.</dd>
+            <dt class="optional">
+                name
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Optional run name.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Eval Run</h4>
+        <p>Retrieve a run by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+            <dt>
+                run_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The run id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Cancel Eval Run</h4>
+        <p>Cancel an in-progress eval run.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+            <dt>
+                run_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The run id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Eval Run</h4>
+        <p>Delete an eval run.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+            <dt>
+                run_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The run id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Eval Run Output Items</h4>
+        <p>List output items for a run.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+            <dt>
+                run_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The run id.</dd>
+            <dt class="optional">
+                after
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Pagination cursor for items after this id.</dd>
+            <dt class="optional">
+                limit
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Maximum number of items to return.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Eval Run Output Item</h4>
+        <p>Retrieve one run output item by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                eval_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The eval id.</dd>
+            <dt>
+                run_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The run id.</dd>
+            <dt>
+                output_item_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The output item id.</dd>
+        </dl>
+    </details>
+</section>

package/src/evals/methods.js

@@ -0,0 +1,114 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createEval(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.evals.create(parameters.payload);
+  return response;
+}
+
+async function getEval(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, ...params } = parameters.payload;
+  const response = await openai.evals.retrieve(eval_id, params);
+  return response;
+}
+
+async function modifyEval(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, ...body } = parameters.payload;
+  const response = await openai.evals.update(eval_id, body);
+  return response;
+}
+
+async function deleteEval(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, ...params } = parameters.payload;
+  const response = await openai.evals.delete(eval_id, params);
+  return response;
+}
+
+async function listEvals(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const list = await openai.evals.list(parameters.payload);
+  return [...list.data];
+}
+
+async function createEvalRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, ...body } = parameters.payload;
+  const response = await openai.evals.runs.create(eval_id, body);
+  return response;
+}
+
+async function getEvalRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, run_id, ...params } = parameters.payload;
+  const response = await openai.evals.runs.retrieve(run_id, {
+    eval_id,
+    ...params,
+  });
+  return response;
+}
+
+async function listEvalRuns(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, ...params } = parameters.payload;
+  const list = await openai.evals.runs.list(eval_id, params);
+  return [...list.data];
+}
+
+async function deleteEvalRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, run_id, ...params } = parameters.payload;
+  const response = await openai.evals.runs.delete(run_id, {
+    eval_id,
+    ...params,
+  });
+  return response;
+}
+
+async function cancelEvalRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, run_id, ...params } = parameters.payload;
+  const response = await openai.evals.runs.cancel(run_id, {
+    eval_id,
+    ...params,
+  });
+  return response;
+}
+
+async function getEvalRunOutputItem(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, run_id, output_item_id, ...params } = parameters.payload;
+  const response = await openai.evals.runs.outputItems.retrieve(output_item_id, {
+    eval_id,
+    run_id,
+    ...params,
+  });
+  return response;
+}
+
+async function listEvalRunOutputItems(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { eval_id, run_id, ...params } = parameters.payload;
+  const list = await openai.evals.runs.outputItems.list(run_id, {
+    eval_id,
+    ...params,
+  });
+  return [...list.data];
+}
+
+module.exports = {
+  createEval,
+  getEval,
+  modifyEval,
+  deleteEval,
+  listEvals,
+  createEvalRun,
+  getEvalRun,
+  listEvalRuns,
+  deleteEvalRun,
+  cancelEvalRun,
+  getEvalRunOutputItem,
+  listEvalRunOutputItems,
+};

package/src/evals/template.html

@@ -0,0 +1,14 @@
+<optgroup style="font-style: normal;" label="📊 Evals">
+    <option value="listEvals" data-i18n="OpenaiApi.parameters.listEvals"></option>
+    <option value="createEval" data-i18n="OpenaiApi.parameters.createEval"></option>
+    <option value="getEval" data-i18n="OpenaiApi.parameters.getEval"></option>
+    <option value="modifyEval" data-i18n="OpenaiApi.parameters.modifyEval"></option>
+    <option value="deleteEval" data-i18n="OpenaiApi.parameters.deleteEval"></option>
+    <option value="listEvalRuns" data-i18n="OpenaiApi.parameters.listEvalRuns"></option>
+    <option value="createEvalRun" data-i18n="OpenaiApi.parameters.createEvalRun"></option>
+    <option value="getEvalRun" data-i18n="OpenaiApi.parameters.getEvalRun"></option>
+    <option value="cancelEvalRun" data-i18n="OpenaiApi.parameters.cancelEvalRun"></option>
+    <option value="deleteEvalRun" data-i18n="OpenaiApi.parameters.deleteEvalRun"></option>
+    <option value="listEvalRunOutputItems" data-i18n="OpenaiApi.parameters.listEvalRunOutputItems"></option>
+    <option value="getEvalRunOutputItem" data-i18n="OpenaiApi.parameters.getEvalRunOutputItem"></option>
+</optgroup>

package/src/files/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">📁 Files</summary>
-        <a href="https://platform.openai.com/docs/api-reference/files" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/files/" target="_blank">Official Documentation
             <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
         <h4 style="font-weight: bolder;"> ⋙ List Files</h4>
         <p>Returns a list of files that belong to the user's organization.</p>
@@ -10,32 +10,27 @@
 
             <dt class="optional">
                 purpose
-                <a href="https://platform.openai.com/docs/api-reference/files/list#files-list-purpose"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>Only return files with the given purpose.</dd>
 
             <dt class="optional">
                 limit
-                <a href="https://platform.openai.com/docs/api-reference/files/list#files-list-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/files/list#files-list-order" target="_blank"><i
-                        class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                
                 <span class="property-type">string</span>
             </dt>
             <dd>Sort order by the created_at timestamp of the objects.</dd>
 
             <dt class="optional">
                 after
-                <a href="https://platform.openai.com/docs/api-reference/files/list#files-list-after" target="_blank"><i
-                        class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                
                 <span class="property-type">string</span>
             </dt>
             <dd>A cursor for use in pagination.</dd>
@@ -47,15 +42,11 @@
 
             <dt>
                 file
-                <a href="https://platform.openai.com/docs/api-reference/files/create#files-create-file"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">file</span>
             </dt>
             <dd>Absolute path to the file that's being uploaded.</dd>
             <dt>
                 purpose
-                <a href="https://platform.openai.com/docs/api-reference/files/create#files-create-purpose"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>The intended purpose of the uploaded file.</dd>
@@ -77,8 +68,6 @@
 
             <dt>
                 file_id
-                <a href="https://platform.openai.com/docs/api-reference/files/delete#files-delete-file_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 file to use for this request.</dd>
@@ -91,8 +80,6 @@
 
             <dt>
                 file_id
-                <a href="https://platform.openai.com/docs/api-reference/files/retrieve-contents#files-retrieve-contents-file_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 file to use for this request.</dd>

package/src/fine-tuning/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">🔧 Fine-tuning</summary>
-        <a href="https://platform.openai.com/docs/api-reference/fine-tuning" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/fine_tuning/" target="_blank">Official Documentation
             <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
         <h4 style="font-weight: bolder;"> ⋙ Create Fine-tuning Job</h4>
         <p>
@@ -14,23 +14,17 @@
 
             <dt>
                 model
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-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>The name of the model to fine-tune.</dd>
             <dt>
                 training_file
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-training_file"
-                    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 an uploaded file that contains training data.</dd>
 
             <dt class="optional">
                 suffix
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-suffix"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>
@@ -40,32 +34,24 @@
 
             <dt class="optional">
                 validation_file
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-validation_file"
-                    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 an uploaded file that contains validation data.</dd>
 
             <dt class="optional">
                 integrations
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-integrations"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">array</span>
             </dt>
             <dd>A list of integrations to enable for your fine-tuning job.</dd>
 
             <dt class="optional">
                 seed
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-seed"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">array</span>
             </dt>
             <dd>The seed controls the reproducibility of the job.</dd>
 
             <dt class="optional">
                 method
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-method"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">object</span>
             </dt>
             <dd>The method used for fine-tuning.</dd>
@@ -79,15 +65,11 @@
 
             <dt class="optional">
                 after
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list#fine-tuning-list-after"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>Identifier for the last job from the previous pagination request.</dd>
             <dt class="optional">
                 limit
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list#fine-tuning-list-limit"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">integer</span>
             </dt>
             <dd>Number of fine-tuning jobs to retrieve.</dd>
@@ -100,8 +82,6 @@
 
             <dt>
                 fine_tuning_job_id
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/retrieve#fine-tuning-retrieve-fine_tuning_job_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 fine-tuning job.</dd>
@@ -114,15 +94,11 @@
 
             <dt>
                 fine_tuning_job_id
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-events#fine-tuning-list-events-fine_tuning_job_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 fine-tuning job to get events for.</dd>
             <dt class="optional">
                 after
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-events#fine-tuning-list-events-after"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>
@@ -130,8 +106,6 @@
             </dd>
             <dt class="optional">
                 limit
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-events#fine-tuning-list-events-limit"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">integer</span>
             </dt>
             <dd>Number of events to retrieve.</dd>
@@ -145,15 +119,11 @@
 
             <dt>
                 fine_tuning_job_id
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints#fine-tuning-list-checkpoints-fine_tuning_job_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 fine-tuning job to get checkpoints for.</dd>
             <dt class="optional">
                 after
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints#fine-tuning-list-checkpoints-after"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>
@@ -161,8 +131,6 @@
             </dd>
             <dt class="optional">
                 limit
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints#fine-tuning-list-checkpoints-limit"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">integer</span>
             </dt>
             <dd>Number of events to retrieve.</dd>
@@ -176,8 +144,6 @@
 
             <dt>
                 fine_tuning_job_id
-                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/cancel#fine-tuning-cancel-fine_tuning_job_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 fine-tuning job to cancel.</dd>