🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
Auto-update documentation after merge [skip ci]
camel-docs-bot31eb4d57dea3
diff --git a/docs/key_modules/models.md b/docs/key_modules/models.mdindex 8d4c3541a..63ec878eb 100644--- a/docs/key_modules/models.md+++ b/docs/key_modules/models.md@@ -1,6 +1,6 @@---title: "Models"-description: "CAMEL-AI: Flexible integration and deployment of top LLMs and multimodal models like [OpenAI](https://openai.com/), [Mistral](https://mistral.ai/), [Gemini](https://ai.google.dev/gemini-api/docs/models), [Llama](https://www.llama.com/), and more."+description: "CAMEL-AI: Flexible integration and deployment of top LLMs and multimodal models like [OpenAI](https://openai.com/), [Mistral](https://mistral.ai/), [Gemini](https://ai.google.dev/gemini-api/docs/models), [Llama](https://www.llama.com/), [Nebius](https://nebius.com/), and more."icon: gear-code---@@ -16,7 +16,7 @@ Play with different models in our [interactive Colab Notebook](https://colab.res</Card><Card title="Flexible Model Integration" icon="plug">- CAMEL allows quick integration and swapping of leading LLMs from providers like OpenAI, Gemini, Llama, and Anthropic, helping you match the best model to your task.+ CAMEL allows quick integration and swapping of leading LLMs from providers like OpenAI, Gemini, Llama, Anthropic, Nebius, and more, helping you match the best model to your task.</Card><Card title="Optimized for Customization" icon="sliders">@@ -45,6 +45,7 @@ CAMEL supports a wide range of models, including [OpenAI’s GPT series](https:/| **Lingyiwanwu** | yi-lightning, yi-large, yi-medium<br/>yi-large-turbo, yi-vision, yi-medium-200k<br/>yi-spark, yi-large-rag, yi-large-fc || **Qwen** | qwen3-coder-plus,qwq-32b-preview, qwen-max, qwen-plus, qwen-turbo, qwen-long<br/>qwen-vl-max, qwen-vl-plus, qwen-math-plus, qwen-math-turbo, qwen-coder-turbo<br/>qwen2.5-coder-32b-instruct, qwen2.5-72b-instruct, qwen2.5-32b-instruct, qwen2.5-14b-instruct || **DeepSeek** | deepseek-chat<br/>deepseek-reasoner |+| **Nebius** | **All models available on [Nebius AI Studio](https://studio.nebius.com/)**<br/>Including: gpt-oss-120b, gpt-oss-20b, GLM-4.5<br/>DeepSeek V3 & R1, LLaMA, Mistral, and more || **ZhipuAI** | glm-4, glm-4v, glm-4v-flash<br/>glm-4v-plus-0111, glm-4-plus, glm-4-air<br/>glm-4-air-0111, glm-4-airx, glm-4-long<br/>glm-4-flashx, glm-zero-preview, glm-4-flash, glm-3-turbo || **InternLM** | internlm3-latest, internlm3-8b-instruct<br/>internlm2.5-latest, internlm2-pro-chat || **Reka** | reka-core, reka-flash, reka-edge |@@ -194,6 +195,61 @@ Integrate your favorite models into CAMEL-AI with straightforward Python calls.</Tab>+ <Tab title="Nebius">++ Leverage [Nebius AI Studio](https://nebius.com/)'s high-performance GPU cloud with OpenAI-compatible models:++ - **Nebius AI Studio** ([Platform](https://studio.nebius.com/)): Access powerful models through their cloud infrastructure.+ - **API Key Setup** ([Generate Key](https://studio.nebius.ai/settings/api-keys)): Obtain your Nebius API key to start integration.+ - **Nebius Docs** ([Documentation](https://nebius.com/docs/)): Explore detailed Nebius API capabilities.++ ```python+ from camel.models import ModelFactory+ from camel.types import ModelPlatformType, ModelType+ from camel.configs import NebiusConfig+ from camel.agents import ChatAgent++ model = ModelFactory.create(+ model_platform=ModelPlatformType.NEBIUS,+ model_type=ModelType.NEBIUS_GPT_OSS_120B,+ model_config_dict=NebiusConfig(temperature=0.2).as_dict(),+ )++ agent = ChatAgent(+ system_message="You are a helpful assistant.",+ model=model+ )++ response = agent.step("Say hi to CAMEL AI community.")+ print(response.msgs[0].content)+ ```++ <Note type="info">+ **Flexible Model Access:** You can use any model available on Nebius by passing the model name as a string to `model_type`, even if it's not in the predefined enums.+ </Note>++ **Environment Variables:**+ ```bash+ export NEBIUS_API_KEY="your_nebius_api_key"+ export NEBIUS_API_BASE_URL="https://api.studio.nebius.com/v1" # Optional+ ```++ **Model Support:**+ - **Complete Access:** All models available on [Nebius AI Studio](https://studio.nebius.com/) are supported+ - **Predefined Enums:** Common models like `NEBIUS_GPT_OSS_120B`, `NEBIUS_DEEPSEEK_V3`, etc.+ - **String-based Access:** Use any model name directly as a string for maximum flexibility++ **Example with any model:**+ ```python+ # Use any model available on Nebius+ model = ModelFactory.create(+ model_platform=ModelPlatformType.NEBIUS,+ model_type="your-custom-model-name" # Any Nebius model+ )+ ```++ </Tab>+<Tab title="Qwen">diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.jsonindex 67aa5fab4..cbacd5ea8 100644--- a/docs/mintlify/docs.json+++ b/docs/mintlify/docs.json@@ -234,6 +234,7 @@"reference/camel.configs.mistral_config","reference/camel.configs.modelscope_config","reference/camel.configs.moonshot_config",+ "reference/camel.configs.nebius_config","reference/camel.configs.netmind_config","reference/camel.configs.novita_config","reference/camel.configs.nvidia_config",@@ -317,6 +318,7 @@"reference/camel.models.model_manager","reference/camel.models.modelscope_model","reference/camel.models.moonshot_model",+ "reference/camel.models.nebius_model","reference/camel.models.nemotron_model","reference/camel.models.netmind_model","reference/camel.models.novita_model",diff --git a/docs/mintlify/reference/camel.configs.nebius_config.mdx b/docs/mintlify/reference/camel.configs.nebius_config.mdxnew file mode 100644index 000000000..e413c8291--- /dev/null+++ b/docs/mintlify/reference/camel.configs.nebius_config.mdx@@ -0,0 +1,29 @@+<a id="camel.configs.nebius_config"></a>++<a id="camel.configs.nebius_config.NebiusConfig"></a>++## NebiusConfig++```python+class NebiusConfig(BaseConfig):+```++Defines the parameters for generating chat completions using OpenAI+compatibility with Nebius AI Studio.++Reference: https://nebius.com/docs/ai-studio/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`)+- **user** (str, optional): A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. (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.diff --git a/docs/mintlify/reference/camel.models.nebius_model.mdx b/docs/mintlify/reference/camel.models.nebius_model.mdxnew file mode 100644index 000000000..63e722fc8--- /dev/null+++ b/docs/mintlify/reference/camel.models.nebius_model.mdx@@ -0,0 +1,41 @@+<a id="camel.models.nebius_model"></a>++<a id="camel.models.nebius_model.NebiusModel"></a>++## NebiusModel++```python+class NebiusModel(OpenAICompatibleModel):+```++LLM API served by Nebius AI Studio 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:`NebiusConfig().as_dict()` will be used. (default: :obj:`None`)+- **api_key** (Optional[str], optional): The API key for authenticating with the Nebius AI Studio service. (default: :obj:`None`).+- **url** (Optional[str], optional): The url to the Nebius AI Studio 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.nebius_model.NebiusModel.__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.mdxindex f9f78b3ec..0641f922f 100644--- a/docs/mintlify/reference/camel.types.enums.mdx+++ b/docs/mintlify/reference/camel.types.enums.mdx@@ -129,6 +129,17 @@ def is_groq(self):Returns whether this type of models is served by Groq.+<a id="camel.types.enums.ModelType.is_nebius"></a>++### is_nebius++```python+def is_nebius(self):+```++Returns whether this type of models is served by Nebius AI+Studio.+<a id="camel.types.enums.ModelType.is_openrouter"></a>### is_openrouterdiff --git a/docs/mintlify/reference/camel.types.unified_model_type.mdx b/docs/mintlify/reference/camel.types.unified_model_type.mdxindex bf06ba955..739687a73 100644--- a/docs/mintlify/reference/camel.types.unified_model_type.mdx+++ b/docs/mintlify/reference/camel.types.unified_model_type.mdx@@ -119,6 +119,16 @@ def is_groq(self):Returns whether the model is a Groq served model.+<a id="camel.types.unified_model_type.UnifiedModelType.is_nebius"></a>++### is_nebius++```python+def is_nebius(self):+```++Returns whether the model is a Nebius AI Studio served model.+<a id="camel.types.unified_model_type.UnifiedModelType.is_openrouter"></a>### is_openrouter