Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs for: AI Transform Node #2332

Merged
merged 2 commits into from
Aug 15, 2024
Merged

Docs for: AI Transform Node #2332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16d76be
add AI Transform node page
ayatnkw Aug 8, 2024
3aaab84
fix link
ayatnkw Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: AI Transform
description: Documentation for the AI Transform node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
contentType: integration
---

# AI Transform

Use the AI Transform node to generate code snippets based on your prompt. The AI is context-aware, understanding the workflow’s nodes and their data types.

/// info | Feature availability
Available only on [Cloud plans](/manage-cloud/overview/).
///

## Node parameters

### Instructions

Enter your prompt for the AI and click the **Generate code** button to automatically populate the **Transformation Code**. For example, you can specify how you want to process or categorize your data. Refer to [Writing good prompts](/code/ai-code/#writing-good-prompts) for more information.

The prompt should be in plain English and under 500 characters.

### Transformation Code

The code snippet generated by the node is read-only. To edit this code, adjust your prompt in **Instructions** or copy and paste it into a [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/) node.

Check warning on line 26 in docs/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.Passive] 'is read' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[from-write-good.Passive] 'is read' may be passive voice. Use active voice if you can.", "location": {"path": "docs/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md", "range": {"start": {"line": 26, "column": 40}}}, "severity": "WARNING"}

## Templates and examples

[[ templatesWidget(title, 'ai-transform') ]]

1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,7 @@ nav:
- integrations/builtin/core-nodes/index.md
- integrations/builtin/core-nodes/n8n-nodes-base.activationtrigger.md
- integrations/builtin/core-nodes/n8n-nodes-base.aggregate.md
- integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md
- integrations/builtin/core-nodes/n8n-nodes-base.code.md
- integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md
- integrations/builtin/core-nodes/n8n-nodes-base.compression.md
Expand Down
Loading