Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

2.3 KB
Raw Blame
<a id="camel.models.openrouter_model"></a>

<a id="camel.models.openrouter_model.OpenRouterModel"></a>

## OpenRouterModel

```python
class OpenRouterModel(OpenAICompatibleModel):
```

LLM API served by OpenRouter in a unified OpenAICompatibleModel
interface.

**Parameters:**

- **model_type** (Union[ModelType, str]): Model for which a backend is created.
- **model_config_dict** (Optional[Dict[str, Any]], optional): A dictionary that will be fed into:obj:`openai.ChatCompletion.create()`.
- **If**: obj:`None`, :obj:`GroqConfig().as_dict()` will be used. (default: :obj:`None`)
- **api_key** (Optional[str], optional): The API key for authenticating with the OpenRouter service. (default: :obj:`None`).
- **url** (Optional[str], optional): The url to the OpenRouter service. (default: :obj:`None`)
- **token_counter** (Optional[BaseTokenCounter], optional): Token counter to use for the model. If not provided, :obj:`OpenAITokenCounter( ModelType.GPT_4O_MINI)` will be used. (default: :obj:`None`)
- **timeout** (Optional[float], optional): The timeout value in seconds for API calls. If not provided, will fall back to the MODEL_TIMEOUT environment variable or default to 180 seconds. (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 client initialization.

<a id="camel.models.openrouter_model.OpenRouterModel.__init__"></a>

### __init__

```python
def __init__(
    self,
    model_type: Union[ModelType, str],
    model_config_dict: Optional[Dict[str, Any]] = None,
    api_key: Optional[str] = None,
    url: Optional[str] = None,
    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
):
```