docs: Add content Groq integration
This commit is contained in:
parent
f08eacb077
commit
751c273cde
84
docs/docs/guides/integration/groq.mdx
Normal file
84
docs/docs/guides/integration/groq.mdx
Normal file
@ -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 platform
|
||||
- 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",
|
||||
"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": "groq",
|
||||
"object": "model",
|
||||
"name": "Groq Integration",
|
||||
"version": "1.0",
|
||||
"description": "Integration with Groq API for enhanced functionality.",
|
||||
"format": "api",
|
||||
"sources": [],
|
||||
"settings": {},
|
||||
"parameters": {},
|
||||
"metadata": {
|
||||
"author": "Your Name",
|
||||
"tags": ["Groq Integration"]
|
||||
},
|
||||
"engine": "groq"
|
||||
}
|
||||
```
|
||||
|
||||
### 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.
|
||||
Loading…
x
Reference in New Issue
Block a user