-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: implement sidebar and add FAQs and groq integrations guide (#2273)
docs: implement sidebar and add FAQs and groq integrations guide
- Loading branch information
Showing
4 changed files
with
325 additions
and
6 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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,84 @@ | ||
| --- | ||
| title: Groq | ||
| sidebar_position: 10 | ||
| slug: /guides/integration/groq | ||
| description: Learn how to integrate Groq API with Jan for enhanced functionality. | ||
| keywords: | ||
| [ | ||
| Groq API, | ||
| Jan, | ||
| Jan AI, | ||
| ChatGPT alternative, | ||
| conversational AI, | ||
| large language model, | ||
| integration, | ||
| Groq integration, | ||
| API integration | ||
| ] | ||
| --- | ||
|
|
||
| ## How to Integrate Mistral AI with Jan | ||
|
|
||
| This guide provides step-by-step instructions on integrating the Groq API with Jan, enabling users to leverage Groq's capabilities within Jan's conversational interface. | ||
|
|
||
| Before proceeding, ensure you have the following: | ||
| - Access to the Jan Application | ||
| - Groq API credentials | ||
|
|
||
| ## Integration Steps | ||
|
|
||
| ### Step 1: Obtain Groq API Credentials | ||
|
|
||
| If you haven't already, sign up for the Groq API and obtain your API credentials. | ||
| Obtain Groq API keys from your [Groq Console](https://console.groq.com/keys). | ||
|
|
||
| ### Step 2: Configure Jan Settings | ||
|
|
||
| 1. Insert the Groq AI API key into `~/jan/engines/openai.json`. | ||
|
|
||
| ```json title="~/jan/engines/openai.json" | ||
| { | ||
| "full_url": "https://api.groq.com/openai/v1/chat/completions", | ||
| "api_key": "<your-groq-api-key>" | ||
| } | ||
| ``` | ||
|
|
||
| ### Step 3: Enable Groq Integration | ||
|
|
||
| To set up the configuration for Groq in Jan, follow these steps: | ||
|
|
||
| 1. Navigate to `~/jan/models`. | ||
| 2. Create a folder named `groq`. | ||
| 3. Inside the groq folder, create a model.json file with the specified settings: | ||
| ```json title="~/jan/models/groq/model.json | ||
| { | ||
| "id": "mixtral-8x7b-32768", | ||
| "object": "model", | ||
| "name": "Groq Integration", | ||
| "version": "1.0", | ||
| "description": "Integration with Groq API for enhanced functionality.", | ||
| "format": "api", | ||
| "sources": [], | ||
| "settings": {}, | ||
| "parameters": {}, | ||
| "metadata": { | ||
| "author": "Mistral", | ||
| "tags": ["Groq Integration"] | ||
| }, | ||
| "engine": "openai" | ||
| } | ||
| ``` | ||
|
|
||
| ### Step 4: Start the Model | ||
|
|
||
| 1. Restart Jan and navigate to the **Hub**. | ||
| 2. Locate your model and click the **Use** button. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| If you encounter any issues during the integration process or while using Groq with Jan, consider the following troubleshooting steps: | ||
|
|
||
| - Double-check your API credentials and ensure they are correctly entered. | ||
| - Verify that the Groq integration is enabled within Jan's settings. | ||
| - Check for any error messages or logs that may provide insight into the issue. | ||
| - Reach out to Groq API support for assistance if needed. |
This file contains 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
This file contains 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 |
|---|---|---|
| @@ -1,8 +1,48 @@ | ||
| /* Hide descriptions in cards without a description */ | ||
| .DocCardList--no-description .card p { | ||
| display: none; | ||
| } | ||
|
|
||
| /* For dark theme */ | ||
| [data-theme="dark"] .DocSearch { | ||
| [data-theme='dark'] .DocSearch { | ||
| --docsearch-hit-active-color: #090a11; /* Keep the color unchanged */ | ||
| } | ||
| /* Sidebar styles based on Docusaurus light theme */ | ||
| [data-theme='light'] .head_Menu div { | ||
| font-weight: bold; | ||
| background-color: var(--ifm-background-color); | ||
| margin-left: 0.7rem; | ||
| font-size: larger; | ||
| color: var(--ifm-font-color-base); | ||
| } | ||
|
|
||
| [data-theme='light'] .head_Menu li { | ||
| font-weight: normal; | ||
| background-color: var(--ifm-background-color); | ||
| margin-bottom: 5px; | ||
| color: var(--ifm-font-color-base); | ||
| } | ||
|
|
||
| [data-theme='light'] .head_SubMenu div { | ||
| font-weight: normal; | ||
| background-color: var(--ifm-background-color); | ||
| margin-left: 0rem; | ||
| font-size: medium; | ||
| color: var(--ifm-font-color-base); | ||
| } | ||
|
|
||
| /* Dark mode styles based on Docusaurus dark theme */ | ||
| [data-theme='dark'] .head_Menu div { | ||
| background-color: var(--ifm-background-color); | ||
| color: var(--ifm-font-color-base); | ||
| } | ||
|
|
||
| [data-theme='dark'] .head_Menu li { | ||
| background-color: var(--ifm-background-color); | ||
| color: var(--ifm-font-color-base); | ||
| } | ||
|
|
||
| [data-theme='dark'] .head_SubMenu div { | ||
| background-color: var(--ifm-background-color); | ||
| color: var(--ifm-font-color-base); | ||
| } |