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.orcarouter_model"></a>

<a id="camel.models.orcarouter_model.OrcaRouterModel"></a>

## OrcaRouterModel

```python
class OrcaRouterModel(OpenAICompatibleModel):
```

LLM API served by OrcaRouter in a unified OpenAICompatibleModel
interface.

OrcaRouter is an OpenAI-compatible LLM gateway that routes each request
to the cheapest or fastest upstream provider for the requested model.

Quickstart: pass `__INLINE_CODE_0__` to let OrcaRouter pick the
upstream for you — no need to know specific model ids. To pin a specific
model, use one of the predefined `__INLINE_CODE_1__` enums
(discoverable in IDE autocomplete) or pass any model id from the full
catalog at https://www.orcarouter.ai/models as a free-form string (e.g.
`__INLINE_CODE_2__`).

**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:`OrcaRouterConfig().as_dict()` will be used. (default: :obj:`None`)
- **api_key** (Optional[str], optional): The API key for authenticating with the OrcaRouter service. (default: :obj:`None`).
- **url** (Optional[str], optional): The url to the OrcaRouter 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`) **kwargs (Any): Additional arguments to pass to the client initialization.

<a id="camel.models.orcarouter_model.OrcaRouterModel.__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,
    **kwargs: Any
):
```