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-botf8e4042dae43
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.json
index 3521c33c6..18f598ed1 100644
--- a/docs/mintlify/docs.json
+++ b/docs/mintlify/docs.json
@@ -223,6 +223,7 @@
"reference/camel.configs.amd_config",
"reference/camel.configs.anthropic_config",
"reference/camel.configs.atlascloud_config",
+ "reference/camel.configs.avian_config",
"reference/camel.configs.base_config",
"reference/camel.configs.bedrock_config",
"reference/camel.configs.cerebras_config",
@@ -311,6 +312,7 @@
"reference/camel.models.amd_model",
"reference/camel.models.anthropic_model",
"reference/camel.models.atlascloud_model",
+ "reference/camel.models.avian_model",
"reference/camel.models.aws_bedrock_model",
"reference/camel.models.azure_openai_model",
"reference/camel.models.base_audio_model",
diff --git a/docs/mintlify/reference/camel.configs.avian_config.mdx b/docs/mintlify/reference/camel.configs.avian_config.mdx
new file mode 100644
index 000000000..8d7f0e2e0
--- /dev/null
+++ b/docs/mintlify/reference/camel.configs.avian_config.mdx
@@ -0,0 +1,24 @@
+<a id="camel.configs.avian_config"></a>
+
+<a id="camel.configs.avian_config.AvianConfig"></a>
+
+## AvianConfig
+
+```python
+class AvianConfig(BaseConfig):
+```
+
+Defines the parameters for generating chat completions using the
+Avian API.
+
+Reference: https://avian.io/docs
+
+**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:`None`)
+- **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:`None`)
+- **response_format** (object, optional): An object specifying the format that the model must output. Setting to `{"type": "json_object"}` enables JSON mode, which guarantees the message the model generates is valid JSON. (default: :obj:`None`)
+- **stream** (bool, optional): If True, partial message deltas will be sent as data-only server-sent events as they become available. (default: :obj:`None`)
+- **stop** (str or list, optional): Up to :obj:`4` sequences where the API will stop generating further tokens. (default: :obj:`None`)
+- **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:`None`)
+- **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.
diff --git a/docs/mintlify/reference/camel.models.avian_model.mdx b/docs/mintlify/reference/camel.models.avian_model.mdx
new file mode 100644
index 000000000..e36d4f90f
--- /dev/null
+++ b/docs/mintlify/reference/camel.models.avian_model.mdx
@@ -0,0 +1,43 @@
+<a id="camel.models.avian_model"></a>
+
+<a id="camel.models.avian_model.AvianModel"></a>
+
+## AvianModel
+
+```python
+class AvianModel(OpenAICompatibleModel):
+```
+
+LLM API served by Avian in a unified OpenAICompatibleModel interface.
+
+**Parameters:**
+
+- **model_type** (Union[ModelType, str]): Model for which a backend is created, such as :obj:`ModelType.AVIAN_DEEPSEEK_V3_2` or a string
+- **like**: obj:`"deepseek/deepseek-v3.2"`.
+- **model_config_dict** (Optional[Dict[str, Any]], optional): A dictionary that will be fed into:obj:`openai.ChatCompletion.create()`.
+- **If**: obj:`None`, :obj:`AvianConfig().as_dict()` will be used. (default: :obj:`None`)
+- **api_key** (Optional[str], optional): The API key for authenticating with the Avian service. (default: :obj:`None`).
+- **url** (Optional[str], optional): The url to the Avian 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.
+- **References**:
+- **https**: //avian.io/docs
+
+<a id="camel.models.avian_model.AvianModel.__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 e23966c39..3a63bb113 100644
--- a/docs/mintlify/reference/camel.types.enums.mdx
+++ b/docs/mintlify/reference/camel.types.enums.mdx
@@ -390,6 +390,16 @@ def is_crynux(self):
def is_aiml(self):
```
+<a id="camel.types.enums.ModelType.is_avian"></a>
+
+### is_avian
+
+```python
+def is_avian(self):
+```
+
+Returns whether this type of models is served by Avian.
+
<a id="camel.types.enums.ModelType.is_atlascloud"></a>
### is_atlascloud
@@ -891,6 +901,16 @@ def is_cerebras(self):
Returns whether this platform is Cerebras.
+<a id="camel.types.enums.ModelPlatformType.is_avian"></a>
+
+### is_avian
+
+```python
+def is_avian(self):
+```
+
+Returns whether this platform is Avian.
+
<a id="camel.types.enums.ModelPlatformType.is_atlascloud"></a>
### is_atlascloud
diff --git a/docs/mintlify/reference/camel.types.unified_model_type.mdx b/docs/mintlify/reference/camel.types.unified_model_type.mdx
index d6a18d153..40a5b00b6 100644
--- a/docs/mintlify/reference/camel.types.unified_model_type.mdx
+++ b/docs/mintlify/reference/camel.types.unified_model_type.mdx
@@ -141,6 +141,16 @@ def is_openrouter(self):
Returns whether the model is a OpenRouter served model.
+<a id="camel.types.unified_model_type.UnifiedModelType.is_avian"></a>
+
+### is_avian
+
+```python
+def is_avian(self):
+```
+
+Returns whether the model is an Avian served model.
+
<a id="camel.types.unified_model_type.UnifiedModelType.is_atlascloud"></a>
### is_atlascloud