diff --git a/docs/src/pages/docs/_assets/anthropic.png b/docs/src/pages/docs/_assets/anthropic.png index 108576903..7f276a4e6 100644 Binary files a/docs/src/pages/docs/_assets/anthropic.png and b/docs/src/pages/docs/_assets/anthropic.png differ diff --git a/docs/src/pages/docs/_assets/cohere.png b/docs/src/pages/docs/_assets/cohere.png index 87d3d0fa4..e35234185 100644 Binary files a/docs/src/pages/docs/_assets/cohere.png and b/docs/src/pages/docs/_assets/cohere.png differ diff --git a/docs/src/pages/docs/_assets/deepseek.png b/docs/src/pages/docs/_assets/deepseek.png new file mode 100644 index 000000000..653f16f27 Binary files /dev/null and b/docs/src/pages/docs/_assets/deepseek.png differ diff --git a/docs/src/pages/docs/_assets/google.png b/docs/src/pages/docs/_assets/google.png new file mode 100644 index 000000000..ec6dfa8f2 Binary files /dev/null and b/docs/src/pages/docs/_assets/google.png differ diff --git a/docs/src/pages/docs/_assets/groq.png b/docs/src/pages/docs/_assets/groq.png index d9927fe7a..d21f55e84 100644 Binary files a/docs/src/pages/docs/_assets/groq.png and b/docs/src/pages/docs/_assets/groq.png differ diff --git a/docs/src/pages/docs/_assets/martian.png b/docs/src/pages/docs/_assets/martian.png index e00349b01..9592f3257 100644 Binary files a/docs/src/pages/docs/_assets/martian.png and b/docs/src/pages/docs/_assets/martian.png differ diff --git a/docs/src/pages/docs/_assets/mistralai.png b/docs/src/pages/docs/_assets/mistralai.png index 70139c6ae..b99ca8275 100644 Binary files a/docs/src/pages/docs/_assets/mistralai.png and b/docs/src/pages/docs/_assets/mistralai.png differ diff --git a/docs/src/pages/docs/_assets/model-management-06.png b/docs/src/pages/docs/_assets/model-management-06.png index ebd2de3d1..05ad50d8c 100644 Binary files a/docs/src/pages/docs/_assets/model-management-06.png and b/docs/src/pages/docs/_assets/model-management-06.png differ diff --git a/docs/src/pages/docs/_assets/model-management-08.png b/docs/src/pages/docs/_assets/model-management-08.png new file mode 100644 index 000000000..b79e9e64c Binary files /dev/null and b/docs/src/pages/docs/_assets/model-management-08.png differ diff --git a/docs/src/pages/docs/_assets/model-management-09.png b/docs/src/pages/docs/_assets/model-management-09.png new file mode 100644 index 000000000..0d2078046 Binary files /dev/null and b/docs/src/pages/docs/_assets/model-management-09.png differ diff --git a/docs/src/pages/docs/_assets/nvidia-nim.png b/docs/src/pages/docs/_assets/nvidia-nim.png index 8eb637c12..4157eb598 100644 Binary files a/docs/src/pages/docs/_assets/nvidia-nim.png and b/docs/src/pages/docs/_assets/nvidia-nim.png differ diff --git a/docs/src/pages/docs/_assets/openrouter.png b/docs/src/pages/docs/_assets/openrouter.png index d9e032700..cd208b6ab 100644 Binary files a/docs/src/pages/docs/_assets/openrouter.png and b/docs/src/pages/docs/_assets/openrouter.png differ diff --git a/docs/src/pages/docs/models/manage-models.mdx b/docs/src/pages/docs/models/manage-models.mdx index 01f0fc06f..797d08853 100644 --- a/docs/src/pages/docs/models/manage-models.mdx +++ b/docs/src/pages/docs/models/manage-models.mdx @@ -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 -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). 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** () -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 ![Download Model](../_assets/model-management-06.png)
-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**:
![Download Model](../_assets/model-management-07.png) +
+ +### 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 + +
+![Add Model](../_assets/model-management-08.png) +
+ +### Delete Models +1. In your respective provider's settings page, choose the model you want to delete +2. Click **Trash Bin** () icon +3. The model will be removed from your available models list + +
+![Delete Model](../_assets/model-management-09.png)
\ No newline at end of file diff --git a/docs/src/pages/docs/remote-models/_meta.json b/docs/src/pages/docs/remote-models/_meta.json index 529047774..62709526e 100644 --- a/docs/src/pages/docs/remote-models/_meta.json +++ b/docs/src/pages/docs/remote-models/_meta.json @@ -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": { diff --git a/docs/src/pages/docs/remote-models/anthropic.mdx b/docs/src/pages/docs/remote-models/anthropic.mdx index 8b7fdbccd..cf83782b9 100644 --- a/docs/src/pages/docs/remote-models/anthropic.mdx +++ b/docs/src/pages/docs/remote-models/anthropic.mdx @@ -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`. diff --git a/docs/src/pages/docs/remote-models/cohere.mdx b/docs/src/pages/docs/remote-models/cohere.mdx index 41e60431d..c53e7e84b 100644 --- a/docs/src/pages/docs/remote-models/cohere.mdx +++ b/docs/src/pages/docs/remote-models/cohere.mdx @@ -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`. diff --git a/docs/src/pages/docs/remote-models/deepseek.mdx b/docs/src/pages/docs/remote-models/deepseek.mdx new file mode 100644 index 000000000..d3253deb8 --- /dev/null +++ b/docs/src/pages/docs/remote-models/deepseek.mdx @@ -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 + + +### 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 + + +Ensure your API key has sufficient credits + + +### 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** () icon next to **DeepSeek** +4. Once you are directed to DeepSeek settings, insert your **API Key** + +**Through Settings:** +1. Navigate to **Settings** () +2. Under **Remote Engines**, select **DeepSeek** +3. Insert your **API Key** + +
+![DeepSeek](../_assets/deepseek.png) +
+ +### 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 + + +## 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). \ No newline at end of file diff --git a/docs/src/pages/docs/remote-models/google.mdx b/docs/src/pages/docs/remote-models/google.mdx new file mode 100644 index 000000000..c67e6b70c --- /dev/null +++ b/docs/src/pages/docs/remote-models/google.mdx @@ -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 + + +### 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 + + +Ensure your API key has sufficient credits + + +### 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** () icon next to **Google** +4. Once you are directed to Google settings, insert your **API Key** + +**Through Settings:** +1. Navigate to **Settings** () +2. Under **Remote Engines**, select **Google** +3. Insert your **API Key** + +
+![Google](../_assets/google.png) +
+ +### 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 + + +## 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). \ No newline at end of file diff --git a/docs/src/pages/docs/remote-models/groq.mdx b/docs/src/pages/docs/remote-models/groq.mdx index c0ccaf627..327e4a6b7 100644 --- a/docs/src/pages/docs/remote-models/groq.mdx +++ b/docs/src/pages/docs/remote-models/groq.mdx @@ -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`. diff --git a/docs/src/pages/docs/remote-models/mistralai.mdx b/docs/src/pages/docs/remote-models/mistralai.mdx index c1051a703..68efe5073 100644 --- a/docs/src/pages/docs/remote-models/mistralai.mdx +++ b/docs/src/pages/docs/remote-models/mistralai.mdx @@ -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` diff --git a/docs/src/pages/docs/remote-models/nvidia-nim.mdx b/docs/src/pages/docs/remote-models/nvidia-nim.mdx index f2e3b0d06..fc4e26549 100644 --- a/docs/src/pages/docs/remote-models/nvidia-nim.mdx +++ b/docs/src/pages/docs/remote-models/nvidia-nim.mdx @@ -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. -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. ## Integrate Nvidia NIM API with Jan ### 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 @@ -38,17 +38,17 @@ Ensure your API key has sufficient credits ### 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** () icon next to **Nvidia NIM** -4. Once you are directed to Nvidia NIM settings, insert your **API Key** +3. Click **Add** () icon next to **Nvidia** +4. Once you are directed to Nvidia settings, insert your **API Key** **Through Settings:** 1. Navigate to **Settings** () -2. Under **Remote Engines**, select **Nvidia NIM** +2. Under **Remote Engines**, select **Nvidia** 3. Insert your **API Key**
@@ -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 ## 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). \ No newline at end of file diff --git a/docs/src/pages/docs/remote-models/openai.mdx b/docs/src/pages/docs/remote-models/openai.mdx index 502891f3d..f3cb63ef6 100644 --- a/docs/src/pages/docs/remote-models/openai.mdx +++ b/docs/src/pages/docs/remote-models/openai.mdx @@ -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.