mirror of
https://github.com/n8n-io/n8n-nodes-starter.git
synced 2025-11-17 13:37:29 -06:00
Add DO Gradient Serverless Inference Node
This commit is contained in:
dledoux
parent
67ee5b8e80
commit
c3c675ff33
19 changed files with 5765 additions and 628 deletions
74
README.md
74
README.md
|
|
@ -1,48 +1,56 @@
|
|||
|
||||
# n8n-nodes-digitalocean-serverless-inference
|
||||
|
||||
# n8n-nodes-starter
|
||||
This is an n8n community node for the [DigitalOcean Gradient™ AI Platform Serverless Inference API](https://gradientai-sdk.digitalocean.com/api/resources/chat/). It provides access to DigitalOcean Gradient™ AI Platform's large language models through n8n workflows.
|
||||
|
||||
This repo contains example nodes to help you get started building your own custom integrations for [n8n](https://n8n.io). It includes the node linter and other dependencies.
|
||||
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
|
||||
|
||||
To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
|
||||
[Installation](#installation)
|
||||
[Credentials](#credentials)
|
||||
[Compatibility](#compatibility)
|
||||
[Resources](#resources)
|
||||
|
||||
If you would like your node to be available on n8n cloud you can also [submit your node for verification](https://docs.n8n.io/integrations/creating-nodes/deploy/submit-community-nodes/).
|
||||
## Installation
|
||||
|
||||
## Prerequisites
|
||||
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
|
||||
|
||||
You need the following installed on your development machine:
|
||||
### Quick Installation
|
||||
|
||||
* [git](https://git-scm.com/downloads)
|
||||
* Node.js and npm. Minimum version Node 20. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
|
||||
* Install n8n with:
|
||||
```
|
||||
npm install n8n -g
|
||||
```
|
||||
* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/).
|
||||
1. Go to **Settings > Community Nodes**
|
||||
2. Select **Install**
|
||||
3. Enter `@digitalocean/n8n-nodes-digitalocean-serverless-inference` in **Enter npm package name**
|
||||
4. Agree to the risks of using community nodes
|
||||
5. Select **Install**
|
||||
|
||||
## Using this starter
|
||||
**Note:** After installation, you need to restart your n8n instance for the new node to be recognized.
|
||||
|
||||
These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/).
|
||||
### Chat Completion
|
||||
|
||||
1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository.
|
||||
2. Clone your new repo:
|
||||
```
|
||||
git clone https://github.com/<your organization>/<your-repo-name>.git
|
||||
```
|
||||
3. Run `npm i` to install dependencies.
|
||||
4. Open the project in your editor.
|
||||
5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes.
|
||||
6. Update the `package.json` to match your details.
|
||||
7. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible.
|
||||
8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance.
|
||||
9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started.
|
||||
10. Update the LICENSE file to use your details.
|
||||
11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm.
|
||||
Create chat completions using DigitalOcean Gradient™ AI Serverless Inference LLMs. The node supports:
|
||||
|
||||
## More information
|
||||
- Multiple messages with system, user, and assistant roles
|
||||
- [Multiple Models](https://docs.digitalocean.com/products/gradient-ai-platform/details/models/)
|
||||
- Customizable parameters conforming to the [API Specification](https://gradientai-sdk.digitalocean.com/api/resources/chat/subresources/completions/methods/create)
|
||||
|
||||
Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes.
|
||||
## Credentials
|
||||
|
||||
To use this node, you need a [Model Access Key](https://docs.digitalocean.com/products/gradient-ai-platform/how-to/use-serverless-inference/#create) from DigitalOcean Gradient™ AI Platform
|
||||
|
||||
## Compatibility
|
||||
|
||||
- Requires n8n version 1.0.0 or later
|
||||
- Tested up to n8n version 1.106.3
|
||||
|
||||
## Resources
|
||||
|
||||
- [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
|
||||
- [DigitalOcean Gradient™ AI Serverless Inference documentation](https://docs.digitalocean.com/products/gradient-ai-platform/how-to/use-serverless-inference/)
|
||||
|
||||
## Version History
|
||||
|
||||
### 1.0.0
|
||||
|
||||
- Initial usable release
|
||||
|
||||
## License
|
||||
|
||||
[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)
|
||||
[MIT](LICENSE.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue