[FEAT] Groq provider

Author: Daggx

edenai_apis/api_keys/groq_settings_template.json

@@ -0,0 +1,3 @@
+{
+    "api_key": ""
+}

edenai_apis/apis/__init__.py

@@ -66,5 +66,6 @@
 from .xai import XAiApi
 from .deepseek import DeepseekApi
 from .together_ai import TogetheraiApi
+from .groq import GroqApi
 
 # THIS NEEDS TO BE DONE AUTOMATICALLY

edenai_apis/apis/groq/__init__.py

@@ -0,0 +1 @@
+from .groq_api import GroqApi

edenai_apis/apis/groq/errors.py

@@ -0,0 +1,5 @@
+from edenai_apis.utils.exception import (
+    ProviderErrorLists,
+)
+
+ERRORS: ProviderErrorLists = {}

edenai_apis/apis/groq/groq_api.py

@@ -0,0 +1,172 @@
+from typing import Dict, List, Literal, Optional, Type, Union
+
+import httpx
+from openai import BaseModel
+
+from edenai_apis.features import ProviderInterface, TextInterface
+from edenai_apis.features.multimodal.chat.chat_dataclass import (
+    ChatDataClass as ChatMultimodalDataClass,
+)
+from edenai_apis.features.multimodal.chat.chat_dataclass import (
+    ChatMessageDataClass as ChatMultimodalMessageDataClass,
+)
+from edenai_apis.features.multimodal.chat.chat_dataclass import (
+    StreamChat as StreamChatMultimodal,
+)
+from edenai_apis.features.text.chat.chat_dataclass import ChatDataClass, StreamChat
+from edenai_apis.llmengine.llm_engine import LLMEngine
+from edenai_apis.loaders.data_loader import ProviderDataEnum
+from edenai_apis.loaders.loaders import load_provider
+from edenai_apis.utils.types import ResponseType
+from edenai_apis.features.llm.llm_interface import LlmInterface
+from edenai_apis.features.llm.chat.chat_dataclass import ChatDataClass
+
+
+class GroqApi(ProviderInterface, TextInterface, LlmInterface):
+    provider_name = "groq"
+
+    def __init__(self, api_keys: Dict = {}) -> None:
+        self.api_settings = load_provider(
+            ProviderDataEnum.KEY, self.provider_name, api_keys=api_keys
+        )
+        self.llm_client = LLMEngine(
+            provider_name=self.provider_name,
+            provider_config={
+                "api_key": self.api_settings.get("api_key"),
+            },
+        )
+
+    def text__chat(
+        self,
+        text: str,
+        chatbot_global_action: Optional[str] = None,
+        previous_history: Optional[List[Dict[str, str]]] = None,
+        temperature: float = 0.0,
+        max_tokens: int = 25,
+        model: Optional[str] = None,
+        stream: bool = False,
+        available_tools: Optional[List[dict]] = None,
+        tool_choice: Literal["auto", "required", "none"] = "auto",
+        tool_results: Optional[List[dict]] = None,
+        **kwargs,
+    ) -> ResponseType[Union[ChatDataClass, StreamChat]]:
+        response = self.llm_client.chat(
+            text=text,
+            previous_history=previous_history,
+            chatbot_global_action=chatbot_global_action,
+            temperature=temperature,
+            max_tokens=max_tokens,
+            model=model,
+            stream=stream,
+            available_tools=available_tools,
+            tool_choice=tool_choice,
+            tool_results=tool_results,
+            **kwargs,
+        )
+        return response
+
+    def multimodal__chat(
+        self,
+        messages: List[ChatMultimodalMessageDataClass],
+        chatbot_global_action: Optional[str],
+        temperature: float = 0,
+        max_tokens: int = 25,
+        model: Optional[str] = None,
+        stop_sequences: Optional[List[str]] = None,
+        top_k: Optional[int] = None,
+        top_p: Optional[int] = None,
+        stream: bool = False,
+        provider_params: Optional[dict] = None,
+        response_format=None,
+        **kwargs,
+    ) -> ResponseType[Union[ChatMultimodalDataClass, StreamChatMultimodal]]:
+        response = self.llm_client.multimodal_chat(
+            messages=messages,
+            chatbot_global_action=chatbot_global_action,
+            temperature=temperature,
+            max_tokens=max_tokens,
+            model=model,
+            stop_sequences=stop_sequences,
+            top_k=top_k,
+            top_p=top_p,
+            stream=stream,
+            response_format=response_format,
+            **kwargs,
+        )
+        return response
+
+    def llm__chat(
+        self,
+        messages: List = [],
+        model: Optional[str] = None,
+        timeout: Optional[Union[float, str, httpx.Timeout]] = None,
+        temperature: Optional[float] = None,
+        top_p: Optional[float] = None,
+        n: Optional[int] = None,
+        stream: Optional[bool] = None,
+        stream_options: Optional[dict] = None,
+        stop: Optional[str] = None,
+        stop_sequences: Optional[any] = None,
+        max_tokens: Optional[int] = None,
+        presence_penalty: Optional[float] = None,
+        frequency_penalty: Optional[float] = None,
+        logit_bias: Optional[dict] = None,
+        # openai v1.0+ new params
+        response_format: Optional[
+            Union[dict, Type[BaseModel]]
+        ] = None,  # Structured outputs
+        seed: Optional[int] = None,
+        tools: Optional[List] = None,
+        tool_choice: Optional[Union[str, dict]] = None,
+        logprobs: Optional[bool] = None,
+        top_logprobs: Optional[int] = None,
+        parallel_tool_calls: Optional[bool] = None,
+        deployment_id=None,
+        extra_headers: Optional[dict] = None,
+        # soon to be deprecated params by OpenAI -> This should be replaced by tools
+        functions: Optional[List] = None,
+        function_call: Optional[str] = None,
+        base_url: Optional[str] = None,
+        api_version: Optional[str] = None,
+        api_key: Optional[str] = None,
+        model_list: Optional[list] = None,  # pass in a list of api_base,keys, etc.
+        drop_invalid_params: bool = True,  # If true, all the invalid parameters will be ignored (dropped) before sending to the model
+        user: str | None = None,
+        # Optional parameters
+        **kwargs,
+    ) -> ChatDataClass:
+        response = self.llm_client.completion(
+            messages=messages,
+            model=model,
+            timeout=timeout,
+            temperature=temperature,
+            top_p=top_p,
+            n=n,
+            stream=stream,
+            stream_options=stream_options,
+            stop=stop,
+            stop_sequences=stop_sequences,
+            max_tokens=max_tokens,
+            presence_penalty=presence_penalty,
+            frequency_penalty=frequency_penalty,
+            logit_bias=logit_bias,
+            response_format=response_format,
+            seed=seed,
+            tools=tools,
+            tool_choice=tool_choice,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
+            parallel_tool_calls=parallel_tool_calls,
+            deployment_id=deployment_id,
+            extra_headers=extra_headers,
+            functions=functions,
+            function_call=function_call,
+            base_url=base_url,
+            api_version=api_version,
+            api_key=api_key,
+            model_list=model_list,
+            drop_invalid_params=drop_invalid_params,
+            user=user,
+            **kwargs,
+        )
+        return response

edenai_apis/apis/groq/info.json

@@ -0,0 +1,17 @@
+{
+    "text": {
+        "chat": {
+            "version": "v1"
+        }
+    },
+    "multimodal": {
+        "chat": {
+            "version": "v1"
+        }
+    },
+    "llm": {
+        "chat": {
+            "version": "v1"
+        }
+    }
+}

edenai_apis/apis/groq/outputs/llm/chat_output.json

@@ -0,0 +1,41 @@
+{
+    "id": "chatcmpl-B71qqu4Y7m1ZVuF5YGqxz7LXzgf0Y",
+    "created": 1741015112,
+    "model": "gpt-4o-mini-2024-07-18",
+    "object": "chat.completion",
+    "system_fingerprint": "fp_7fcd609668",
+    "choices": [
+        {
+            "finish_reason": "stop",
+            "index": 0,
+            "message": {
+                "content": "Arrr, matey! What ye be seein’ in this here image is a grand pathway, made of wooden planks, weavin' its way through a lush and green landscape. The verdant grass sways in the gentle breeze, and the sky above be a brilliant blue, decorated with fluffy white clouds. Ye can spot trees and bushes on either side, makin' it a perfect setting for a stroll amongst nature. A peaceful place for a pirate at heart, aye!",
+                "role": "assistant",
+                "tool_calls": null,
+                "function_call": null
+            }
+        }
+    ],
+    "provider_time": 3692885792,
+    "edenai_time": null,
+    "usage": {
+        "completion_tokens": 99,
+        "prompt_tokens": 1170,
+        "total_tokens": 1269,
+        "completion_tokens_details": {
+            "accepted_prediction_tokens": 0,
+            "audio_tokens": 0,
+            "reasoning_tokens": 0,
+            "rejected_prediction_tokens": 0,
+            "text_tokens": 99
+        },
+        "prompt_tokens_details": {
+            "audio_tokens": 0,
+            "cached_tokens": 1024,
+            "text_tokens": null,
+            "image_tokens": null
+        }
+    },
+    "service_tier": "default",
+    "cost": 0.0002349
+}

edenai_apis/apis/groq/outputs/text/chat_output.json

@@ -0,0 +1,67 @@
+{
+  "original_response": {
+    "id": "chatcmpl-f271ab8f-95c8-4c86-8673-48ef9f63a5d1",
+    "created": 1742897322,
+    "model": "groq/llama-3.1-8b-instant",
+    "object": "chat.completion",
+    "system_fingerprint": "fp_19ca34f5ed",
+    "choices": [
+      {
+        "finish_reason": "stop",
+        "index": 0,
+        "message": {
+          "content": "barack obama, american, politician, democratic, african, united states, senator, illinois",
+          "role": "assistant",
+          "tool_calls": null,
+          "function_call": null
+        }
+      }
+    ],
+    "provider_time": 295782124,
+    "edenai_time": null,
+    "usage": {
+      "completion_tokens": 21,
+      "prompt_tokens": 248,
+      "total_tokens": 269,
+      "completion_tokens_details": null,
+      "prompt_tokens_details": null,
+      "queue_time": 0.094506039,
+      "prompt_time": 0.007630602,
+      "completion_time": 0.028,
+      "total_time": 0.035630602
+    },
+    "x_groq": {
+      "id": "req_01jq6cd6qbe1b9czbz5xxjkfq4"
+    },
+    "cost": 1.408e-05
+  },
+  "standardized_response": {
+    "generated_text": "barack obama, american, politician, democratic, african, united states, senator, illinois",
+    "message": [
+      {
+        "role": "user",
+        "message": "Barack Hussein Obama is an American politician who served as the 44th president of the United States from 2009 to 2017. A member of the Democratic Party, Obama was the first African-American president of the United States. He previously served as a U.S. senator from Illinois from 2005 to 2008 and as an Illinois state senator from 1997 to 2004.",
+        "tools": null,
+        "tool_calls": null
+      },
+      {
+        "role": "assistant",
+        "message": "barack obama, american, politician, democratic, african, united states, senator, illinois",
+        "tools": null,
+        "tool_calls": []
+      }
+    ]
+  },
+  "usage": {
+    "completion_tokens": 21,
+    "prompt_tokens": 248,
+    "total_tokens": 269,
+    "completion_tokens_details": null,
+    "prompt_tokens_details": null,
+    "queue_time": 0.094506039,
+    "prompt_time": 0.007630602,
+    "completion_time": 0.028,
+    "total_time": 0.035630602
+  },
+  "cost": null
+}

edenai_apis/features/text/chat/chat_args.py

@@ -28,6 +28,7 @@ def chat_arguments(provider_name: str):
             "deepseek": "DeepSeek-V3",
             "microsoft": "gpt-4o-mini",
             "togetherai": "microsoft/WizardLM-2-8x22B",
+            "groq": "llama-3.1-8b-instant",
         },
         "stream": False,
     }