mirror of
https://github.com/n8n-io/n8n-docs.git
synced 2026-03-27 09:28:43 +07:00
Add initial docs for xAI Grok node and creds (#3148)
This commit is contained in:
committed by
GitHub
parent
dda55fd121
commit
ca14bb2e11
@@ -0,0 +1,46 @@
|
||||
---
|
||||
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
|
||||
title: xAI Grok Chat Model node documentation
|
||||
description: Learn how to use the xAI Grok Chat Model node in n8n. Follow technical documentation to integrate xAI Grok Chat Model node into your workflows.
|
||||
contentType: [integration, reference]
|
||||
priority: medium
|
||||
---
|
||||
|
||||
# xAI Grok Chat Model node
|
||||
|
||||
Use the xAI Grok Chat Model node to access xAI Grok's large language models for conversational AI and text generation tasks.
|
||||
|
||||
On this page, you'll find the node parameters for the xAI Grok Chat Model node, and links to more resources.
|
||||
|
||||
/// note | Credentials
|
||||
You can find authentication information for this node [here](/integrations/builtin/credentials/xai.md).
|
||||
///
|
||||
|
||||
--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md"
|
||||
|
||||
## Node parameters
|
||||
|
||||
* **Model**: Select the model which will generate the completion. n8n dynamically loads available models from the xAI Grok API. Learn more in the [xAI Grok model documentation](https://docs.x.ai/docs/models).
|
||||
|
||||
## Node options
|
||||
|
||||
* **Frequency Penalty**: Use this option to control the chances 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. Most models have a context length of 2048 tokens with the newest models supporting up to 32,768 tokens.
|
||||
* **Response Format**: Choose **Text** or **JSON**. **JSON** ensures the model returns valid JSON.
|
||||
* **Presence Penalty**: Use this option to control the chances 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.
|
||||
|
||||
## Templates and examples
|
||||
|
||||
<!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
|
||||
[[ templatesWidget(page.title, 'xai-grok-chat-model') ]]
|
||||
|
||||
## Related resources
|
||||
|
||||
Refer to [xAI Grok's API documentation](https://docs.x.ai/docs/api-reference) for more information about the service.
|
||||
|
||||
--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md"
|
||||
--8<-- "_glossary/ai-glossary.md"
|
||||
33
docs/integrations/builtin/credentials/xai.md
Normal file
33
docs/integrations/builtin/credentials/xai.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
|
||||
title: xAI credentials
|
||||
description: Documentation for xAI credentials. Use these credentials to authenticate xAI in n8n, a workflow automation platform.
|
||||
contentType: [integration, reference]
|
||||
priority: critical
|
||||
---
|
||||
|
||||
# xAI credentials
|
||||
|
||||
You can use these credentials to authenticate the following nodes:
|
||||
|
||||
- [Chat xAI Grok](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatxaigrok.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create an [xAI](https://accounts.x.ai/sign-up) account.
|
||||
|
||||
## Supported authentication methods
|
||||
|
||||
- API key
|
||||
|
||||
## Related resources
|
||||
|
||||
Refer to [xAI's API documentation](https://docs.x.ai/docs/api-reference) for more information about the service.
|
||||
|
||||
## Using API key
|
||||
|
||||
To configure this credential, you'll need:
|
||||
|
||||
- An **API Key**: You can create a new API key on the [xAI Console API Keys page](https://console.x.ai/team/default/api-keys).
|
||||
|
||||
Refer to the [The Hitchhiker's Guide to Grok | xAI](https://docs.x.ai/docs/tutorial) for more information.
|
||||
2
nav.yml
2
nav.yml
@@ -727,6 +727,7 @@ nav:
|
||||
- OpenAI Chat Model: integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/index.md
|
||||
- Common issues: integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/common-issues.md
|
||||
- OpenRouter Chat Model: integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenrouter.md
|
||||
- xAI Grok Chat Model: integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatxaigrok.md
|
||||
- Cohere Model: integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmcohere.md
|
||||
- Ollama Model:
|
||||
- Ollama Model: integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmollama/index.md
|
||||
@@ -1066,6 +1067,7 @@ nav:
|
||||
- integrations/builtin/credentials/workable.md
|
||||
- integrations/builtin/credentials/wufoo.md
|
||||
- integrations/builtin/credentials/twitter.md
|
||||
- integrations/builtin/credentials/xai.md
|
||||
- integrations/builtin/credentials/xata.md
|
||||
- integrations/builtin/credentials/xero.md
|
||||
- integrations/builtin/credentials/yourls.md
|
||||
|
||||
@@ -96,6 +96,7 @@ geocodes
|
||||
GIMP
|
||||
Gotify
|
||||
Grafana
|
||||
Grok('s)?
|
||||
Groq
|
||||
GSuite
|
||||
Gumroad
|
||||
@@ -265,6 +266,7 @@ WeKan
|
||||
[Ww]ireframe
|
||||
WordPress
|
||||
Wufoo
|
||||
xAI
|
||||
Xata
|
||||
Xero
|
||||
Zabbix
|
||||
|
||||
Reference in New Issue
Block a user