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

package/src/responses/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">🗨️ Responses</summary>
-        <a href="https://platform.openai.com/docs/api-reference/responses" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/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>
@@ -10,133 +10,163 @@
 
             <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>
+            <dd>
+                Text, image, or file inputs to the model, used to generate a response.
+                For assistant message items in an array input, you may also set
+                <code>phase</code> to <code>commentary</code> or <code>final_answer</code>.
+            </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>
+            <dd>
+                Model ID used to generate the response, including newer Responses-compatible
+                model strings such as <code>gpt-5.4</code>.
+            </dd>
+
+            <dt class="optional">
+                background
+                <span class="property-type">boolean</span>
+            </dt>
+            <dd>Whether to run the model response in the background.</dd>
+
+            <dt class="optional">
+                context_management
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Context management settings, including compaction behavior.</dd>
+
+            <dt class="optional">
+                conversation
+                <span class="property-type">string | object</span>
+            </dt>
+            <dd>Conversation context to prepend for this 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>
+                previous_response_id
+                <span class="property-type">string</span>
             </dt>
-            <dd>Whether to allow the model to run tool calls in parallel.</dd>
+            <dd>The unique ID of the previous response to the model.</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>
+                prompt
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Reference to a reusable prompt template and variables.</dd>
+
+            <dt class="optional">
+                prompt_cache_key
                 <span class="property-type">string</span>
             </dt>
-            <dd>The unique ID of the previous response to the model.</dd>
+            <dd>Stable key used to improve prompt cache hit rates.</dd>
+
+            <dt class="optional">
+                prompt_cache_retention
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Prompt cache retention policy, such as <code>in-memory</code> or <code>24h</code>.</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">
+                safety_identifier
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Stable end-user identifier used for abuse detection and safety controls.</dd>
+
+            <dt class="optional">
+                service_tier
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Service tier selection, for example <code>default</code>, <code>flex</code>, or <code>priority</code>.</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">
+                stream_options
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Streaming options such as obfuscation behavior for event payloads.</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.
+                This includes Model Context Protocol tools, Tool Search via
+                <code>{ "type": "tool_search" }</code>, and GA computer use via
+                <code>{ "type": "computer" }</code>.
+                Deferred tool loading is supported by setting
+                <code>defer_loading: true</code> on tool definitions.
+                Computer-tool workflows typically require follow-up requests that send
+                <code>computer_call_output</code> items back through <code>input</code>.
                 For Model Context Protocol (MCP) tools, each object in the array should follow <a
                     href="https://platform.openai.com/docs/guides/tools-remote-mcp?lang=javascript&utm_source==%40inductiv%2Fnode-red-openai-api"
                     target="_blank">this
@@ -145,27 +175,21 @@
 
             <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>
+            <dd>Deprecated. Prefer <code>safety_identifier</code> and <code>prompt_cache_key</code>.</dd>
 
         </dl>
 
@@ -176,11 +200,33 @@
 
             <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>
+
+            <dt class="optional">
+                include
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Additional output fields to include in the response.</dd>
+
+            <dt class="optional">
+                include_obfuscation
+                <span class="property-type">boolean</span>
+            </dt>
+            <dd>Enable obfuscation payloads in streaming events.</dd>
+
+            <dt class="optional">
+                starting_after
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Event sequence number after which to begin a streamed retrieval.</dd>
+
+            <dt class="optional">
+                stream
+                <span class="property-type">boolean</span>
+            </dt>
+            <dd>When true, retrieve the response as a stream of events.</dd>
         </dl>
 
         <h4 style="font-weight: bolder;"> ⋙ Delete Model Response</h4>
@@ -190,13 +236,53 @@
 
             <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;"> ⋙ Cancel Model Response</h4>
+        <p>Cancels an in-progress model response.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                response_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the response to cancel.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Compact Model Response</h4>
+        <p>Compacts prior conversation content to reduce context size while preserving continuity.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                model
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Model ID used for compaction.</dd>
+
+            <dt class="optional">
+                input
+                <span class="property-type">string | array</span>
+            </dt>
+            <dd>Optional input items used for compaction.</dd>
+
+            <dt class="optional">
+                instructions
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Optional system or developer instructions for compaction.</dd>
+
+            <dt class="optional">
+                previous_response_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Optional previous response id to continue compaction context.</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">
@@ -204,45 +290,182 @@
 
             <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>
+            <dd>The order to return the input items in. Default is <code>desc</code>.</dd>
+
+            <dt class="optional">
+                include
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Additional fields to include on the returned input items.</dd>
+
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Count Input Tokens</h4>
+        <p>Counts input tokens before creating a model response.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt class="optional">
+                model
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Model ID to use for token counting.</dd>
+
+            <dt class="optional">
+                input
+                <span class="property-type">string | array</span>
+            </dt>
+            <dd>Input items to count.</dd>
+
+            <dt class="optional">
+                conversation
+                <span class="property-type">string | object</span>
+            </dt>
+            <dd>Conversation context to include in counting.</dd>
+
+            <dt class="optional">
+                instructions
+                <span class="property-type">string</span>
+            </dt>
+            <dd>System or developer instructions to include in counting.</dd>
+
+            <dt class="optional">
+                previous_response_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Previous response ID used to continue conversation context.</dd>
+
+            <dt class="optional">
+                parallel_tool_calls
+                <span class="property-type">boolean</span>
+            </dt>
+            <dd>Whether tool calls may run in parallel for the modeled request.</dd>
+
+            <dt class="optional">
+                reasoning
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Reasoning model configuration used for token accounting.</dd>
+
+            <dt class="optional">
+                text
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Text output configuration used when estimating token usage.</dd>
+
+            <dt class="optional">
+                tool_choice
+                <span class="property-type">string | object</span>
+            </dt>
+            <dd>Tool selection mode used for token counting.</dd>
+
+            <dt class="optional">
+                tools
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Tool definitions used for token counting.</dd>
+
+            <dt class="optional">
+                truncation
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Truncation strategy for token counting context.
+            </dd>
+
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Manage Model Response WebSocket</h4>
+        <p>
+            Opens, uses, and closes a persistent Responses websocket connection from a single
+            <code>OpenAI API</code> node instance.
+        </p>
+        <p>
+            Use the same node instance for all websocket actions. Set <code>msg.payload.action</code> to
+            <code>connect</code>, <code>send</code>, or <code>close</code>.
+        </p>
+        <p>
+            Incoming server events are emitted asynchronously from this node as new messages with the raw
+            event object in <code>msg.payload</code>. Connection metadata is added under
+            <code>msg.openai</code>.
+        </p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                action
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                Required lifecycle action. Must be <code>connect</code>, <code>send</code>, or
+                <code>close</code>.
+            </dd>
+
+            <dt>
+                connection_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                Stable identifier for the websocket connection owned by this node instance.
+            </dd>
+
+            <dt class="optional">
+                event
+                <span class="property-type">object</span>
+            </dt>
+            <dd>
+                Required when <code>action</code> is <code>send</code>. Provide a Responses client event,
+                currently <code>{ "type": "response.create", ... }</code>.
+            </dd>
+
+            <dt class="optional">
+                code
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>
+                Optional websocket close code used when <code>action</code> is <code>close</code>.
+                Defaults to <code>1000</code>.
+            </dd>
+
+            <dt class="optional">
+                reason
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                Optional websocket close reason used when <code>action</code> is <code>close</code>.
+                Defaults to <code>OK</code>.
+            </dd>
 
         </dl>
+        <p>
+            The websocket URL is derived from the configured <code>Service Host</code> API Base using the
+            same auth contract as the rest of this node, including custom auth headers and query-string auth.
+        </p>
 
     </details>
-</section>
+</section>