Add clarifai as Inference provider (#3424)

* added clarifai as provider

* updated ClarifaiConversationalTask class

* Fix route in Clarifai provider

---------

Co-authored-by: Lucain Pouget <[email protected]>

Author: mogith-pn

docs/source/en/guides/inference.md

@@ -130,7 +130,7 @@ class InferenceClient:
             Note: for better compatibility with OpenAI's client, `model` has been aliased as `base_url`. Those 2
             arguments are mutually exclusive. If a URL is passed as `model` or `base_url` for chat completion, the `(/v1)/chat/completions` suffix path will be appended to the URL.
         provider (`str`, *optional*):
-            Name of the provider to use for inference. Can be `"black-forest-labs"`, `"cerebras"`, `"cohere"`, `"fal-ai"`, `"featherless-ai"`, `"fireworks-ai"`, `"groq"`, `"hf-inference"`, `"hyperbolic"`, `"nebius"`, `"novita"`, `"nscale"`, `"openai"`, `publicai`, `"replicate"`, `"sambanova"`, `"scaleway"`, `"together"` or `"zai-org"`.
+            Name of the provider to use for inference. Can be `"black-forest-labs"`, `"cerebras"`, `"clarifai"`, `"cohere"`, `"fal-ai"`, `"featherless-ai"`, `"fireworks-ai"`, `"groq"`, `"hf-inference"`, `"hyperbolic"`, `"nebius"`, `"novita"`, `"nscale"`, `"openai"`, `publicai`, `"replicate"`, `"sambanova"`, `"scaleway"`, `"together"` or `"zai-org"`.
             Defaults to "auto" i.e. the first of the providers available for the model, sorted by the user's order in https://hf.co/settings/inference-providers.
             If model is a URL or `base_url` is passed, then `provider` is not used.
         token (`str`, *optional*):

src/huggingface_hub/inference/_client.py

@@ -118,7 +118,7 @@ class AsyncInferenceClient:
             Note: for better compatibility with OpenAI's client, `model` has been aliased as `base_url`. Those 2
             arguments are mutually exclusive. If a URL is passed as `model` or `base_url` for chat completion, the `(/v1)/chat/completions` suffix path will be appended to the URL.
         provider (`str`, *optional*):
-            Name of the provider to use for inference. Can be `"black-forest-labs"`, `"cerebras"`, `"cohere"`, `"fal-ai"`, `"featherless-ai"`, `"fireworks-ai"`, `"groq"`, `"hf-inference"`, `"hyperbolic"`, `"nebius"`, `"novita"`, `"nscale"`, `"openai"`, `publicai`, `"replicate"`, `"sambanova"`, `"scaleway"`, `"together"` or `"zai-org"`.
+            Name of the provider to use for inference. Can be `"black-forest-labs"`, `"cerebras"`, `"clarifai"`, `"cohere"`, `"fal-ai"`, `"featherless-ai"`, `"fireworks-ai"`, `"groq"`, `"hf-inference"`, `"hyperbolic"`, `"nebius"`, `"novita"`, `"nscale"`, `"openai"`, `publicai`, `"replicate"`, `"sambanova"`, `"scaleway"`, `"together"` or `"zai-org"`.
             Defaults to "auto" i.e. the first of the providers available for the model, sorted by the user's order in https://hf.co/settings/inference-providers.
             If model is a URL or `base_url` is passed, then `provider` is not used.
         token (`str`, *optional*):

src/huggingface_hub/inference/_generated/_async_client.py

@@ -9,6 +9,7 @@
 from ._common import TaskProviderHelper, _fetch_inference_provider_mapping
 from .black_forest_labs import BlackForestLabsTextToImageTask
 from .cerebras import CerebrasConversationalTask
+from .clarifai import ClarifaiConversationalTask
 from .cohere import CohereConversationalTask
 from .fal_ai import (
     FalAIAutomaticSpeechRecognitionTask,
@@ -50,6 +51,7 @@
 PROVIDER_T = Literal[
     "black-forest-labs",
     "cerebras",
+    "clarifai",
     "cohere",
     "fal-ai",
     "featherless-ai",
@@ -78,6 +80,9 @@
     "cerebras": {
         "conversational": CerebrasConversationalTask(),
     },
+    "clarifai": {
+        "conversational": ClarifaiConversationalTask(),
+    },
     "cohere": {
         "conversational": CohereConversationalTask(),
     },

src/huggingface_hub/inference/_providers/__init__.py

@@ -24,6 +24,7 @@
     #                                    status="live")
     "cerebras": {},
     "cohere": {},
+    "clarifai": {},
     "fal-ai": {},
     "fireworks-ai": {},
     "groq": {},

src/huggingface_hub/inference/_providers/_common.py

@@ -0,0 +1,13 @@
+from ._common import BaseConversationalTask
+
+
+_PROVIDER = "clarifai"
+_BASE_URL = "https://api.clarifai.com"
+
+
+class ClarifaiConversationalTask(BaseConversationalTask):
+    def __init__(self):
+        super().__init__(provider=_PROVIDER, base_url=_BASE_URL)
+
+    def _prepare_route(self, mapped_model: str, api_key: str) -> str:
+        return "/v2/ext/openai/v1/chat/completions"

src/huggingface_hub/inference/_providers/clarifai.py

@@ -17,6 +17,7 @@
     recursive_merge,
 )
 from huggingface_hub.inference._providers.black_forest_labs import BlackForestLabsTextToImageTask
+from huggingface_hub.inference._providers.clarifai import ClarifaiConversationalTask
 from huggingface_hub.inference._providers.cohere import CohereConversationalTask
 from huggingface_hub.inference._providers.fal_ai import (
     _POLLING_INTERVAL,
@@ -293,6 +294,34 @@ def test_prepare_payload_as_dict(self):
         }
 
 
+class TestClarifaiProvider:
+    def test_prepare_url(self):
+        helper = ClarifaiConversationalTask()
+        assert (
+            helper._prepare_url("clarifai_api_key", "username/repo_name")
+            == "https://api.clarifai.com/v2/ext/openai/v1/chat/completions"
+        )
+
+    def test_prepare_payload_as_dict(self):
+        helper = ClarifaiConversationalTask()
+        payload = helper._prepare_payload_as_dict(
+            [{"role": "user", "content": "Hello!"}],
+            {},
+            InferenceProviderMapping(
+                provider="clarifai",
+                hf_model_id="meta-llama/llama-3.1-8B-Instruct",
+                providerId="meta-llama/llama-3.1-8B-Instruct",
+                task="conversational",
+                status="live",
+            ),
+        )
+
+        assert payload == {
+            "messages": [{"role": "user", "content": "Hello!"}],
+            "model": "meta-llama/llama-3.1-8B-Instruct",
+        }
+
+
 class TestFalAIProvider:
     def test_prepare_headers_fal_ai_key(self):
         """When using direct call, must use Key authorization."""