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

GitHub Actionc11b4c874f8a
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.json
index 4fe45aab6..5a73d0397 100644
--- a/docs/mintlify/docs.json
+++ b/docs/mintlify/docs.json
@@ -202,6 +202,7 @@
"reference/camel.configs.base_config",
"reference/camel.configs.bedrock_config",
"reference/camel.configs.cohere_config",
+ "reference/camel.configs.crynux_config",
"reference/camel.configs.deepseek_config",
"reference/camel.configs.gemini_config",
"reference/camel.configs.groq_config",
@@ -280,6 +281,7 @@
"reference/camel.models.base_audio_model",
"reference/camel.models.base_model",
"reference/camel.models.cohere_model",
+ "reference/camel.models.crynux_model",
"reference/camel.models.deepseek_model",
"reference/camel.models.fish_audio_model",
"reference/camel.models.gemini_model",
diff --git a/docs/mintlify/key_modules/models.mdx b/docs/mintlify/key_modules/models.mdx
index c091987bb..53f8b3151 100644
--- a/docs/mintlify/key_modules/models.mdx
+++ b/docs/mintlify/key_modules/models.mdx
@@ -44,6 +44,7 @@ CAMEL supports a wide range of models, including [OpenAI’s GPT series](https:/
| **ModelScope** | [supported models](https://www.modelscope.cn/docs/model-service/API-Inference/intro) |
| **AWS Bedrock** | [supported models](https://us-west-2.console.aws.amazon.com/bedrock/home?region=us-west-2#/) |
| **IBM WatsonX** | [supported models](https://jp-tok.dataplatform.cloud.ibm.com/samples?context=wx&tab=foundation-model) |
+| **Crynux** | [supported models](https://docs.crynux.ai/application-development/how-to-run-llm-using-crynux-network/supported-models) |
## 3. How to Use Models via API Calls
diff --git a/docs/mintlify/reference/camel.agents.mcp_agent.mdx b/docs/mintlify/reference/camel.agents.mcp_agent.mdx
index 7cad8aa0b..fd0b1180d 100644
--- a/docs/mintlify/reference/camel.agents.mcp_agent.mdx
+++ b/docs/mintlify/reference/camel.agents.mcp_agent.mdx
@@ -44,6 +44,7 @@ def __init__(
local_config_path: Optional[str] = None,
tools: Optional[List[Union[FunctionTool, Callable]]] = None,
function_calling_available: bool = True,
+ strict: bool = False,
**kwargs
):
```
diff --git a/docs/mintlify/reference/camel.configs.crynux_config.mdx b/docs/mintlify/reference/camel.configs.crynux_config.mdx
new file mode 100644
index 000000000..e77677b02
--- /dev/null
+++ b/docs/mintlify/reference/camel.configs.crynux_config.mdx
@@ -0,0 +1,26 @@
+<a id="camel.configs.crynux_config"></a>
+
+<a id="camel.configs.crynux_config.CrynuxConfig"></a>
+
+## CrynuxConfig
+
+```python
+class CrynuxConfig(BaseConfig):
+```
+
+Defines the parameters for generating chat completions using the
+OpenAI 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:`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`)
+- **n** (int, optional): How many chat completion choices to generate for each input message. (default: :obj:`None`)
+- **response_format** (object, optional): An object specifying the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106. Setting to `{"type": "json_object"}` enables JSON mode, which guarantees the message the model generates is valid JSON. Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.
+- **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`)
+- **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. See more information about frequency and presence penalties. (default: :obj:`None`)
+- **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. See more information about frequency and presence penalties. (default: :obj:`None`)
+- **logit_bias** (dict, optional): Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from :obj:`-100` to :obj:`100`. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between:obj:` -1`
+- **and**: obj:`1` should decrease or increase likelihood of selection; values like :obj:`-100` or :obj:`100` should result in a ban or exclusive selection of the relevant token. (default: :obj:`None`)
diff --git a/docs/mintlify/reference/camel.models.crynux_model.mdx b/docs/mintlify/reference/camel.models.crynux_model.mdx
new file mode 100644
index 000000000..d5b0edc74
--- /dev/null
+++ b/docs/mintlify/reference/camel.models.crynux_model.mdx
@@ -0,0 +1,44 @@
+<a id="camel.models.crynux_model"></a>
+
+<a id="camel.models.crynux_model.CrynuxModel"></a>
+
+## CrynuxModel
+
+```python
+class CrynuxModel(OpenAICompatibleModel):
+```
+
+Constructor for Crynux backend with OpenAI compatibility.
+
+**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:`CrynuxConfig().as_dict()` will be used. (default: :obj:`None`)
+- **api_key** (Optional[str], optional): The API key for authenticating with the Crynux service. (default: :obj:`None`)
+- **url** (Optional[str], optional): The url to the Crynux service. If not provided, "https://bridge.crynux.ai/v1/llm" 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.
+- **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`)
+
+<a id="camel.models.crynux_model.CrynuxModel.__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
+):
+```
+
+<a id="camel.models.crynux_model.CrynuxModel.check_model_config"></a>
+
+### check_model_config
+
+```python
+def check_model_config(self):
+```
diff --git a/docs/mintlify/reference/camel.types.enums.mdx b/docs/mintlify/reference/camel.types.enums.mdx
index c5ccfa6ae..aa423e658 100644
--- a/docs/mintlify/reference/camel.types.enums.mdx
+++ b/docs/mintlify/reference/camel.types.enums.mdx
@@ -317,6 +317,14 @@ def is_watsonx(self):
def is_novita(self):
```
+<a id="camel.types.enums.ModelType.is_crynux"></a>
+
+### is_crynux
+
+```python
+def is_crynux(self):
+```
+
<a id="camel.types.enums.ModelType.is_aiml"></a>
### is_aiml
@@ -776,6 +784,16 @@ def is_watsonx(self):
Returns whether this platform is WatsonX.
+<a id="camel.types.enums.ModelPlatformType.is_crynux"></a>
+
+### is_crynux
+
+```python
+def is_crynux(self):
+```
+
+Returns whether this platform is Crynux.
+
<a id="camel.types.enums.AudioModelType"></a>
## AudioModelType
diff --git a/docs/mintlify/reference/camel.types.unified_model_type.mdx b/docs/mintlify/reference/camel.types.unified_model_type.mdx
index faf0247b7..e70a5933c 100644
--- a/docs/mintlify/reference/camel.types.unified_model_type.mdx
+++ b/docs/mintlify/reference/camel.types.unified_model_type.mdx
@@ -263,6 +263,16 @@ def is_watsonx(self):
Returns whether the model is a WatsonX served model.
+<a id="camel.types.unified_model_type.UnifiedModelType.is_crynux"></a>
+
+### is_crynux
+
+```python
+def is_crynux(self):
+```
+
+Returns whether the model is a Crynux served model.
+
<a id="camel.types.unified_model_type.UnifiedModelType.support_native_structured_output"></a>
### support_native_structured_output