Skip to content

hu-qi/node-red-openai-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Low-code AI for Innovators with Deadlines
assistants-example
@inductiv/node-red-openai-api

@inductiv/node-red-openai-api offers a versatile and configurable Node-RED node, designed specifically for seamless integration with OpenAI's advanced platform services. It empowers you to effortlessly connect and orchestrate various OpenAI functionalities, leveraging the full power of Node-RED's sophisticated application nodes. Whether you're aiming to enhance your workflows with cutting-edge AI capabilities or create innovative applications, this node serves as your gateway to harnessing the latest in AI technology from OpenAI, all within the intuitive and flexible environment of Node-RED.

New in Version 0.6.0

  • The node now has a customizable input type field in the editor dialog.
    • You can now configure your API call payload using either a msg, flow, or global property setting. This brings even greater contextual control to your AI requests.
    • Note: Existing implementations default to msg.payload and should continue to work as implemented using previous versions of this node.

Please report any issues here on Github.

Key Features

  • Seamless Integration: Directly connect with OpenAI services without the hassle of complex coding or setup.
  • Configurable and Flexible: Designed for adaptability, this node can be easily configured to suit a wide range of project requirements, streamlining your development workflow.
  • Powerful Combinations: Take advantage of Node-RED's diverse nodes to build complex, AI-driven workflows with ease.

Ideal for developers, researchers, and innovators, this node is your tool for unlocking the full potential of AI in your projects.

Custom API Service Host URL Configuration

New in version 0.3.0: You can now set a custom API service host base URL. This powerful feature extends the package's capabilities, allowing you to interface with any API that adheres to the OpenAI REST API request and response signatures and payloads.

Benefits

  • Versatility: Seamlessly connect to a broader range of AI services, beyond the default OpenAI offerings, including local model solutions like Text Generation Web UI.
  • Customization: Tailor your Node-RED node to interact with custom or specialized AI services, offering greater control and flexibility in your AI integrations.
  • Expanded Scope: Ideal for unique use cases where standard OpenAI services may not suffice, or when working within specialized AI environments.

How to Use

To utilize this feature, simply specify the custom API service host base URL in the node configuration. This enhancement is built upon the existing framework, ensuring a smooth and intuitive user experience.

Service Host Configuration Examples

service host node config OpenAI service host node config

Migrating from Previous Versions

This package's configuration node is now named "Service Host" to serve as a more generalized representation, considering the node's expanded capability scope. This node's previous versions used a config node named "OpenAI Auth" which is no longer referenced starting with this version (0.3.0). Be sure to update your existing node configurations accordingly.

Table of Contents

Installation

Via the Node-RED Palette Manager, install

@inductiv/node-red-openai-api

Via NPM

cd $HOME/.node-red
npm i @inductiv/node-red-openai-api

Usage

Find your @inductiv/node-red-openai-api node in the AI palette category, labeled "OpenAI API.

inductiv-node-red-openai-api-node

You'll find a set of example implementation flows in the examples directory.

audio-translation

Note: Each node's functionality maps to the official OpenAI API Reference documentation.

Node contains inutitive inline help with links to OpenAI's official API documentation.

inductiv-node-red-openai-api-node-config

Community Contributions and Discussions

I very much appreciate community input and invite everyone to shape the future of this project. Whether you have ideas, questions, or simply want to show off your implementations, this project's GitHub Discussions page is the perfect place to connect and contribute.

Engage in Various Discussions

  • Announcements: Stay updated with the latest project news.
  • General: Share thoughts or seek advice on broader topics.
  • Ideas: Propose new features or improvements.
  • Polls: Participate in polls to influence project decisions.
  • Q&A: Get answers to your questions and share your expertise.
  • Show and Tell: Showcase your creative implementations and inspire others.

Join the conversation here and let's build a vibrant and collaborative community together!

License

MIT

About

Build low-code, advanced AI applications and workflows using **any** OpenAI API-compatible framework for ListenAI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 78.6%
  • JavaScript 21.4%