🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
Add customizable OpenRouter App Attribution headers (#3797)
Copilotb982ec732007
diff --git a/camel/models/openrouter_model.py b/camel/models/openrouter_model.pyindex 8c87b58f6..12c0036e0 100644--- a/camel/models/openrouter_model.py+++ b/camel/models/openrouter_model.py@@ -48,6 +48,14 @@ class OpenRouterModel(OpenAICompatibleModel):(default: :obj:`None`)max_retries (int, optional): Maximum number of retries for API calls.(default: :obj:`3`)+ app_referer (Optional[str], optional): The HTTP-Referer header value+ for OpenRouter App Attribution. If not provided, defaults to+ 'https://www.camel-ai.org/'. Set to :obj:`None` to disable.+ (default: :obj:`'https://www.camel-ai.org/'`)+ app_title (Optional[str], optional): The X-OpenRouter-Title header+ value for OpenRouter App Attribution. If not provided, defaults+ to 'CAMEL-AI'. Set to :obj:`None` to disable.+ (default: :obj:`'CAMEL-AI'`)**kwargs (Any): Additional arguments to pass to the clientinitialization."""@@ -62,6 +70,8 @@ class OpenRouterModel(OpenAICompatibleModel):token_counter: Optional[BaseTokenCounter] = None,timeout: Optional[float] = None,max_retries: int = 3,+ app_referer: Optional[str] = 'https://www.camel-ai.org/',+ app_title: Optional[str] = 'CAMEL-AI',**kwargs: Any,) -> None:if model_config_dict is None:@@ -71,6 +81,20 @@ class OpenRouterModel(OpenAICompatibleModel):"OPENROUTER_API_BASE_URL", "https://openrouter.ai/api/v1")timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))++ # Add OpenRouter App Attribution headers+ # Merge with any existing headers to preserve user-provided headers+ attribution_headers = {}+ if app_referer is not None:+ attribution_headers['HTTP-Referer'] = app_referer+ if app_title is not None:+ attribution_headers['X-OpenRouter-Title'] = app_title++ kwargs["default_headers"] = {+ **attribution_headers,+ **(kwargs.get("default_headers") or {}),+ }+super().__init__(model_type=model_type,model_config_dict=model_config_dict,diff --git a/test/models/test_openrouter_model.py b/test/models/test_openrouter_model.pyindex 9ec177da1..e1f987689 100644--- a/test/models/test_openrouter_model.py+++ b/test/models/test_openrouter_model.py@@ -43,3 +43,122 @@ def test_openrouter_model(model_type: ModelType):def test_openrouter_model_stream_property():model = OpenRouterModel(ModelType.OPENROUTER_LLAMA_3_1_70B)assert model.stream is False++[email protected]_backend+def test_openrouter_model_app_attribution_headers():+ r"""Test that OpenRouter App Attribution headers are properly set."""+ model = OpenRouterModel(ModelType.OPENROUTER_LLAMA_3_1_70B)++ # Check that the client has the default headers set+ assert hasattr(model._client, 'default_headers')+ headers = model._client.default_headers++ # Verify App Attribution headers are present+ assert 'HTTP-Referer' in headers+ assert headers['HTTP-Referer'] == 'https://www.camel-ai.org/'+ assert 'X-OpenRouter-Title' in headers+ assert headers['X-OpenRouter-Title'] == 'CAMEL-AI'++[email protected]_backend+def test_openrouter_model_preserves_custom_headers():+ r"""Test that custom headers are preserved along with attribution."""+ custom_headers = {'Custom-Header': 'custom-value'}+ model = OpenRouterModel(+ ModelType.OPENROUTER_LLAMA_3_1_70B,+ default_headers=custom_headers,+ )++ headers = model._client.default_headers++ # Verify both custom and attribution headers are present+ assert 'Custom-Header' in headers+ assert headers['Custom-Header'] == 'custom-value'+ assert 'HTTP-Referer' in headers+ assert headers['HTTP-Referer'] == 'https://www.camel-ai.org/'+ assert 'X-OpenRouter-Title' in headers+ assert headers['X-OpenRouter-Title'] == 'CAMEL-AI'++[email protected]_backend+def test_openrouter_model_custom_default_headers_override_attribution():+ r"""Test that custom default headers can override attribution defaults."""+ custom_headers = {+ 'HTTP-Referer': 'https://existing-app.example/',+ 'X-OpenRouter-Title': 'ExistingApp',+ }+ model = OpenRouterModel(+ ModelType.OPENROUTER_LLAMA_3_1_70B,+ default_headers=custom_headers,+ )++ headers = model._client.default_headers++ assert headers['HTTP-Referer'] == 'https://existing-app.example/'+ assert headers['X-OpenRouter-Title'] == 'ExistingApp'++[email protected]_backend+def test_openrouter_model_custom_attribution_headers():+ r"""Test that custom attribution header values can be provided."""+ model = OpenRouterModel(+ ModelType.OPENROUTER_LLAMA_3_1_70B,+ app_referer='https://custom-site.com/',+ app_title='Custom-App',+ )++ headers = model._client.default_headers++ # Verify custom attribution headers are used+ assert 'HTTP-Referer' in headers+ assert headers['HTTP-Referer'] == 'https://custom-site.com/'+ assert 'X-OpenRouter-Title' in headers+ assert headers['X-OpenRouter-Title'] == 'Custom-App'++[email protected]_backend+def test_openrouter_model_disable_attribution_headers():+ r"""Test that attribution headers can be disabled."""+ model = OpenRouterModel(+ ModelType.OPENROUTER_LLAMA_3_1_70B,+ app_referer=None,+ app_title=None,+ )++ headers = model._client.default_headers++ # Verify attribution headers are not present+ assert 'HTTP-Referer' not in headers+ assert 'X-OpenRouter-Title' not in headers++[email protected]_backend+def test_openrouter_model_partial_attribution_headers():+ r"""Test that individual attribution headers can be customized."""+ model = OpenRouterModel(+ ModelType.OPENROUTER_LLAMA_3_1_70B,+ app_referer='https://my-custom-site.com/',+ app_title=None,+ )++ headers = model._client.default_headers++ # Verify only HTTP-Referer is set with custom value+ assert 'HTTP-Referer' in headers+ assert headers['HTTP-Referer'] == 'https://my-custom-site.com/'+ assert 'X-OpenRouter-Title' not in headers++[email protected]_backend+def test_openrouter_model_accepts_none_default_headers():+ r"""Test that None default headers do not break attribution defaults."""+ model = OpenRouterModel(+ ModelType.OPENROUTER_LLAMA_3_1_70B,+ default_headers=None,+ )++ headers = model._client.default_headers++ assert headers['HTTP-Referer'] == 'https://www.camel-ai.org/'+ assert headers['X-OpenRouter-Title'] == 'CAMEL-AI'