Add Groq provider (ragapp#77)

---------
Co-authored-by: leehuwuj <[email protected]>

Author: marcusschiesser

.changeset/gorgeous-carrots-matter.md

@@ -0,0 +1,5 @@
+---
+"ragbox": patch
+---
+
+Add Groq provider

admin/client/providers/groq.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+import { BaseConfigSchema } from "./base";
+
+export const GroqConfigSchema = BaseConfigSchema.extend({
+  model_provider: z.literal("groq"),
+  groq_api_key: z
+    .string()
+    .nullable()
+    .optional()
+    .refine(
+      (value) => value && value.trim() !== "",
+      "Groq API Key is required",
+    ),
+});
+
+export const DEFAULT_GROQ_CONFIG: z.input<typeof GroqConfigSchema> = {
+  model_provider: "groq",
+  model: "llama3-8b",
+  embedding_model: "all-mpnet-base-v2",
+  embedding_dim: 768,
+  groq_api_key: "",
+};

admin/client/providers/index.ts

@@ -2,6 +2,7 @@ import { z } from "zod";
 import { getBaseURL } from "../utils";
 import { AzureOpenAIConfigSchema, DEFAULT_AZURE_OPENAI_CONFIG } from "./azure";
 import { DEFAULT_GEMINI_CONFIG, GeminiConfigSchema } from "./gemini";
+import { DEFAULT_GROQ_CONFIG, GroqConfigSchema } from "./groq";
 import { DEFAULT_OLLAMA_CONFIG, OllamaConfigSchema } from "./ollama";
 import { DEFAULT_OPENAI_CONFIG, OpenAIConfigSchema } from "./openai";
 
@@ -11,6 +12,7 @@ export const ModelConfigSchema = z
     GeminiConfigSchema,
     OllamaConfigSchema,
     AzureOpenAIConfigSchema,
+    GroqConfigSchema,
   ])
   .refine((data) => {
     switch (data.model_provider) {
@@ -22,6 +24,8 @@ export const ModelConfigSchema = z
         return OllamaConfigSchema.parse(data);
       case "azure-openai":
         return AzureOpenAIConfigSchema.parse(data);
+      case "groq":
+        return GroqConfigSchema.parse(data);
       default:
         return true;
     }
@@ -46,6 +50,10 @@ export const supportedProviders = [
     name: "Azure OpenAI",
     value: "azure-openai",
   },
+  {
+    name: "Groq",
+    value: "groq",
+  },
 ];
 
 export const getDefaultProviderConfig = (provider: string) => {
@@ -58,6 +66,8 @@ export const getDefaultProviderConfig = (provider: string) => {
       return DEFAULT_GEMINI_CONFIG;
     case "azure-openai":
       return DEFAULT_AZURE_OPENAI_CONFIG;
+    case "groq":
+      return DEFAULT_GROQ_CONFIG;
     default:
       throw new Error(`Provider ${provider} not supported`);
   }

admin/sections/config/model.tsx

@@ -28,6 +28,7 @@ import { useForm } from "react-hook-form";
 import { useMutation, useQuery } from "react-query";
 import { AzureOpenAIForm } from "./providers/azureOpenai";
 import { GeminiForm } from "./providers/gemini";
+import { GroqForm } from "./providers/groq";
 import { OllamaForm } from "./providers/ollama";
 import { OpenAIForm } from "./providers/openai";
 
@@ -97,6 +98,8 @@ export const ModelConfig = ({
     switch (defaultValues.model_provider ?? "") {
       case "openai":
         return <OpenAIForm form={form} defaultValues={defaultValues} />;
+      case "groq":
+        return <GroqForm form={form} defaultValues={defaultValues} />;
       case "ollama":
         return <OllamaForm form={form} defaultValues={defaultValues} />;
       case "gemini":

admin/sections/config/providers/groq.tsx

@@ -0,0 +1,54 @@
+import {
+  FormControl,
+  FormDescription,
+  FormField,
+  FormItem,
+  FormLabel,
+  FormMessage,
+} from "@/components/ui/form";
+import { PasswordInput } from "@/components/ui/password-input";
+import { UseFormReturn } from "react-hook-form";
+import { ModelForm } from "./shared";
+
+export const GroqForm = ({
+  form,
+  defaultValues,
+}: {
+  form: UseFormReturn;
+  defaultValues: any;
+}) => {
+  const supportingModels = ["llama3-8b", "llama3-70b", "mixtral-8x7b"];
+
+  return (
+    <>
+      <FormField
+        control={form.control}
+        name="groq_api_key"
+        render={({ field }) => (
+          <FormItem>
+            <FormLabel>Groq API Key (*)</FormLabel>
+            <FormControl>
+              <PasswordInput
+                placeholder={defaultValues.openai_api_key ?? "sk-xxx"}
+                showCopy
+                {...field}
+              />
+            </FormControl>
+            <FormDescription>
+              Get your API key from{" "}
+              <a href="https://console.groq.com/keys" target="_blank">
+                https://console.groq.com/keys
+              </a>
+            </FormDescription>
+            <FormMessage />
+          </FormItem>
+        )}
+      />
+      <ModelForm
+        form={form}
+        defaultValues={defaultValues}
+        supportedModels={supportingModels}
+      />
+    </>
+  );
+};

poetry.lock

@@ -34,6 +34,8 @@ e2b-code-interpreter = "^0.0.10"
 llama-index-tools-openapi = "^0.1.3"
 llama-index-tools-requests = "^0.1.3"
 jsonschema = "^4.22.0"
+llama-index-embeddings-huggingface = "^0.2.2"
+llama-index-llms-groq = "^0.1.4"
 
 
 [tool.poetry.group.dev.dependencies]

pyproject.toml

@@ -20,6 +20,14 @@ class GeminiConfig(BaseModel):
     )
 
 
+class GroqConfig(BaseModel):
+    groq_api_key: str | None = Field(
+        default=None,
+        description="The Groq API key to use",
+        env="GROQ_API_KEY",
+    )
+
+
 class OllamaConfig(BaseModel):
     ollama_base_url: str | None = Field(
         default=None,
@@ -64,7 +72,12 @@ class AzureOpenAIConfig(BaseModel):
 # We're using inheritance to flatten all the fields into a single class
 # Todo: Refactor API to nested structure
 class ModelConfig(
-    BaseEnvConfig, OpenAIConfig, GeminiConfig, OllamaConfig, AzureOpenAIConfig
+    BaseEnvConfig,
+    OpenAIConfig,
+    GroqConfig,
+    GeminiConfig,
+    OllamaConfig,
+    AzureOpenAIConfig,
 ):
     model_provider: str | None = Field(
         default=None,
@@ -104,6 +117,8 @@ def configured(self) -> bool:
             return True
         elif self.model_provider == "azure-openai":
             return True
+        elif self.model_provider == "groq":
+            return self.groq_api_key is not None
         return False
 
     @classmethod