Doc-1022 Update OpenAI node doc (n8n-io#2446)

Co-authored-by: Kate Mueller <[email protected]>

Author: ayatnkw

docs/integrations/builtin/app-nodes/n8n-nodes-base.apitemplateio.md

@@ -18,11 +18,11 @@ Refer to [APITemplate.io credentials](/integrations/builtin/credentials/apitempl
 ## Operations
 
 * Account
-  * Get
+    * Get
 * Image
-  * Create
+    * Create
 * PDF
-  * Create
+    * Create
 
 ## Templates and examples
 

docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md

@@ -0,0 +1,124 @@
+---
+#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
+title: OpenAI Assistant operations 
+description: Documentation for the Assistant operations in OpenAI node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
+contentType: integration
+priority: critical
+---
+
+# OpenAI Assistant operations
+
+Use this operation to create, delete, list, message, or update an assistant in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-base.openai/) for more information on the OpenAI node itself.
+
+## Create an Assistant
+
+Use this operation to create a new assistant.
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **Assistant**.
+- **Operation**: Select **Create an Assistant**.
+- **Model**: Select the model that the assistant will use. If you’re not sure which model to use, try `gpt-4o` if you need high intelligence or `gpt-4o-mini` if you need the fastest speed and lowest cost. Refer to [Models overview | OpenAI Platform](https://platform.openai.com/docs/models){:target=_blank .external-link} for more information. 
+- **Name**: Enter the name of the assistant. The maximum length is 256 characters.
+- **Description**: Enter the description of the assistant. The maximum length is 512 characters.
+  ```
+  A virtual assistant that helps users with daily tasks, including setting reminders, answering general questions, and providing quick information.
+  ```
+- **Instructions**: Enter the system instructions that the assistant uses. The maximum length is 32,768 characters. Use this to specify the persona used by the model in its replies. 
+  ```
+  Always respond in a friendly and engaging manner. When a user asks a question, provide a concise answer first, followed by a brief explanation or additional context if necessary. If the question is open-ended, offer a suggestion or ask a clarifying question to guide the conversation. Keep the tone positive and supportive, and avoid technical jargon unless specifically requested by the user.
+  ```
+- **Code Interpreter**: Turn on to enable the code interpreter for the assistant, where it can write and execute code in a sandbox environment. Enable this tool for tasks that require computations, data analysis, or any logic-based processing.
+- **Knowledge Retrieval**: Turn on to enable knowledge retrieval for the assistant, allowing it to access external sources or a connected knowledge base. Refer to [File Search | OpenAI Platform](https://platform.openai.com/docs/assistants/tools/file-search){:target=_blank .external-link} for more information. 
+  - **Files**: Select a file to upload for your external knowledge source. Use **Upload a File** operation to add more files. 
+
+### Options
+
+- **Output Randomness (Temperature)**: Adjust the randomness of the response. The range is between `0.0` (deterministic) and `1.0` (maximum randomness). We recommend altering this or **Output Randomness (Top P)** but not both. Start with a medium temperature (around 0.7) and adjust based on the outputs you observe. If the responses are too repetitive or rigid, increase the temperature. If they’re too chaotic or off-track, decrease it. Defaults to `1.0`. 
+- **Output Randomness (Top P)**: Adjust the Top P setting to control the diversity of the assistant's responses. For example, `0.5` means half of all likelihood-weighted options are considered. We recommend altering this or **Output Randomness (Temperature)** but not both. Defaults to `1.0`. 
+- **Fail if Assistant Already Exists**: If enabled, the operation will fail if an assistant with the same name already exists. 
+
+Refer to [Create assistant | OpenAI](https://platform.openai.com/docs/api-reference/assistants/createAssistant){:target=_blank .external-link} documentation for more information. 
+
+## Delete an Assistant
+
+Use this operation to delete an existing assistant from your account.
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **Assistant**.
+- **Operation**: Select **Delete an Assistant**.
+- **Assistant**: Select the assistant you want to delete **From list** or **By ID**.
+
+Refer to [Delete assistant | OpenAI](https://platform.openai.com/docs/api-reference/assistants/deleteAssistant){:target=_blank .external-link} documentation for more information. 
+
+## List Assistants
+
+Use this operation to retrieve a list of assistants in your organization.
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **Assistant**.
+- **Operation**: Select **List Assistants**.
+
+### Options
+
+- **Simplify Output**: Turn on to return a simplified version of the response instead of the raw data. This option is enabled by default. 
+
+Refer to [List assistants | OpenAI](https://platform.openai.com/docs/api-reference/assistants/listAssistants){:target=_blank .external-link} documentation for more information. 
+  
+## Message an Assistant
+
+Use this operation to send a message to an assistant and receive a response.
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **Assistant**.
+- **Operation**: Select **Message an Assistant**.
+- **Assistant**: Select the assistant you want to message.
+- **Prompt**: Enter the text prompt or message that you want to send to the assistant.
+    - **Take from Previous Node Automatically**: Automatically use the input from a previous node's `chatInput` field.
+    - **Define Below**: Manually define the prompt by entering static text or using an expression to reference data from previous nodes.
+
+### Options
+
+- **Base URL**: Enter the base URL that the assistant should use for making API requests. This option is useful for directing the assistant to use endpoints provided by other LLM providers that offer an OpenAI-compatible API.
+- **Max Retries**: Specify the number of times the assistant should retry an operation in case of failure. 
+- **Timeout**: Set the maximum amount of time in milliseconds, that the assistant should wait for a response before timing out. Use this option to prevent long waits during operations.
+- **Preserve Original Tools**: Turn off to remove the original tools associated with the assistant. Use this if you want to temporarily remove tools for this specific operation.
+
+Refer to [Assistants | OpenAI](https://platform.openai.com/docs/api-reference/assistants){:target=_blank .external-link} documentation for more information. 
+
+## Update an Assistant
+
+Use this operation to update the details of an existing assistant.
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **Assistant**.
+- **Operation**: Select **Update an Assistant**.
+- **Assistant**: Select the assistant you want to update.
+
+### Options
+
+- **Code Interpreter**: Turn on to enable the code interpreter for the assistant, where it can write and execute code in a sandbox environment. Enable this tool for tasks that require computations, data analysis, or any logic-based processing.
+- **Description**: Enter the description of the assistant. The maximum length is 512 characters.
+  ```
+  A virtual assistant that helps users with daily tasks, including setting reminders, answering general questions, and providing quick information.
+  ```
+- **Instructions**: Enter the system instructions that the assistant uses. The maximum length is 32,768 characters. Use this to specify the persona used by the model in its replies. 
+  ```
+  Always respond in a friendly and engaging manner. When a user asks a question, provide a concise answer first, followed by a brief explanation or additional context if necessary. If the question is open-ended, offer a suggestion or ask a clarifying question to guide the conversation. Keep the tone positive and supportive, and avoid technical jargon unless specifically requested by the user.
+  ```
+- **Knowledge Retrieval**: Turn on to enable knowledge retrieval for the assistant, allowing it to access external sources or a connected knowledge base. Refer to [File Search | OpenAI Platform](https://platform.openai.com/docs/assistants/tools/file-search){:target=_blank .external-link} for more information. 
+- **Files**: Select a file to upload for your external knowledge source. Use [**Upload a File**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/file-operations.md#upload-a-file) operation to add more files. 
+- **Model**: Select the model that the assistant will use. If you’re not sure which model to use, try `gpt-4o` if you need high intelligence or `gpt-4o-mini` if you need the fastest speed and lowest cost. Refer to [Models overview | OpenAI Platform](https://platform.openai.com/docs/models){:target=_blank .external-link} for more information. 
+- **Name**: Enter the name of the assistant. The maximum length is 256 characters.
+- **Remove All Custom Tools (Functions)**: Turn on to remove all custom tools (functions) from the assistant. 
+- **Output Randomness (Temperature)**: Adjust the randomness of the response. The range is between `0.0` (deterministic) and `1.0` (maximum randomness). We recommend altering this or **Output Randomness (Top P)** but not both. Start with a medium temperature (around 0.7) and adjust based on the outputs you observe. If the responses are too repetitive or rigid, increase the temperature. If they’re too chaotic or off-track, decrease it. Defaults to `1.0`. 
+- **Output Randomness (Top P)**: Adjust the Top P setting to control the diversity of the assistant's responses. For example, `0.5` means half of all likelihood-weighted options are considered. We recommend altering this or **Output Randomness (Temperature)** but not both. Defaults to `1.0`. 
+
+Refer to [Modify assistant | OpenAI](https://platform.openai.com/docs/api-reference/assistants/modifyAssistant){:target=_blank .external-link} documentation for more information. 

docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/audio-operations.md

@@ -0,0 +1,69 @@
+---
+#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
+title: OpenAI Audio operations 
+description: Documentation for the Audio operations in OpenAI node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
+contentType: integration
+priority: critical
+---
+
+# OpenAI Audio operations
+
+Use this operation to generate an audio, or transcribe or translate a recording in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-base.openai/) for more information on the OpenAI node itself.
+
+## Generate Audio
+
+Use this operation to create audio from a text prompt. 
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **Audio**.
+- **Operation**: Select **Generate Audio**.
+- **Model**: Select the model you want to use to generate the audio. Refer to [TTS | OpenAI](https://platform.openai.com/docs/models/tts){:target=_blank .external-link} for more information.
+    - **TTS-1**: Use this to optimize for speed.
+    - **TTS-1-HD**:	Use this to optimize for quality.
+- **Text Input**: Enter the text to generate the audio for. The maximum length is 4096 characters.
+- **Voice**: Select a voice to use when generating the audio. Listen to the previews of the voices in [Text to speech guide | OpenAI](https://platform.openai.com/docs/guides/text-to-speech/quickstart){:target=_blank .external-link}.
+
+### Options
+
+- **Response Format**: Select the format for the audio response. Choose from **MP3** (default), **OPUS**, **AAC**, **FLAC**, **WAV**, and **PCM**.
+- **Audio Speed**: Enter the speed for the generated audio from a value from `0.25` to `4.0`. Defaults to `1`.
+- **Put Output in Field**: Defaults to `data`. Enter the name of the output field to put the binary file data in. 
+
+Refer to [Create speech | OpenAI](https://platform.openai.com/docs/api-reference/audio/createSpeech){:target=_blank .external-link} documentation for more information.
+
+## Transcribe a Recording
+
+Use this operation to transcribe audio into text. OpenAI API limits the size of the audio file to 25 MB. OpenAI will use the `whisper-1` model by default. 
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **Audio**.
+- **Operation**: Select **Transcribe a Recording**.
+- **Input Data Field Name**: Defaults to `data`. Enter the name of the binary property that contains the audio file in one of these formats: `.flac`, `.mp3`, `.mp4`, `.mpeg`, `.mpga`, `.m4a`, `.ogg`, `.wav`, or `.webm`. 
+
+### Options
+
+- **Language of the Audio File**: Enter the language of the input audio in  [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes){:target=_blank .external-link}. Use this option to improve accuracy and latency.
+- **Output Randomness (Temperature)**: Defaults to `1.0`. Adjust the randomness of the response. The range is between `0.0` (deterministic) and `1.0` (maximum randomness). We recommend altering this or **Output Randomness (Top P)** but not both. Start with a medium temperature (around 0.7) and adjust based on the outputs you observe. If the responses are too repetitive or rigid, increase the temperature. If they’re too chaotic or off-track, decrease it. 
+
+Refer to [Create transcription | OpenAI](https://platform.openai.com/docs/api-reference/audio/createTranscription){:target=_blank .external-link} documentation for more information.
+
+## Translate a Recording
+
+Use this operation to translate audio into English. OpenAI API limits the size of the audio file to 25 MB. OpenAI will use the `whisper-1` model by default. 
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **Audio**.
+- **Operation**: Select **Translate a Recording**.
+- **Input Data Field Name**: Defaults to `data`. Enter the name of the binary property that contains the audio file in one of these formats: `.flac`, `.mp3`, `.mp4`, `.mpeg`, `.mpga`, `.m4a`, `.ogg`, `.wav`, or `.webm`. 
+
+### Options
+
+- **Output Randomness (Temperature)**: Defaults to `1.0`. Adjust the randomness of the response. The range is between `0.0` (deterministic) and `1.0` (maximum randomness). We recommend altering this or **Output Randomness (Top P)** but not both. Start with a medium temperature (around 0.7) and adjust based on the outputs you observe. If the responses are too repetitive or rigid, increase the temperature. If they’re too chaotic or off-track, decrease it. 
+
+Refer to [Create transcription | OpenAI](https://platform.openai.com/docs/api-reference/audio/createTranscription){:target=_blank .external-link} documentation for more information.

docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/file-operations.md

@@ -0,0 +1,58 @@
+---
+#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
+title: OpenAI File operations 
+description: Documentation for the File operations in OpenAI node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
+contentType: integration
+priority: critical
+---
+
+# OpenAI File operations
+
+Use this operation to create, delete, list, message, or update a file in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-base.openai/) for more information on the OpenAI node itself.
+
+## Delete a File
+
+Use this operation to delete a file from the server.
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **File**.
+- **Operation**: Select **Delete a File**.
+- **File**: Enter the ID of the file to use for this operation or select the file name from the dropdown.
+
+Refer to [Delete file | OpenAI](https://platform.openai.com/docs/api-reference/files/delete){:target=_blank .external-link} documentation for more information.
+
+## List Files
+
+Use this operation to list files that belong to the user's organization. 
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **File**.
+- **Operation**: Select **List Files**.
+
+### Options
+
+- **Purpose**: Use this to only return files with the given purpose. Use **Assistants** to return only files related to Assistants and Message operations. Use **Fine-Tune** for files related to [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning){:target=_blank .external-link}.
+
+Refer to [List files | OpenAI](https://platform.openai.com/docs/api-reference/files/list) documentation for more information.
+
+## Upload a File
+
+Use this operation to upload a file. This can be used across various operations. 
+
+Enter these parameters:
+
+- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai/).
+- **Resource**: Select **File**.
+- **Operation**: Select **Upload a File**.
+- **Input Data Field Name**: Defaults to `data`. Enter the name of the binary property which contains the file. The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants.
+
+
+### Options
+
+- **Purpose**: Enter the intended purpose of the uploaded file. Use **Assistants** for files associated with Assistants and Message operations. Use **Fine-Tune** for [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning){:target=_blank .external-link}.
+
+Refer to [Upload file | OpenAI](https://platform.openai.com/docs/api-reference/files/create){:target=_blank .external-link} documentation for more information.