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

Auto-update documentation after merge [skip ci]

camel-docs-bot4cff53b93a9e
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.json
index 97dfb1d97..caaa37740 100644
--- a/docs/mintlify/docs.json
+++ b/docs/mintlify/docs.json
@@ -218,6 +218,7 @@
{
"group": "Configs",
"pages": [
+ "reference/camel.configs.aihubmix_config",
"reference/camel.configs.aiml_config",
"reference/camel.configs.amd_config",
"reference/camel.configs.anthropic_config",
@@ -299,6 +300,7 @@
"group": "Models",
"pages": [
"reference/camel.models._utils",
+ "reference/camel.models.aihubmix_model",
"reference/camel.models.aiml_model",
"reference/camel.models.amd_model",
"reference/camel.models.anthropic_model",
diff --git a/docs/mintlify/reference/camel.configs.aihubmix_config.mdx b/docs/mintlify/reference/camel.configs.aihubmix_config.mdx
new file mode 100644
index 000000000..f0ecbe1fc
--- /dev/null
+++ b/docs/mintlify/reference/camel.configs.aihubmix_config.mdx
@@ -0,0 +1,26 @@
+<a id="camel.configs.aihubmix_config"></a>
+
+<a id="camel.configs.aihubmix_config.AihubMixConfig"></a>
+
+## AihubMixConfig
+
+```python
+class AihubMixConfig(BaseConfig):
+```
+
+Defines the parameters for generating chat completions using the
+AihubMix API.
+
+**Parameters:**
+
+- **temperature** (float, optional): Sampling temperature to use, between :obj:`0` and :obj:`2`. Higher values make the output more random, while lower values make it more focused and deterministic. (default: :obj:`0.8`)
+- **max_tokens** (int, optional): The maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. (default: :obj:`1024`)
+- **top_p** (float, optional): An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So :obj:`0.1` means only the tokens comprising the top 10% probability mass are considered. (default: :obj:`1`)
+- **frequency_penalty** (float, optional): Number between :obj:`-2.0` and :obj:`2.0`. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. (default: :obj:`0`)
+- **presence_penalty** (float, optional): Number between :obj:`-2.0` and :obj:`2.0`. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. (default: :obj:`0`)
+- **stream** (bool, optional): If True, partial message deltas will be sent as data-only server-sent events as they become available. (default: :obj:`False`)
+- **web_search_options** (dict, optional): Search model's web search options, only supported by specific search models. (default: :obj:`None`)
+- **tools** (list[FunctionTool], optional): A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.
+- **tool_choice** (Union[dict[str, str], str], optional): Controls which (if any) tool is called by the model. :obj:`"none"` means the model will not call any tool and instead generates a message. :obj:`"auto"` means the model can pick between generating a message or calling one or more tools. :obj:`"required"` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. :obj:`"none"` is the default when no tools are present. :obj:`"auto"` is the default if tools are present.
+- **parallel_tool_calls** (bool, optional): A parameter specifying whether the model should call tools in parallel or not. (default: :obj:`None`)
+- **extra_headers**: Optional[Dict[str, str]]: Extra headers to use for the model. (default: :obj:`None`)
diff --git a/docs/mintlify/reference/camel.models.aihubmix_model.mdx b/docs/mintlify/reference/camel.models.aihubmix_model.mdx
new file mode 100644
index 000000000..2943db67f
--- /dev/null
+++ b/docs/mintlify/reference/camel.models.aihubmix_model.mdx
@@ -0,0 +1,39 @@
+<a id="camel.models.aihubmix_model"></a>
+
+<a id="camel.models.aihubmix_model.AihubMixModel"></a>
+
+## AihubMixModel
+
+```python
+class AihubMixModel(OpenAICompatibleModel):
+```
+
+AihubMix API 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 OpenAI client. If :obj:`None`, :obj:`{}` will be used. (default: :obj:`None`)
+- **api_key** (Optional[str], optional): The API key for authenticating with AihubMix service. (default: :obj:`None`)
+- **url** (Optional[str], optional): The URL to AihubMix service. If not provided, :obj:`https://aihubmix.com/v1` will be used. (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.aihubmix_model.AihubMixModel.__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
+):
+```
diff --git a/docs/mintlify/reference/camel.types.enums.mdx b/docs/mintlify/reference/camel.types.enums.mdx
index b60c20dd9..3c05c37da 100644
--- a/docs/mintlify/reference/camel.types.enums.mdx
+++ b/docs/mintlify/reference/camel.types.enums.mdx
@@ -841,6 +841,16 @@ def is_crynux(self):
Returns whether this platform is Crynux.
+<a id="camel.types.enums.ModelPlatformType.is_aihubmix"></a>
+
+### is_aihubmix
+
+```python
+def is_aihubmix(self):
+```
+
+Returns whether this platform is AihubMix.
+
<a id="camel.types.enums.AudioModelType"></a>
## AudioModelType