-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Add TrueFoundry AI Gateway model node #3869
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
venkat1924
wants to merge
3
commits into
n8n-io:main
Choose a base branch
from
venkat1924:add-truefoundry-node-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
77 changes: 77 additions & 0 deletions
77
...ations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchattruefoundry.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| title: TrueFoundry AI Gateway Chat Model node documentation | ||
| description: Learn how to use the TrueFoundry AI Gateway Chat Model node in n8n. Follow technical documentation to integrate TrueFoundry AI Gateway Chat Model node into your workflows. | ||
| contentType: [integration, reference] | ||
| priority: high | ||
| --- | ||
|
|
||
| # TrueFoundry AI Gateway Chat Model node | ||
|
|
||
| Use the TrueFoundry AI Gateway Chat Model node to use AI Gateway chat models with conversational agents. | ||
|
|
||
| On this page, you'll find the node parameters for the TrueFoundry AI Gateway Chat Model node and links to more resources. | ||
|
|
||
| /// note | Credentials | ||
| You can find authentication information for this node [here](/integrations/builtin/credentials/truefoundry.md). | ||
| /// | ||
|
|
||
| --8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" | ||
|
|
||
| ## Node parameters | ||
|
|
||
| ### Model | ||
|
|
||
| Select the model to use to generate the completion. | ||
|
|
||
| n8n dynamically loads models from the AI Gateway and you'll only see the models available to your account. | ||
|
|
||
| ## Node options | ||
|
|
||
| Use these options to further refine the node's behavior. | ||
|
|
||
| ### Frequency Penalty | ||
|
|
||
| Use this option to control the chance of the model repeating itself. Higher values reduce the chance of the model repeating itself. | ||
|
|
||
| ### Maximum Number of Tokens | ||
|
|
||
| Enter the maximum number of tokens used, which sets the completion length. | ||
|
|
||
| ### Response Format | ||
|
|
||
| Choose **Text** or **JSON**. **JSON** ensures the model returns valid JSON. | ||
|
|
||
| ### Presence Penalty | ||
|
|
||
| Use this option to control the chance of the model talking about new topics. Higher values increase the chance of the model talking about new topics. | ||
|
|
||
| ### Sampling Temperature | ||
|
|
||
| Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. | ||
|
|
||
| ### Timeout | ||
|
|
||
| Enter the maximum request time in milliseconds. | ||
|
|
||
| ### Max Retries | ||
|
|
||
| Enter the maximum number of times to retry a request. | ||
|
|
||
| ### Top P | ||
|
|
||
| Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. | ||
|
|
||
| ### Reasoning Effort | ||
|
|
||
| Use this option to enable model reasoning processes through thinking/reasoning tokens, if supported. | ||
|
|
||
| ## Templates and examples | ||
|
|
||
| <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 --> | ||
| [[ templatesWidget(page.title, 'truefoundry-ai-gateway-chat-model') ]] | ||
|
|
||
| ## Related resources | ||
|
|
||
| As the TrueFoundry AI Gateway is API-compatible with OpenAI, you can refer to [LangChain's OpenAI documentation](https://js.langchain.com/docs/integrations/chat/openai/) for more information about the service. | ||
|
|
||
| --8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| title: TrueFoundry AI Gateway credentials | ||
| description: Documentation for the TrueFoundry AI Gateway credentials. Use these credentials to authenticate the TrueFoundry AI Gateway in n8n, a workflow automation platform. | ||
| contentType: [integration, reference] | ||
| priority: critical | ||
| --- | ||
|
|
||
|
|
||
| # TrueFoundry AI Gateway credentials | ||
|
|
||
| You can use these credentials to authenticate the following nodes: | ||
|
|
||
| - [Chat TrueFoundry AI Gateway](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchattruefoundry.md) | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Create a [TrueFoundry](https://truefoundry.com/) account. | ||
|
|
||
| ## Supported authentication methods | ||
|
|
||
| - API key | ||
|
|
||
| ## Related resources | ||
|
|
||
| Click [here](https://www.truefoundry.com/ai-gateway) to learn more about the TrueFoundry AI Gateway. Refer to the [TrueFoundry AI Gateway documentation](https://docs.truefoundry.com/ai-gateway/intro-to-llm-gateway) for more information about the service. | ||
|
|
||
| ## Using API key | ||
|
|
||
| To configure this credential, you'll need: | ||
|
|
||
| - An **API Key** | ||
|
|
||
| ### Virtual Access Token: | ||
|
|
||
| 1. [Login to TrueFoundry](https://truefoundry.com/login) or, [create an account](https://truefoundry.com/register) and click on the **Setup AI Gateway** card. | ||
| 2. Go to the left sidebar and select the **Access** tab. | ||
| 3. Visit **Virtual Accounts** in the **Access** tab. | ||
| 4. Click on the **Add Permission** button. | ||
| 5. Search for a pre-existing Model Provider Account. | ||
| 6. Choose the Role for this Provider Account. | ||
| 7. Add more Provider Accounts, if needed, and then click on the **Generate Virtual Account** button to create the Virtual Account. | ||
| 8. Copy your key and add it as the **API Key** in n8n. | ||
|
|
||
| ### Personal Access Token: | ||
|
|
||
| 1. [Login to TrueFoundry](https://truefoundry.com/login) or, [create an account](https://truefoundry.com/register) and click on the **Setup AI Gateway** card. | ||
| 2. Go to the left sidebar and select the **Access** tab. | ||
| 3. Visit **Personal Access Tokens** in the **Access** tab. | ||
| 4. Click on the **New Personal Access Token** button. | ||
| 5. Specify the **Name** and optionally, an **Expiration Date**. | ||
| 6. Copy your key and add it as the **API Key** in n8n. | ||
|
|
||
| For more information on Access Control in the Gateway, click [here](https://docs.truefoundry.com/ai-gateway/gateway-access-control). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.