Merge pull request #4613 from janhq/chore/update-engine-docs
chore: Update guide for cloud model installation & some new remote engines
|
Before Width: | Height: | Size: 148 KiB After Width: | Height: | Size: 150 KiB |
|
Before Width: | Height: | Size: 145 KiB After Width: | Height: | Size: 146 KiB |
BIN
docs/src/pages/docs/_assets/deepseek.png
Normal file
|
After Width: | Height: | Size: 147 KiB |
BIN
docs/src/pages/docs/_assets/google.png
Normal file
|
After Width: | Height: | Size: 152 KiB |
|
Before Width: | Height: | Size: 159 KiB After Width: | Height: | Size: 162 KiB |
|
Before Width: | Height: | Size: 145 KiB After Width: | Height: | Size: 144 KiB |
|
Before Width: | Height: | Size: 146 KiB After Width: | Height: | Size: 149 KiB |
|
Before Width: | Height: | Size: 150 KiB After Width: | Height: | Size: 164 KiB |
BIN
docs/src/pages/docs/_assets/model-management-08.png
Normal file
|
After Width: | Height: | Size: 82 KiB |
BIN
docs/src/pages/docs/_assets/model-management-09.png
Normal file
|
After Width: | Height: | Size: 166 KiB |
|
Before Width: | Height: | Size: 145 KiB After Width: | Height: | Size: 146 KiB |
|
Before Width: | Height: | Size: 158 KiB After Width: | Height: | Size: 152 KiB |
@ -18,7 +18,7 @@ keywords:
|
||||
]
|
||||
---
|
||||
import { Callout, Steps } from 'nextra/components'
|
||||
import { Settings, EllipsisVertical, Plus, FolderOpen, Pencil } from 'lucide-react'
|
||||
import { Settings, Trash2, EllipsisVertical, Plus, FolderOpen, Pencil } from 'lucide-react'
|
||||
|
||||
|
||||
# Model Management
|
||||
@ -201,12 +201,12 @@ Modify model parameters under the settings array. Key fields to configure:
|
||||
|
||||
## Cloud model
|
||||
<Callout type="info">
|
||||
When using cloud models, be aware of any associated costs and rate limits from the providers.
|
||||
When using cloud models, be aware of any associated costs and rate limits from the providers. See detailed guide for each cloud model provider [here](/docs/remote-models/anthropic).
|
||||
</Callout>
|
||||
|
||||
Jan supports connecting to various AI cloud providers that are OpenAI API-compatible, including: OpenAI (GPT-4, o1,...), Anthropic (Claude), Groq, Mistral, and more.
|
||||
1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>)
|
||||
2. Under **Remote Engines** section in the left sidebar, choose your preferred engines (OpenAI, Anthropic, etc.)
|
||||
2. Under **Remote Engine** section in the left sidebar, choose your preferred engines (OpenAI, Anthropic, etc.)
|
||||
3. Enter your API key
|
||||
4. The activated cloud models will be available in your model selector in **Threads**
|
||||
|
||||
@ -214,7 +214,25 @@ Jan supports connecting to various AI cloud providers that are OpenAI API-compat
|
||||

|
||||
<br/>
|
||||
|
||||
Cloud models cannot be deleted, but you can hide them by disabling their respective provider engines in **Settings** > **Engines**.
|
||||
You can manage & hide respective provider engines in **Settings** > **Engines**:
|
||||
<br/>
|
||||

|
||||
<br/>
|
||||
|
||||
### Add Models
|
||||
1. In your respective provider's settings page, click **Add Model**
|
||||
2. Enter the **model ID**. Check detailed model IDs in the provider's model list, for example, `claude-3-opus-latest`.
|
||||
3. A success message will appear when the model is added
|
||||
|
||||
<br/>
|
||||

|
||||
<br/>
|
||||
|
||||
### Delete Models
|
||||
1. In your respective provider's settings page, choose the model you want to delete
|
||||
2. Click **Trash Bin** (<Trash2 width={16} height={16} style={{display:"inline"}}/>) icon
|
||||
3. The model will be removed from your available models list
|
||||
|
||||
<br/>
|
||||

|
||||
<br/>
|
||||
@ -7,6 +7,14 @@
|
||||
"title": "Cohere",
|
||||
"href": "/docs/remote-models/cohere"
|
||||
},
|
||||
"deepseek": {
|
||||
"title": "DeepSeek",
|
||||
"href": "/docs/remote-models/deepseek"
|
||||
},
|
||||
"google": {
|
||||
"title": "Google",
|
||||
"href": "/docs/remote-models/google"
|
||||
},
|
||||
"groq": {
|
||||
"title": "Groq",
|
||||
"href": "/docs/remote-models/groq"
|
||||
@ -20,7 +28,7 @@
|
||||
"href": "/docs/remote-models/mistralai"
|
||||
},
|
||||
"nvidia-nim": {
|
||||
"title": "Nvidia NIM",
|
||||
"title": "Nvidia",
|
||||
"href": "/docs/remote-models/nvidia-nim"
|
||||
},
|
||||
"openai": {
|
||||
|
||||
@ -60,7 +60,7 @@ There are two ways to add your Anthropic API keys in Jan:
|
||||
|
||||
## Available Anthropic Models
|
||||
|
||||
Jan automatically includes Anthropic's available models. In case you want to use a specific Anthropic model that you cannot find in **Jan**, follow instructions in [Manual Setup](/docs/models/manage-models#4-manual-setup) to add custom models:
|
||||
Jan automatically includes Anthropic's available models. In case you want to use a specific Anthropic model that you cannot find in **Jan**, follow instructions in [Add Cloud Models](/docs/models/manage-models#add-models-1):
|
||||
- See list of available models in [Anthropic Models](https://docs.anthropic.com/claude/docs/models-overview).
|
||||
- The `id` property must match the model name in the list. For example, `claude-3-opus-20240229`, `claude-3-sonnet-20240229`, or `claude-2.1`.
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@ There are two ways to add your Cohere API keys in Jan:
|
||||
|
||||
## Available Cohere Models
|
||||
|
||||
Jan automatically includes Cohere's available models. In case you want to use a specific Cohere model that you cannot find in **Jan**, follow instructions in [Manual Setup](/docs/models/manage-models#4-manual-setup) to add custom models:
|
||||
Jan automatically includes Cohere's available models. In case you want to use a specific Cohere model that you cannot find in **Jan**, follow instructions in [Add Cloud Models](/docs/models/manage-models#add-models-1):
|
||||
- See list of available models in [Cohere Documentation](https://docs.cohere.com/v2/docs/models).
|
||||
- The `id` property must match the model name in the list. For example, `command-nightly` or `command-light`.
|
||||
|
||||
|
||||
86
docs/src/pages/docs/remote-models/deepseek.mdx
Normal file
@ -0,0 +1,86 @@
|
||||
---
|
||||
title: DeepSeek
|
||||
description: Learn how to integrate DeepSeek with Jan for enhanced functionality.
|
||||
keywords:
|
||||
[
|
||||
Anthropic API,
|
||||
Jan,
|
||||
Jan AI,
|
||||
ChatGPT alternative,
|
||||
conversational AI,
|
||||
large language model,
|
||||
integration,
|
||||
Anthropic integration,
|
||||
API integration
|
||||
]
|
||||
---
|
||||
|
||||
import { Callout, Steps } from 'nextra/components'
|
||||
import { Settings, Plus } from 'lucide-react'
|
||||
|
||||
# DeepSeek
|
||||
|
||||
Jan supports [DeepSeek](https://www.deepseek.com/) API integration, allowing you to use DeepSeek models through Jan's interface.
|
||||
|
||||
## Integrate DeepSeek API with Jan
|
||||
|
||||
<Steps>
|
||||
### Step 1: Get Your API Key
|
||||
1. Visit [DeepSeek Console](https://platform.deepseek.com/) and sign in
|
||||
2. Create & copy a new API key or copy your existing one
|
||||
|
||||
<Callout type='info'>
|
||||
Ensure your API key has sufficient credits
|
||||
</Callout>
|
||||
|
||||
### Step 2: Configure Jan
|
||||
There are two ways to add your DeepSeek API keys in Jan:
|
||||
|
||||
**Through Threads:**
|
||||
1. In Threads, click **Model** tab in the **right sidebar** or **model selector** in input field
|
||||
2. Once the selector is poped up, choose the **Cloud** tab
|
||||
3. Click **Add** (<Plus width={16} height={16} style={{display:"inline"}}/>) icon next to **DeepSeek**
|
||||
4. Once you are directed to DeepSeek settings, insert your **API Key**
|
||||
|
||||
**Through Settings:**
|
||||
1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>)
|
||||
2. Under **Remote Engines**, select **DeepSeek**
|
||||
3. Insert your **API Key**
|
||||
|
||||
<br/>
|
||||

|
||||
<br/>
|
||||
|
||||
### Step 3: Start Using Anthropic's Models
|
||||
|
||||
1. In any existing **Threads** or create a new one
|
||||
2. Select an DeepSeek model from **model selector**
|
||||
3. Start chatting
|
||||
</Steps>
|
||||
|
||||
## Available DeepSeek Models
|
||||
|
||||
Jan automatically includes Anthropic's available models. In case you want to use a specific Anthropic model that you cannot find in **Jan**, follow instructions in [Add Cloud Models](/docs/models/manage-models#add-models-1):
|
||||
- See list of available models in [DeepSeek Models](https://api-docs.deepseek.com/quick_start/pricing).
|
||||
- The `id` property must match the model name in the list. For example, `deepseek-chat` or `deepseek-reasoner`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
|
||||
**1. API Key Issues**
|
||||
- Verify your API key is correct and not expired
|
||||
- Check if you have billing set up on your Anthropic account
|
||||
- Ensure you have access to the model you're trying to use
|
||||
|
||||
**2. Connection Problems**
|
||||
- Check your internet connection
|
||||
- Verify [DeepSeek's system status](https://status.deepseek.com/)
|
||||
- Look for error messages in [Jan's logs](/docs/troubleshooting#how-to-get-error-logs)
|
||||
|
||||
**3. Model Unavailable**
|
||||
- Confirm your API key has access to the model
|
||||
- Check if you're using the correct model ID
|
||||
- Verify your Anthropic account has the necessary permissions
|
||||
|
||||
Need more help? Join our [Discord community](https://discord.gg/FTk2MvZwJH).
|
||||
86
docs/src/pages/docs/remote-models/google.mdx
Normal file
@ -0,0 +1,86 @@
|
||||
---
|
||||
title: Google
|
||||
description: Learn how to integrate Google with Jan for enhanced functionality.
|
||||
keywords:
|
||||
[
|
||||
Anthropic API,
|
||||
Jan,
|
||||
Jan AI,
|
||||
ChatGPT alternative,
|
||||
conversational AI,
|
||||
large language model,
|
||||
integration,
|
||||
Anthropic integration,
|
||||
API integration
|
||||
]
|
||||
---
|
||||
|
||||
import { Callout, Steps } from 'nextra/components'
|
||||
import { Settings, Plus } from 'lucide-react'
|
||||
|
||||
# Google
|
||||
|
||||
Jan supports [Google](https://ai.google/get-started/our-models/) API integration, allowing you to use Google models (like Gemini series) through Jan's interface.
|
||||
|
||||
## Integrate Google API with Jan
|
||||
|
||||
<Steps>
|
||||
### Step 1: Get Your API Key
|
||||
1. Visit [Google Console](https://aistudio.google.com/app/apikey) and sign in
|
||||
2. Create & copy a new API key or copy your existing one
|
||||
|
||||
<Callout type='info'>
|
||||
Ensure your API key has sufficient credits
|
||||
</Callout>
|
||||
|
||||
### Step 2: Configure Jan
|
||||
There are two ways to add your Google API keys in Jan:
|
||||
|
||||
**Through Threads:**
|
||||
1. In Threads, click **Model** tab in the **right sidebar** or **model selector** in input field
|
||||
2. Once the selector is poped up, choose the **Cloud** tab
|
||||
3. Click **Add** (<Plus width={16} height={16} style={{display:"inline"}}/>) icon next to **Google**
|
||||
4. Once you are directed to Google settings, insert your **API Key**
|
||||
|
||||
**Through Settings:**
|
||||
1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>)
|
||||
2. Under **Remote Engines**, select **Google**
|
||||
3. Insert your **API Key**
|
||||
|
||||
<br/>
|
||||

|
||||
<br/>
|
||||
|
||||
### Step 3: Start Using Anthropic's Models
|
||||
|
||||
1. In any existing **Threads** or create a new one
|
||||
2. Select an Google model from **model selector**
|
||||
3. Start chatting
|
||||
</Steps>
|
||||
|
||||
## Available DeepSeek Models
|
||||
|
||||
Jan automatically includes Google's available models. In case you want to use a specific Google model that you cannot find in **Jan**, follow instructions in [Add Cloud Models](/docs/models/manage-models#add-models-1):
|
||||
- See list of available models in [Google Models](https://ai.google.dev/gemini-api/docs/models/gemini).
|
||||
- The `id` property must match the model name in the list. For example, `gemini-1.5-pro` or `gemini-2.0-flash-lite-preview`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
|
||||
**1. API Key Issues**
|
||||
- Verify your API key is correct and not expired
|
||||
- Check if you have billing set up on your Google account
|
||||
- Ensure you have access to the model you're trying to use
|
||||
|
||||
**2. Connection Problems**
|
||||
- Check your internet connection
|
||||
- Verify [Google's system status](https://www.google.com/appsstatus/dashboard/)
|
||||
- Look for error messages in [Jan's logs](/docs/troubleshooting#how-to-get-error-logs)
|
||||
|
||||
**3. Model Unavailable**
|
||||
- Confirm your API key has access to the model
|
||||
- Check if you're using the correct model ID
|
||||
- Verify your Google account has the necessary permissions
|
||||
|
||||
Need more help? Join our [Discord community](https://discord.gg/FTk2MvZwJH).
|
||||
@ -61,7 +61,7 @@ There are two ways to add your Groq API keys in Jan:
|
||||
|
||||
## Available Models Through Groq
|
||||
|
||||
Jan automatically includes Groq's available models. In case you want to use a specific Groq model that you cannot find in **Jan**, follow instructions in [Manual Setup](/docs/models/manage-models#4-manual-setup) to add custom models:
|
||||
Jan automatically includes Groq's available models. In case you want to use a specific Groq model that you cannot find in **Jan**, follow instructions in [Add Cloud Models](/docs/models/manage-models#add-models-1):
|
||||
- See list of available models in [Groq Documentation](https://console.groq.com/docs/models).
|
||||
- The `id` property must match the model name in the list. For example, if you want to use Llama3.3 70B, you must set the `id` property to `llama-3.3-70b-versatile`.
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ There are two ways to add your Mistral AI keys in Jan:
|
||||
|
||||
## Available Mistral Models
|
||||
|
||||
Jan automatically includes Mistral's available models. In case you want to use a specific Mistral model that you cannot find in **Jan**, follow instructions in [Manual Setup](/docs/models/manage-models#4-manual-setup) to add custom models:
|
||||
Jan automatically includes Mistral's available models. In case you want to use a specific Mistral model that you cannot find in **Jan**, follow instructions in [Add Cloud Models](/docs/models/manage-models#add-models-1):
|
||||
- See list of available models in [Mistral AI Documentation](https://docs.mistral.ai/platform/endpoints).
|
||||
- The `id` property must match the model name in the list. For example, if you want to use Mistral Large, you must set the `id` property to `mistral-large-latest`
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: NVIDIA NIM
|
||||
title: NVIDIA
|
||||
description: Learn how to integrate NVIDIA NIM with Jan for enhanced functionality.
|
||||
keywords:
|
||||
[
|
||||
@ -20,17 +20,17 @@ import { Settings, Plus } from 'lucide-react'
|
||||
|
||||
# NVIDIA NIM
|
||||
|
||||
Jan supports [NVIDIA NIM](https://www.nvidia.com/en-us/ai/) API integration, allowing you to use NVIDIA's Large Language Models through Jan's interface.
|
||||
Jan supports [Nvidia](https://www.nvidia.com/en-us/ai/) API integration, allowing you to use Nvidia's Large Language Models through Jan's interface.
|
||||
|
||||
<Callout type='info'>
|
||||
NVIDIA NIM extension is only supported on Jan version 0.5.1 or later.
|
||||
Nvidia engine is only supported on Jan version 0.5.1 or later.
|
||||
</Callout>
|
||||
|
||||
## Integrate Nvidia NIM API with Jan
|
||||
|
||||
<Steps>
|
||||
### Step 1: Get Your API Key
|
||||
1. Visit [NVIDIA Docs](https://docs.nvidia.com/nim/nemo-retriever/text-reranking/latest/getting-started.html#generate-an-api-key) and generate an API key
|
||||
1. Visit [Nvidia](https://docs.nvidia.com/nim/nemo-retriever/text-reranking/latest/getting-started.html#generate-an-api-key) and generate an API key
|
||||
2. Copy your API key
|
||||
|
||||
<Callout type='info'>
|
||||
@ -38,17 +38,17 @@ Ensure your API key has sufficient credits
|
||||
</Callout>
|
||||
|
||||
### Step 2: Configure Jan
|
||||
There are two ways to add your Nvidia NIM API keys in Jan:
|
||||
There are two ways to add your Nvidia API keys in Jan:
|
||||
|
||||
**Through Threads:**
|
||||
1. In Threads, click **Model** tab in the **right sidebar** or **model selector** in input field
|
||||
2. Once the selector is poped up, choose the **Cloud** tab
|
||||
3. Click **Add** (<Plus width={16} height={16} style={{display:"inline"}}/>) icon next to **Nvidia NIM**
|
||||
4. Once you are directed to Nvidia NIM settings, insert your **API Key**
|
||||
3. Click **Add** (<Plus width={16} height={16} style={{display:"inline"}}/>) icon next to **Nvidia**
|
||||
4. Once you are directed to Nvidia settings, insert your **API Key**
|
||||
|
||||
**Through Settings:**
|
||||
1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>)
|
||||
2. Under **Remote Engines**, select **Nvidia NIM**
|
||||
2. Under **Remote Engines**, select **Nvidia**
|
||||
3. Insert your **API Key**
|
||||
|
||||
<br/>
|
||||
@ -58,14 +58,14 @@ There are two ways to add your Nvidia NIM API keys in Jan:
|
||||
### Step 3: Start Using Nvidia NIM Models
|
||||
|
||||
1. In any existing **Threads** or create a new one
|
||||
2. Select a NVIDIA NIM model from **model selector**
|
||||
2. Select a Nvidia model from **model selector**
|
||||
3. Start chatting
|
||||
</Steps>
|
||||
|
||||
## Available Nvidia NIM Models
|
||||
|
||||
Jan automatically includes NVIDIA NIM's available models. In case you want to use a specific model that you cannot find in **Jan**, follow instructions in [Manual Setup](/docs/models/manage-models#4-manual-setup) to add custom models:
|
||||
- See list of available models in [Nvidia NIM Documentation](https://build.nvidia.com/models).
|
||||
Jan automatically includes Nvidia's available models. In case you want to use a specific model that you cannot find in **Jan**, follow instructions in [Add Cloud Models](/docs/models/manage-models#add-models-1):
|
||||
- See list of available models in [Nvidia Documentation](https://build.nvidia.com/models).
|
||||
- The `id` property must match the model name in the list.
|
||||
|
||||
## Troubleshooting
|
||||
@ -74,18 +74,18 @@ Common issues and solutions:
|
||||
|
||||
**1. API Key Issues**
|
||||
- Verify your API key is correct and not expired
|
||||
- Check if you have billing set up on your NVIDIA account
|
||||
- Check if you have billing set up on your Nvidia account
|
||||
- Ensure you have access to the model you're trying to use
|
||||
|
||||
**2. Connection Problems**
|
||||
- Check your internet connection
|
||||
- Verify NVIDIA's system status
|
||||
- Verify Nvidia's system status
|
||||
- Look for error messages in [Jan's logs](/docs/troubleshooting#how-to-get-error-logs)
|
||||
|
||||
**3. Model Unavailable**
|
||||
- Confirm your API key has access to the model
|
||||
- Check if you're using the correct model ID
|
||||
- Verify your NVIDIA account has the necessary permissions
|
||||
- Verify your Nvidia account has the necessary permissions
|
||||
- Make sure you're using Jan version 0.5.1 or later
|
||||
|
||||
Need more help? Join our [Discord community](https://discord.gg/FTk2MvZwJH) or check the [Nvidia documentation](https://docs.nvidia.com/nim/large-language-models/latest/getting-started.html).
|
||||
@ -62,7 +62,7 @@ Start chatting
|
||||
|
||||
## Available OpenAI Models
|
||||
|
||||
Jan automatically includes popular OpenAI models. In case you want to use a specific OpenAI model that you cannot find in Jan, follow instructions in [Manual Setup](/docs/models/manage-models#4-manual-setup) to add custom models:
|
||||
Jan automatically includes popular OpenAI models. In case you want to use a specific OpenAI model that you cannot find in Jan, follow instructions in [Add Cloud Models](/docs/models/manage-models#add-models-1):
|
||||
- See list of available models in [OpenAI Platform](https://platform.openai.com/docs/models/overview).
|
||||
- The id property must match the model name in the list. For example, if you want to use the [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo), you must set the id property to gpt-4-1106-preview.
|
||||
|
||||
|
||||