Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ubos-tech/node-red-contrib-openai-ubos
A Node-RED node that interacts with OpenAI machine learning models to generate text like ChatGPT
https://github.com/ubos-tech/node-red-contrib-openai-ubos
ada-002 ai chatgpt chatgpt-api code-generation dall-e embeddings embeddings-model flow gpt-3 gpt-35-turbo-0301 javascript machine-learning no-code node-red nodejs openai text-embedding text-generation
Last synced: 3 days ago
JSON representation
A Node-RED node that interacts with OpenAI machine learning models to generate text like ChatGPT
- Host: GitHub
- URL: https://github.com/ubos-tech/node-red-contrib-openai-ubos
- Owner: UBOS-tech
- License: mit
- Created: 2023-06-06T07:15:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-29T11:00:15.000Z (8 months ago)
- Last Synced: 2024-10-11T21:43:11.310Z (25 days ago)
- Topics: ada-002, ai, chatgpt, chatgpt-api, code-generation, dall-e, embeddings, embeddings-model, flow, gpt-3, gpt-35-turbo-0301, javascript, machine-learning, no-code, node-red, nodejs, openai, text-embedding, text-generation
- Language: JavaScript
- Homepage:
- Size: 47.9 KB
- Stars: 11
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## node-red-contrib-openai-ubos
A Node-RED node that interacts with OpenAI machine learning models to generate text like ChatGPT.
UBOS
•
Community
•
Youtube
•
Discord
•
GitHub
[](https://flows.nodered.org/node/node-red-contrib-openai-ubos)
[](https://www.npmjs.com/package/node-red-contrib-openai-ubos)
### Quick Start
Install with the built in Node-RED Palette manager or using npm:
```
npm install node-red-contrib-openai-ubos
```
## Setup
When editing the nodes properties, to get your `OPENAI_API_KEY` log in to [ChatGPT](https://chat.openai.com/chat) and then visit https://platform.openai.com/account/api-keys click "+ Create new secret key" then copy and paste the "API key" into the nodes `API_KEY` property value.
To get your `Organization` visit https://platform.openai.com/account/org-settings then copy and paste the "OrganizationID" into the nodes `Organization` property value.
## Properties
- `msg.OPENAI_API_KEY`: This is the API key provided by OpenAI. It is necessary for authentication when making requests to the OpenAI API.
- `msg.prompt`: This string forms the initial text from which the model will generate its continuation.
- `msg.model`: This property defines the name of the OpenAI model to be used for generating the text, for example, "text-davinci-003".
- `msg.temperature`: This property controls the randomness in the output of the model. Higher values result in more random outputs. This is a numerical value.
- `msg.max_tokens`: This property sets the maximum length of the model output. This is a numerical value.
- `msg.messages`: This is an array meant to hold any messages that are to be passed along the Node-RED flow. Each object in the array can contain additional properties like `role` and `content`. For example:
```json
"messages": [
{"role": "system", "content": "Set the behavior"},
{"role": "assistant", "content": "Provide examples"},
{"role": "user", "content": "Set the instructions"}
]
```
- `msg.top_p`: This property is used when nucleus sampling is preferred for generating the text. The value for this property is expected to be a number between 0 and 1.
- `msg.frequency_penalty`: This property allows for penalization of new tokens based on their frequency. The value should be a number between 0 and 1.
- `msg.stop`: Up to 4 sequences where the API will stop generating further tokens. For example:
```js
msg.stop = ["word-1", "word-2"]
```
- `msg.presence_penalty`: This property can be used to control the model's preference for introducing new concepts during text generation. Like `msg.frequency_penalty`, it should be a number between 0 and 1.
**Example**
```js
msg.OPENAI_API_KEY = "your api key";
msg.model = "gpt-3.5-turbo";
msg.messages = [
{"role": "system", "content": "Set the behavior"},
{"role": "assistant", "content": "Provide examples"},
{"role": "user", "content": "Set the instructions"}
]
```
### Custom settings
To send your custom settings for the OpenAI request, you can use the `msg.settings` parameter. Simply pass an object with all the necessary fields according to the OpenAI documentation.
```js
msg.url = "https://api.openai.com/v1/embeddings";
msg.OPENAI_API_KEY = "your API key";
msg.settings = {
model: "text-embedding-3-large",
input: "Hello World"
}
```
### Create embeddings
When msg.model is set to text-embedding-ada-002:
- [Required] input: [Type: string or array] Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. Each input must not exceed the max input tokens for the model (8191 tokens for `text-embedding-ada-002`) and cannot be an empty string. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb) for counting tokens.
- user: [Type: string] A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices).
```js
msg.OPENAI_API_KEY = "your api key";
msg.model = "text-embedding-ada-002";
msg.input = "Lorem Ipsum is simply dummy text of the printing and typesetting industry";
```
## Demo
### Bugs reports and feature requests
Please report any issues or feature requests at GitHub.
## License
[MIT License](https://github.com/UBOS-tech/node-red-contrib-openai-ubos/blob/main/LICENSE)