diff --git a/docs/camel.agents.rst b/docs/camel.agents.rst index 2d9c896b90..d311c2fc07 100644 --- a/docs/camel.agents.rst +++ b/docs/camel.agents.rst @@ -60,6 +60,38 @@ camel.agents.knowledge\_graph\_agent module :undoc-members: :show-inheritance: +camel.agents.mcp\_agent module +------------------------------- + +.. automodule:: camel.agents.mcp_agent + :members: + :undoc-members: + :show-inheritance: + +camel.agents.multi\_hop\_generator\_agent module +------------------------------------------------ + +.. automodule:: camel.agents.multi_hop_generator_agent + :members: + :undoc-members: + :show-inheritance: + +camel.agents.programmed\_agent\_instruction module +-------------------------------------------------- + +.. automodule:: camel.agents.programmed_agent_instruction + :members: + :undoc-members: + :show-inheritance: + +camel.agents.repo\_agent module +-------------------------------- + +.. automodule:: camel.agents.repo_agent + :members: + :undoc-members: + :show-inheritance: + camel.agents.role\_assignment\_agent module ------------------------------------------- diff --git a/docs/camel.benchmarks.rst b/docs/camel.benchmarks.rst index 081c875c2a..ce706f2146 100644 --- a/docs/camel.benchmarks.rst +++ b/docs/camel.benchmarks.rst @@ -28,6 +28,14 @@ camel.benchmarks.base module :undoc-members: :show-inheritance: +camel.benchmarks.browsecomp module +---------------------------------- + +.. automodule:: camel.benchmarks.browsecomp + :members: + :undoc-members: + :show-inheritance: + camel.benchmarks.gaia module ---------------------------- diff --git a/docs/camel.configs.rst b/docs/camel.configs.rst index 8943981ef9..d69cca9a9f 100644 --- a/docs/camel.configs.rst +++ b/docs/camel.configs.rst @@ -4,6 +4,30 @@ camel.configs package Submodules ---------- +camel.configs.aihubmix\_config module +------------------------------------- + +.. automodule:: camel.configs.aihubmix_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.aiml\_config module +--------------------------------- + +.. automodule:: camel.configs.aiml_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.amd\_config module +-------------------------------- + +.. automodule:: camel.configs.amd_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.anthropic\_config module -------------------------------------- @@ -12,6 +36,14 @@ camel.configs.anthropic\_config module :undoc-members: :show-inheritance: +camel.configs.atlascloud\_config module +--------------------------------------- + +.. automodule:: camel.configs.atlascloud_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.base\_config module --------------------------------- @@ -20,6 +52,30 @@ camel.configs.base\_config module :undoc-members: :show-inheritance: +camel.configs.bedrock\_config module +------------------------------------ + +.. automodule:: camel.configs.bedrock_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.cerebras\_config module +------------------------------------- + +.. automodule:: camel.configs.cerebras_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.cohere\_config module +----------------------------------- + +.. automodule:: camel.configs.cohere_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.cometapi\_config module ------------------------------------- @@ -28,6 +84,30 @@ camel.configs.cometapi\_config module :undoc-members: :show-inheritance: +camel.configs.crynux\_config module +----------------------------------- + +.. automodule:: camel.configs.crynux_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.deepseek\_config module +------------------------------------- + +.. automodule:: camel.configs.deepseek_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.function\_gemma\_config module +-------------------------------------------- + +.. automodule:: camel.configs.function_gemma_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.gemini\_config module ----------------------------------- @@ -44,6 +124,14 @@ camel.configs.groq\_config module :undoc-members: :show-inheritance: +camel.configs.internlm\_config module +------------------------------------- + +.. automodule:: camel.configs.internlm_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.litellm\_config module ------------------------------------ @@ -52,6 +140,22 @@ camel.configs.litellm\_config module :undoc-members: :show-inheritance: +camel.configs.lmstudio\_config module +------------------------------------- + +.. automodule:: camel.configs.lmstudio_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.minimax\_config module +------------------------------------ + +.. automodule:: camel.configs.minimax_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.mistral\_config module ------------------------------------ @@ -60,6 +164,54 @@ camel.configs.mistral\_config module :undoc-members: :show-inheritance: +camel.configs.modelscope\_config module +--------------------------------------- + +.. automodule:: camel.configs.modelscope_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.moonshot\_config module +------------------------------------- + +.. automodule:: camel.configs.moonshot_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.nebius\_config module +----------------------------------- + +.. automodule:: camel.configs.nebius_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.netmind\_config module +------------------------------------ + +.. automodule:: camel.configs.netmind_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.novita\_config module +----------------------------------- + +.. automodule:: camel.configs.novita_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.nvidia\_config module +----------------------------------- + +.. automodule:: camel.configs.nvidia_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.ollama\_config module ----------------------------------- @@ -76,6 +228,38 @@ camel.configs.openai\_config module :undoc-members: :show-inheritance: +camel.configs.openrouter\_config module +--------------------------------------- + +.. automodule:: camel.configs.openrouter_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.ppio\_config module +--------------------------------- + +.. automodule:: camel.configs.ppio_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.qianfan\_config module +------------------------------------ + +.. automodule:: camel.configs.qianfan_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.qwen\_config module +--------------------------------- + +.. automodule:: camel.configs.qwen_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.reka\_config module --------------------------------- @@ -92,6 +276,22 @@ camel.configs.samba\_config module :undoc-members: :show-inheritance: +camel.configs.sglang\_config module +----------------------------------- + +.. automodule:: camel.configs.sglang_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.siliconflow\_config module +---------------------------------------- + +.. automodule:: camel.configs.siliconflow_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.togetherai\_config module --------------------------------------- @@ -108,6 +308,22 @@ camel.configs.vllm\_config module :undoc-members: :show-inheritance: +camel.configs.watsonx\_config module +------------------------------------ + +.. automodule:: camel.configs.watsonx_config + :members: + :undoc-members: + :show-inheritance: + +camel.configs.yi\_config module +------------------------------- + +.. automodule:: camel.configs.yi_config + :members: + :undoc-members: + :show-inheritance: + camel.configs.zhipuai\_config module ------------------------------------ diff --git a/docs/camel.data_collector.rst b/docs/camel.data_collector.rst deleted file mode 100644 index fab25f7c66..0000000000 --- a/docs/camel.data_collector.rst +++ /dev/null @@ -1,37 +0,0 @@ -camel.data\_collector package -============================= - -Submodules ----------- - -camel.data\_collector.alpaca\_collector module ----------------------------------------------- - -.. automodule:: camel.data_collector.alpaca_collector - :members: - :undoc-members: - :show-inheritance: - -camel.data\_collector.base module ---------------------------------- - -.. automodule:: camel.data_collector.base - :members: - :undoc-members: - :show-inheritance: - -camel.data\_collector.sharegpt\_collector module ------------------------------------------------- - -.. automodule:: camel.data_collector.sharegpt_collector - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: camel.data_collector - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/camel.data_collectors.rst b/docs/camel.data_collectors.rst new file mode 100644 index 0000000000..a1d7fea626 --- /dev/null +++ b/docs/camel.data_collectors.rst @@ -0,0 +1,37 @@ +camel.data\_collectors package +============================== + +Submodules +---------- + +camel.data\_collectors.alpaca\_collector module +----------------------------------------------- + +.. automodule:: camel.data_collectors.alpaca_collector + :members: + :undoc-members: + :show-inheritance: + +camel.data\_collectors.base module +---------------------------------- + +.. automodule:: camel.data_collectors.base + :members: + :undoc-members: + :show-inheritance: + +camel.data\_collectors.sharegpt\_collector module +------------------------------------------------- + +.. automodule:: camel.data_collectors.sharegpt_collector + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: camel.data_collectors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/camel.datagen.evol_instruct.rst b/docs/camel.datagen.evol_instruct.rst new file mode 100644 index 0000000000..99af905eb7 --- /dev/null +++ b/docs/camel.datagen.evol_instruct.rst @@ -0,0 +1,37 @@ +camel.datagen.evol\_instruct package +===================================== + +Submodules +---------- + +camel.datagen.evol\_instruct.evol\_instruct module +-------------------------------------------------- + +.. automodule:: camel.datagen.evol_instruct.evol_instruct + :members: + :undoc-members: + :show-inheritance: + +camel.datagen.evol\_instruct.scorer module +------------------------------------------ + +.. automodule:: camel.datagen.evol_instruct.scorer + :members: + :undoc-members: + :show-inheritance: + +camel.datagen.evol\_instruct.templates module +--------------------------------------------- + +.. automodule:: camel.datagen.evol_instruct.templates + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: camel.datagen.evol_instruct + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/camel.datagen.rst b/docs/camel.datagen.rst index 1fc7a8e0e7..81212e8d19 100644 --- a/docs/camel.datagen.rst +++ b/docs/camel.datagen.rst @@ -9,6 +9,7 @@ Subpackages camel.datagen.self_instruct camel.datagen.source2synth + camel.datagen.evol_instruct Submodules ---------- diff --git a/docs/camel.datasets.rst b/docs/camel.datasets.rst index d0cdc78a5b..3cf3088c63 100644 --- a/docs/camel.datasets.rst +++ b/docs/camel.datasets.rst @@ -4,10 +4,42 @@ camel.datasets package Submodules ---------- -camel.datasets.base module --------------------------- +camel.datasets.base\_generator module +------------------------------------- -.. automodule:: camel.datasets.base +.. automodule:: camel.datasets.base_generator + :members: + :undoc-members: + :show-inheritance: + +camel.datasets.few\_shot\_generator module +------------------------------------------ + +.. automodule:: camel.datasets.few_shot_generator + :members: + :undoc-members: + :show-inheritance: + +camel.datasets.models module +----------------------------- + +.. automodule:: camel.datasets.models + :members: + :undoc-members: + :show-inheritance: + +camel.datasets.self\_instruct\_generator module +----------------------------------------------- + +.. automodule:: camel.datasets.self_instruct_generator + :members: + :undoc-members: + :show-inheritance: + +camel.datasets.static\_dataset module +------------------------------------- + +.. automodule:: camel.datasets.static_dataset :members: :undoc-members: :show-inheritance: diff --git a/docs/camel.embeddings.rst b/docs/camel.embeddings.rst index 4157ec8dd7..8358238107 100644 --- a/docs/camel.embeddings.rst +++ b/docs/camel.embeddings.rst @@ -4,6 +4,14 @@ camel.embeddings package Submodules ---------- +camel.embeddings.azure\_embedding module +----------------------------------------- + +.. automodule:: camel.embeddings.azure_embedding + :members: + :undoc-members: + :show-inheritance: + camel.embeddings.base module ---------------------------- @@ -12,6 +20,22 @@ camel.embeddings.base module :undoc-members: :show-inheritance: +camel.embeddings.gemini\_embedding module +----------------------------------------- + +.. automodule:: camel.embeddings.gemini_embedding + :members: + :undoc-members: + :show-inheritance: + +camel.embeddings.jina\_embedding module +--------------------------------------- + +.. automodule:: camel.embeddings.jina_embedding + :members: + :undoc-members: + :show-inheritance: + camel.embeddings.mistral\_embedding module ------------------------------------------ @@ -20,6 +44,14 @@ camel.embeddings.mistral\_embedding module :undoc-members: :show-inheritance: +camel.embeddings.openai\_compatible\_embedding module +----------------------------------------------------- + +.. automodule:: camel.embeddings.openai_compatible_embedding + :members: + :undoc-members: + :show-inheritance: + camel.embeddings.openai\_embedding module ----------------------------------------- @@ -36,6 +68,14 @@ camel.embeddings.sentence\_transformers\_embeddings module :undoc-members: :show-inheritance: +camel.embeddings.together\_embedding module +------------------------------------------- + +.. automodule:: camel.embeddings.together_embedding + :members: + :undoc-members: + :show-inheritance: + camel.embeddings.vlm\_embedding module -------------------------------------- diff --git a/docs/camel.environments.rst b/docs/camel.environments.rst index c97ab2ebef..68c72fc0d3 100644 --- a/docs/camel.environments.rst +++ b/docs/camel.environments.rst @@ -4,10 +4,42 @@ camel.environments package Submodules ---------- -camel.environments.base module ------------------------------- +camel.environments.models module +--------------------------------- -.. automodule:: camel.environments.base +.. automodule:: camel.environments.models + :members: + :undoc-members: + :show-inheritance: + +camel.environments.multi\_step module +------------------------------------- + +.. automodule:: camel.environments.multi_step + :members: + :undoc-members: + :show-inheritance: + +camel.environments.rlcards\_env module +-------------------------------------- + +.. automodule:: camel.environments.rlcards_env + :members: + :undoc-members: + :show-inheritance: + +camel.environments.single\_step module +-------------------------------------- + +.. automodule:: camel.environments.single_step + :members: + :undoc-members: + :show-inheritance: + +camel.environments.tic\_tac\_toe module +--------------------------------------- + +.. automodule:: camel.environments.tic_tac_toe :members: :undoc-members: :show-inheritance: diff --git a/docs/camel.extractors.rst b/docs/camel.extractors.rst index b1b23fe82c..6dbb73af2b 100644 --- a/docs/camel.extractors.rst +++ b/docs/camel.extractors.rst @@ -12,6 +12,14 @@ camel.extractors.base module :undoc-members: :show-inheritance: +camel.extractors.python\_strategies module +------------------------------------------ + +.. automodule:: camel.extractors.python_strategies + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/camel.interpreters.rst b/docs/camel.interpreters.rst index edc25fbc63..755564be12 100644 --- a/docs/camel.interpreters.rst +++ b/docs/camel.interpreters.rst @@ -20,6 +20,14 @@ camel.interpreters.docker\_interpreter module :undoc-members: :show-inheritance: +camel.interpreters.e2b\_interpreter module +------------------------------------------ + +.. automodule:: camel.interpreters.e2b_interpreter + :members: + :undoc-members: + :show-inheritance: + camel.interpreters.internal\_python\_interpreter module ------------------------------------------------------- @@ -44,6 +52,14 @@ camel.interpreters.ipython\_interpreter module :undoc-members: :show-inheritance: +camel.interpreters.microsandbox\_interpreter module +--------------------------------------------------- + +.. automodule:: camel.interpreters.microsandbox_interpreter + :members: + :undoc-members: + :show-inheritance: + camel.interpreters.subprocess\_interpreter module ------------------------------------------------- diff --git a/docs/camel.loaders.rst b/docs/camel.loaders.rst index bb81b4e67b..2127d7faf9 100644 --- a/docs/camel.loaders.rst +++ b/docs/camel.loaders.rst @@ -4,6 +4,14 @@ camel.loaders package Submodules ---------- +camel.loaders.apify\_reader module +----------------------------------- + +.. automodule:: camel.loaders.apify_reader + :members: + :undoc-members: + :show-inheritance: + camel.loaders.base\_io module ----------------------------- @@ -12,6 +20,30 @@ camel.loaders.base\_io module :undoc-members: :show-inheritance: +camel.loaders.base\_loader module +--------------------------------- + +.. automodule:: camel.loaders.base_loader + :members: + :undoc-members: + :show-inheritance: + +camel.loaders.chunkr\_reader module +----------------------------------- + +.. automodule:: camel.loaders.chunkr_reader + :members: + :undoc-members: + :show-inheritance: + +camel.loaders.crawl4ai\_reader module +------------------------------------- + +.. automodule:: camel.loaders.crawl4ai_reader + :members: + :undoc-members: + :show-inheritance: + camel.loaders.firecrawl\_reader module -------------------------------------- @@ -28,6 +60,38 @@ camel.loaders.jina\_url\_reader module :undoc-members: :show-inheritance: +camel.loaders.markitdown module +------------------------------- + +.. automodule:: camel.loaders.markitdown + :members: + :undoc-members: + :show-inheritance: + +camel.loaders.mineru\_extractor module +-------------------------------------- + +.. automodule:: camel.loaders.mineru_extractor + :members: + :undoc-members: + :show-inheritance: + +camel.loaders.mistral\_reader module +------------------------------------ + +.. automodule:: camel.loaders.mistral_reader + :members: + :undoc-members: + :show-inheritance: + +camel.loaders.scrapegraph\_reader module +---------------------------------------- + +.. automodule:: camel.loaders.scrapegraph_reader + :members: + :undoc-members: + :show-inheritance: + camel.loaders.unstructured\_io module ------------------------------------- diff --git a/docs/camel.messages.rst b/docs/camel.messages.rst index 126dc30c95..a19b18eae9 100644 --- a/docs/camel.messages.rst +++ b/docs/camel.messages.rst @@ -1,6 +1,14 @@ camel.messages package ====================== +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + camel.messages.conversion + Submodules ---------- diff --git a/docs/camel.models.rst b/docs/camel.models.rst index 818a51e672..675911c5ab 100644 --- a/docs/camel.models.rst +++ b/docs/camel.models.rst @@ -1,9 +1,41 @@ camel.models package ==================== +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + camel.models.reward + Submodules ---------- +camel.models.aihubmix\_model module +------------------------------------ + +.. automodule:: camel.models.aihubmix_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.aiml\_model module +-------------------------------- + +.. automodule:: camel.models.aiml_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.amd\_model module +------------------------------- + +.. automodule:: camel.models.amd_model + :members: + :undoc-members: + :show-inheritance: + camel.models.anthropic\_model module ------------------------------------ @@ -12,6 +44,22 @@ camel.models.anthropic\_model module :undoc-members: :show-inheritance: +camel.models.atlascloud\_model module +------------------------------------- + +.. automodule:: camel.models.atlascloud_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.aws\_bedrock\_model module +--------------------------------------- + +.. automodule:: camel.models.aws_bedrock_model + :members: + :undoc-members: + :show-inheritance: + camel.models.azure\_openai\_model module ---------------------------------------- @@ -20,6 +68,14 @@ camel.models.azure\_openai\_model module :undoc-members: :show-inheritance: +camel.models.base\_audio\_model module +-------------------------------------- + +.. automodule:: camel.models.base_audio_model + :members: + :undoc-members: + :show-inheritance: + camel.models.base\_model module ------------------------------- @@ -28,6 +84,22 @@ camel.models.base\_model module :undoc-members: :show-inheritance: +camel.models.cerebras\_model module +----------------------------------- + +.. automodule:: camel.models.cerebras_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.cohere\_model module +--------------------------------- + +.. automodule:: camel.models.cohere_model + :members: + :undoc-members: + :show-inheritance: + camel.models.cometapi\_model module ----------------------------------- @@ -36,6 +108,38 @@ camel.models.cometapi\_model module :undoc-members: :show-inheritance: +camel.models.crynux\_model module +--------------------------------- + +.. automodule:: camel.models.crynux_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.deepseek\_model module +----------------------------------- + +.. automodule:: camel.models.deepseek_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.fish\_audio\_model module +-------------------------------------- + +.. automodule:: camel.models.fish_audio_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.function\_gemma\_model module +------------------------------------------ + +.. automodule:: camel.models.function_gemma_model + :members: + :undoc-members: + :show-inheritance: + camel.models.gemini\_model module --------------------------------- @@ -52,6 +156,14 @@ camel.models.groq\_model module :undoc-members: :show-inheritance: +camel.models.internlm\_model module +------------------------------------ + +.. automodule:: camel.models.internlm_model + :members: + :undoc-members: + :show-inheritance: + camel.models.litellm\_model module ---------------------------------- @@ -60,6 +172,22 @@ camel.models.litellm\_model module :undoc-members: :show-inheritance: +camel.models.lmstudio\_model module +----------------------------------- + +.. automodule:: camel.models.lmstudio_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.minimax\_model module +---------------------------------- + +.. automodule:: camel.models.minimax_model + :members: + :undoc-members: + :show-inheritance: + camel.models.mistral\_model module ---------------------------------- @@ -76,6 +204,38 @@ camel.models.model\_factory module :undoc-members: :show-inheritance: +camel.models.model\_manager module +---------------------------------- + +.. automodule:: camel.models.model_manager + :members: + :undoc-members: + :show-inheritance: + +camel.models.modelscope\_model module +------------------------------------- + +.. automodule:: camel.models.modelscope_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.moonshot\_model module +----------------------------------- + +.. automodule:: camel.models.moonshot_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.nebius\_model module +--------------------------------- + +.. automodule:: camel.models.nebius_model + :members: + :undoc-members: + :show-inheritance: + camel.models.nemotron\_model module ----------------------------------- @@ -84,6 +244,30 @@ camel.models.nemotron\_model module :undoc-members: :show-inheritance: +camel.models.netmind\_model module +---------------------------------- + +.. automodule:: camel.models.netmind_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.novita\_model module +--------------------------------- + +.. automodule:: camel.models.novita_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.nvidia\_model module +--------------------------------- + +.. automodule:: camel.models.nvidia_model + :members: + :undoc-members: + :show-inheritance: + camel.models.ollama\_model module --------------------------------- @@ -92,7 +276,7 @@ camel.models.ollama\_model module :undoc-members: :show-inheritance: -camel.models.open\_source\_model module +camel.models.openai\_audio\_models module ----------------------------------------- .. automodule:: camel.models.openai_audio_models @@ -116,6 +300,38 @@ camel.models.openai\_model module :undoc-members: :show-inheritance: +camel.models.openrouter\_model module +------------------------------------- + +.. automodule:: camel.models.openrouter_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.ppio\_model module +------------------------------- + +.. automodule:: camel.models.ppio_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.qianfan\_model module +---------------------------------- + +.. automodule:: camel.models.qianfan_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.qwen\_model module +------------------------------- + +.. automodule:: camel.models.qwen_model + :members: + :undoc-members: + :show-inheritance: + camel.models.reka\_model module ------------------------------- @@ -132,6 +348,22 @@ camel.models.samba\_model module :undoc-members: :show-inheritance: +camel.models.sglang\_model module +--------------------------------- + +.. automodule:: camel.models.sglang_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.siliconflow\_model module +-------------------------------------- + +.. automodule:: camel.models.siliconflow_model + :members: + :undoc-members: + :show-inheritance: + camel.models.stub\_model module ------------------------------- @@ -156,6 +388,30 @@ camel.models.vllm\_model module :undoc-members: :show-inheritance: +camel.models.volcano\_model module +---------------------------------- + +.. automodule:: camel.models.volcano_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.watsonx\_model module +---------------------------------- + +.. automodule:: camel.models.watsonx_model + :members: + :undoc-members: + :show-inheritance: + +camel.models.yi\_model module +------------------------------ + +.. automodule:: camel.models.yi_model + :members: + :undoc-members: + :show-inheritance: + camel.models.zhipuai\_model module ---------------------------------- diff --git a/docs/camel.prompts.rst b/docs/camel.prompts.rst index aa7bee66d7..0df9b4053d 100644 --- a/docs/camel.prompts.rst +++ b/docs/camel.prompts.rst @@ -76,6 +76,14 @@ camel.prompts.object\_recognition module :undoc-members: :show-inheritance: +camel.prompts.persona\_hub module +--------------------------------- + +.. automodule:: camel.prompts.persona_hub + :members: + :undoc-members: + :show-inheritance: + camel.prompts.prompt\_templates module -------------------------------------- diff --git a/docs/camel.retrievers.rst b/docs/camel.retrievers.rst index 7e0f3b158f..90e335030f 100644 --- a/docs/camel.retrievers.rst +++ b/docs/camel.retrievers.rst @@ -36,6 +36,22 @@ camel.retrievers.cohere\_rerank\_retriever module :undoc-members: :show-inheritance: +camel.retrievers.hybrid\_retrival module +---------------------------------------- + +.. automodule:: camel.retrievers.hybrid_retrival + :members: + :undoc-members: + :show-inheritance: + +camel.retrievers.jina\_rerank\_retriever module +----------------------------------------------- + +.. automodule:: camel.retrievers.jina_rerank_retriever + :members: + :undoc-members: + :show-inheritance: + camel.retrievers.vector\_retriever module ----------------------------------------- diff --git a/docs/camel.rst b/docs/camel.rst index 740b64a111..2d12d1543c 100644 --- a/docs/camel.rst +++ b/docs/camel.rst @@ -8,17 +8,27 @@ Subpackages :maxdepth: 4 camel.agents + camel.benchmarks + camel.bots camel.configs + camel.data_collectors camel.datagen + camel.datahubs + camel.datasets camel.embeddings + camel.environments + camel.extractors camel.interpreters camel.loaders camel.memories camel.messages camel.models + camel.personas camel.prompts camel.responses camel.retrievers + camel.runtimes + camel.schemas camel.societies camel.storages camel.tasks @@ -26,6 +36,7 @@ Subpackages camel.toolkits camel.types camel.utils + camel.verifiers Submodules ---------- diff --git a/docs/camel.runtime.rst b/docs/camel.runtime.rst deleted file mode 100644 index 2eaf49584e..0000000000 --- a/docs/camel.runtime.rst +++ /dev/null @@ -1,69 +0,0 @@ -camel.runtime package -===================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - camel.runtime.utils - -Submodules ----------- - -camel.runtime.api module ------------------------- - -.. automodule:: camel.runtime.api - :members: - :undoc-members: - :show-inheritance: - -camel.runtime.base module -------------------------- - -.. automodule:: camel.runtime.base - :members: - :undoc-members: - :show-inheritance: - -camel.runtime.configs module ----------------------------- - -.. automodule:: camel.runtime.configs - :members: - :undoc-members: - :show-inheritance: - -camel.runtime.docker\_runtime module ------------------------------------- - -.. automodule:: camel.runtime.docker_runtime - :members: - :undoc-members: - :show-inheritance: - -camel.runtime.llm\_guard\_runtime module ----------------------------------------- - -.. automodule:: camel.runtime.llm_guard_runtime - :members: - :undoc-members: - :show-inheritance: - -camel.runtime.remote\_http\_runtime module ------------------------------------------- - -.. automodule:: camel.runtime.remote_http_runtime - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: camel.runtime - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/camel.runtime.utils.rst b/docs/camel.runtime.utils.rst deleted file mode 100644 index 4d806d09e8..0000000000 --- a/docs/camel.runtime.utils.rst +++ /dev/null @@ -1,29 +0,0 @@ -camel.runtime.utils package -=========================== - -Submodules ----------- - -camel.runtime.utils.function\_risk\_toolkit module --------------------------------------------------- - -.. automodule:: camel.runtime.utils.function_risk_toolkit - :members: - :undoc-members: - :show-inheritance: - -camel.runtime.utils.ignore\_risk\_toolkit module ------------------------------------------------- - -.. automodule:: camel.runtime.utils.ignore_risk_toolkit - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: camel.runtime.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/camel.runtimes.rst b/docs/camel.runtimes.rst new file mode 100644 index 0000000000..6d9287574f --- /dev/null +++ b/docs/camel.runtimes.rst @@ -0,0 +1,85 @@ +camel.runtimes package +====================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + camel.runtimes.utils + +Submodules +---------- + +camel.runtimes.api module +------------------------- + +.. automodule:: camel.runtimes.api + :members: + :undoc-members: + :show-inheritance: + +camel.runtimes.base module +-------------------------- + +.. automodule:: camel.runtimes.base + :members: + :undoc-members: + :show-inheritance: + +camel.runtimes.configs module +----------------------------- + +.. automodule:: camel.runtimes.configs + :members: + :undoc-members: + :show-inheritance: + +camel.runtimes.daytona\_runtime module +-------------------------------------- + +.. automodule:: camel.runtimes.daytona_runtime + :members: + :undoc-members: + :show-inheritance: + +camel.runtimes.docker\_runtime module +------------------------------------- + +.. automodule:: camel.runtimes.docker_runtime + :members: + :undoc-members: + :show-inheritance: + +camel.runtimes.llm\_guard\_runtime module +----------------------------------------- + +.. automodule:: camel.runtimes.llm_guard_runtime + :members: + :undoc-members: + :show-inheritance: + +camel.runtimes.remote\_http\_runtime module +------------------------------------------- + +.. automodule:: camel.runtimes.remote_http_runtime + :members: + :undoc-members: + :show-inheritance: + +camel.runtimes.ubuntu\_docker\_runtime module +--------------------------------------------- + +.. automodule:: camel.runtimes.ubuntu_docker_runtime + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: camel.runtimes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/camel.runtimes.utils.rst b/docs/camel.runtimes.utils.rst new file mode 100644 index 0000000000..2dc95c0177 --- /dev/null +++ b/docs/camel.runtimes.utils.rst @@ -0,0 +1,29 @@ +camel.runtimes.utils package +============================ + +Submodules +---------- + +camel.runtimes.utils.function\_risk\_toolkit module +--------------------------------------------------- + +.. automodule:: camel.runtimes.utils.function_risk_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.runtimes.utils.ignore\_risk\_toolkit module +------------------------------------------------- + +.. automodule:: camel.runtimes.utils.ignore_risk_toolkit + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: camel.runtimes.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/camel.societies.workforce.rst b/docs/camel.societies.workforce.rst index 41d1cd8fb8..f5aca2f48c 100644 --- a/docs/camel.societies.workforce.rst +++ b/docs/camel.societies.workforce.rst @@ -12,6 +12,14 @@ camel.societies.workforce.base module :undoc-members: :show-inheritance: +camel.societies.workforce.events module +--------------------------------------- + +.. automodule:: camel.societies.workforce.events + :members: + :undoc-members: + :show-inheritance: + camel.societies.workforce.prompts module --------------------------- @@ -36,6 +44,14 @@ camel.societies.workforce.single\_agent\_worker module :undoc-members: :show-inheritance: +camel.societies.workforce.structured\_output\_handler module +------------------------------------------------------------ + +.. automodule:: camel.societies.workforce.structured_output_handler + :members: + :undoc-members: + :show-inheritance: + camel.societies.workforce.task\_channel module ------------------------------------------ @@ -60,6 +76,14 @@ camel.societies.workforce.worker module :undoc-members: :show-inheritance: +camel.societies.workforce.workflow\_memory\_manager module +--------------------------------------------------------- + +.. automodule:: camel.societies.workforce.workflow_memory_manager + :members: + :undoc-members: + :show-inheritance: + camel.societies.workforce.workforce module -------------------------------- @@ -68,6 +92,30 @@ camel.societies.workforce.workforce module :undoc-members: :show-inheritance: +camel.societies.workforce.workforce\_callback module +---------------------------------------------------- + +.. automodule:: camel.societies.workforce.workforce_callback + :members: + :undoc-members: + :show-inheritance: + +camel.societies.workforce.workforce\_logger module +-------------------------------------------------- + +.. automodule:: camel.societies.workforce.workforce_logger + :members: + :undoc-members: + :show-inheritance: + +camel.societies.workforce.workforce\_metrics module +--------------------------------------------------- + +.. automodule:: camel.societies.workforce.workforce_metrics + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/camel.storages.graph_storages.rst b/docs/camel.storages.graph_storages.rst index 1683e1a3b6..84a2468a07 100644 --- a/docs/camel.storages.graph_storages.rst +++ b/docs/camel.storages.graph_storages.rst @@ -20,6 +20,14 @@ camel.storages.graph\_storages.graph\_element module :undoc-members: :show-inheritance: +camel.storages.graph\_storages.nebula\_graph module +--------------------------------------------------- + +.. automodule:: camel.storages.graph_storages.nebula_graph + :members: + :undoc-members: + :show-inheritance: + camel.storages.graph\_storages.neo4j\_graph module -------------------------------------------------- diff --git a/docs/camel.storages.key_value_storages.rst b/docs/camel.storages.key_value_storages.rst index 0050c46105..421256cfff 100644 --- a/docs/camel.storages.key_value_storages.rst +++ b/docs/camel.storages.key_value_storages.rst @@ -28,6 +28,14 @@ camel.storages.key\_value\_storages.json module :undoc-members: :show-inheritance: +camel.storages.key\_value\_storages.mem0\_cloud module +----------------------------------------------------- + +.. automodule:: camel.storages.key_value_storages.mem0_cloud + :members: + :undoc-members: + :show-inheritance: + camel.storages.key\_value\_storages.redis module ------------------------------------------------ diff --git a/docs/camel.storages.vectordb_storages.rst b/docs/camel.storages.vectordb_storages.rst index eeff0b9c4f..72153eb08c 100644 --- a/docs/camel.storages.vectordb_storages.rst +++ b/docs/camel.storages.vectordb_storages.rst @@ -12,6 +12,22 @@ camel.storages.vectordb\_storages.base module :undoc-members: :show-inheritance: +camel.storages.vectordb\_storages.chroma module +----------------------------------------------- + +.. automodule:: camel.storages.vectordb_storages.chroma + :members: + :undoc-members: + :show-inheritance: + +camel.storages.vectordb\_storages.faiss module +----------------------------------------------- + +.. automodule:: camel.storages.vectordb_storages.faiss + :members: + :undoc-members: + :show-inheritance: + camel.storages.vectordb\_storages.milvus module ----------------------------------------------- @@ -20,26 +36,50 @@ camel.storages.vectordb\_storages.milvus module :undoc-members: :show-inheritance: +camel.storages.vectordb\_storages.oceanbase module +-------------------------------------------------- + +.. automodule:: camel.storages.vectordb_storages.oceanbase + :members: + :undoc-members: + :show-inheritance: + +camel.storages.vectordb\_storages.pgvector module +------------------------------------------------- + +.. automodule:: camel.storages.vectordb_storages.pgvector + :members: + :undoc-members: + :show-inheritance: + camel.storages.vectordb\_storages.qdrant module ----------------------------------------------- -.. automodule:: camel.storages.vectordb_storages.tidb +.. automodule:: camel.storages.vectordb_storages.qdrant + :members: + :undoc-members: + :show-inheritance: + +camel.storages.vectordb\_storages.surreal module +------------------------------------------------ + +.. automodule:: camel.storages.vectordb_storages.surreal :members: :undoc-members: :show-inheritance: camel.storages.vectordb\_storages.tidb module ------------------------------------------------ +--------------------------------------------- -.. automodule:: camel.storages.vectordb_storages.qdrant +.. automodule:: camel.storages.vectordb_storages.tidb :members: :undoc-members: :show-inheritance: -camel.storages.vectordb\_storages.faiss module ------------------------------------------------ +camel.storages.vectordb\_storages.weaviate module +------------------------------------------------- -.. automodule:: camel.storages.vectordb_storages.faiss +.. automodule:: camel.storages.vectordb_storages.weaviate :members: :undoc-members: :show-inheritance: diff --git a/docs/camel.toolkits.hybrid_browser_toolkit.rst b/docs/camel.toolkits.hybrid_browser_toolkit.rst new file mode 100644 index 0000000000..628c1640de --- /dev/null +++ b/docs/camel.toolkits.hybrid_browser_toolkit.rst @@ -0,0 +1,53 @@ +camel.toolkits.hybrid\_browser\_toolkit package +================================================ + +Submodules +---------- + +camel.toolkits.hybrid\_browser\_toolkit.config\_loader module +------------------------------------------------------------- + +.. automodule:: camel.toolkits.hybrid_browser_toolkit.config_loader + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.hybrid\_browser\_toolkit.hybrid\_browser\_toolkit module +----------------------------------------------------------------------- + +.. automodule:: camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.hybrid\_browser\_toolkit.hybrid\_browser\_toolkit\_ts module +--------------------------------------------------------------------------- + +.. automodule:: camel.toolkits.hybrid_browser_toolkit.hybrid_browser_toolkit_ts + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.hybrid\_browser\_toolkit.installer module +-------------------------------------------------------- + +.. automodule:: camel.toolkits.hybrid_browser_toolkit.installer + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.hybrid\_browser\_toolkit.ws\_wrapper module +---------------------------------------------------------- + +.. automodule:: camel.toolkits.hybrid_browser_toolkit.ws_wrapper + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: camel.toolkits.hybrid_browser_toolkit + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/camel.toolkits.rst b/docs/camel.toolkits.rst index d8c1347309..fb7229b172 100644 --- a/docs/camel.toolkits.rst +++ b/docs/camel.toolkits.rst @@ -1,9 +1,57 @@ camel.toolkits package ====================== +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + camel.toolkits.hybrid_browser_toolkit + Submodules ---------- +camel.toolkits.aci\_toolkit module +---------------------------------- + +.. automodule:: camel.toolkits.aci_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.arxiv\_toolkit module +------------------------------------ + +.. automodule:: camel.toolkits.arxiv_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.ask\_news\_toolkit module +---------------------------------------- + +.. automodule:: camel.toolkits.ask_news_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.async\_browser\_toolkit module +--------------------------------------------- + +.. automodule:: camel.toolkits.async_browser_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.audio\_analysis\_toolkit module +---------------------------------------------- + +.. automodule:: camel.toolkits.audio_analysis_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.base module -------------------------- @@ -12,6 +60,30 @@ camel.toolkits.base module :undoc-members: :show-inheritance: +camel.toolkits.bohrium\_toolkit module +-------------------------------------- + +.. automodule:: camel.toolkits.bohrium_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.browser\_toolkit module +-------------------------------------- + +.. automodule:: camel.toolkits.browser_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.browser\_toolkit\_commons module +----------------------------------------------- + +.. automodule:: camel.toolkits.browser_toolkit_commons + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.code\_execution module ------------------------------------- @@ -20,10 +92,82 @@ camel.toolkits.code\_execution module :undoc-members: :show-inheritance: -camel.toolkits.dalle\_toolkit module +camel.toolkits.context\_summarizer\_toolkit module +-------------------------------------------------- + +.. automodule:: camel.toolkits.context_summarizer_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.craw4ai\_toolkit module +-------------------------------------- + +.. automodule:: camel.toolkits.craw4ai_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.dappier\_toolkit module +-------------------------------------- + +.. automodule:: camel.toolkits.dappier_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.data\_commons\_toolkit module +-------------------------------------------- + +.. automodule:: camel.toolkits.data_commons_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.dingtalk module +------------------------------ + +.. automodule:: camel.toolkits.dingtalk + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.earth\_science\_toolkit module +--------------------------------------------- + +.. automodule:: camel.toolkits.earth_science_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.edgeone\_pages\_mcp\_toolkit module +-------------------------------------------------- + +.. automodule:: camel.toolkits.edgeone_pages_mcp_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.excel\_toolkit module +------------------------------------ + +.. automodule:: camel.toolkits.excel_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.file\_toolkit module +----------------------------------- + +.. automodule:: camel.toolkits.file_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.function\_tool module ------------------------------------ -.. automodule:: camel.toolkits.dalle_toolkit +.. automodule:: camel.toolkits.function_tool :members: :undoc-members: :show-inheritance: @@ -36,6 +180,30 @@ camel.toolkits.github\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.gmail\_toolkit module +------------------------------------ + +.. automodule:: camel.toolkits.gmail_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.google\_calendar\_toolkit module +----------------------------------------------- + +.. automodule:: camel.toolkits.google_calendar_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.google\_drive\_mcp\_toolkit module +------------------------------------------------- + +.. automodule:: camel.toolkits.google_drive_mcp_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.google\_maps\_toolkit module ------------------------------------------- @@ -44,6 +212,70 @@ camel.toolkits.google\_maps\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.google\_scholar\_toolkit module +---------------------------------------------- + +.. automodule:: camel.toolkits.google_scholar_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.human\_toolkit module +------------------------------------ + +.. automodule:: camel.toolkits.human_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.image\_analysis\_toolkit module +---------------------------------------------- + +.. automodule:: camel.toolkits.image_analysis_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.image\_generation\_toolkit module +------------------------------------------------ + +.. automodule:: camel.toolkits.image_generation_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.imap\_mail\_toolkit module +----------------------------------------- + +.. automodule:: camel.toolkits.imap_mail_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.jina\_reranker\_toolkit module +--------------------------------------------- + +.. automodule:: camel.toolkits.jina_reranker_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.klavis\_toolkit module +------------------------------------- + +.. automodule:: camel.toolkits.klavis_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.lark\_toolkit module +----------------------------------- + +.. automodule:: camel.toolkits.lark_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.linkedin\_toolkit module --------------------------------------- @@ -52,6 +284,14 @@ camel.toolkits.linkedin\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.markitdown\_toolkit module +----------------------------------------- + +.. automodule:: camel.toolkits.markitdown_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.math\_toolkit module ----------------------------------- @@ -60,6 +300,102 @@ camel.toolkits.math\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.mcp\_toolkit module +---------------------------------- + +.. automodule:: camel.toolkits.mcp_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.memory\_toolkit module +------------------------------------- + +.. automodule:: camel.toolkits.memory_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.meshy\_toolkit module +------------------------------------ + +.. automodule:: camel.toolkits.meshy_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.message\_agent\_toolkit module +--------------------------------------------- + +.. automodule:: camel.toolkits.message_agent_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.message\_integration module +------------------------------------------ + +.. automodule:: camel.toolkits.message_integration + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.microsoft\_outlook\_mail\_toolkit module +------------------------------------------------------- + +.. automodule:: camel.toolkits.microsoft_outlook_mail_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.mineru\_toolkit module +------------------------------------- + +.. automodule:: camel.toolkits.mineru_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.minimax\_mcp\_toolkit module +------------------------------------------- + +.. automodule:: camel.toolkits.minimax_mcp_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.networkx\_toolkit module +--------------------------------------- + +.. automodule:: camel.toolkits.networkx_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.note\_taking\_toolkit module +------------------------------------------- + +.. automodule:: camel.toolkits.note_taking_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.notion\_mcp\_toolkit module +------------------------------------------ + +.. automodule:: camel.toolkits.notion_mcp_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.notion\_toolkit module +------------------------------------- + +.. automodule:: camel.toolkits.notion_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.open\_api\_toolkit module ---------------------------------------- @@ -68,10 +404,58 @@ camel.toolkits.open\_api\_toolkit module :undoc-members: :show-inheritance: -camel.toolkits.openai\_function module --------------------------------------- +camel.toolkits.openbb\_toolkit module +------------------------------------- -.. automodule:: camel.toolkits.function_tool +.. automodule:: camel.toolkits.openbb_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.origene\_mcp\_toolkit module +------------------------------------------- + +.. automodule:: camel.toolkits.origene_mcp_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.playwright\_mcp\_toolkit module +---------------------------------------------- + +.. automodule:: camel.toolkits.playwright_mcp_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.pptx\_toolkit module +----------------------------------- + +.. automodule:: camel.toolkits.pptx_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.pubmed\_toolkit module +------------------------------------- + +.. automodule:: camel.toolkits.pubmed_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.pulse\_mcp\_search\_toolkit module +------------------------------------------------- + +.. automodule:: camel.toolkits.pulse_mcp_search_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.pyautogui\_toolkit module +---------------------------------------- + +.. automodule:: camel.toolkits.pyautogui_toolkit :members: :undoc-members: :show-inheritance: @@ -84,6 +468,14 @@ camel.toolkits.reddit\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.resend\_toolkit module +------------------------------------- + +.. automodule:: camel.toolkits.resend_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.retrieval\_toolkit module ---------------------------------------- @@ -92,6 +484,14 @@ camel.toolkits.retrieval\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.screenshot\_toolkit module +----------------------------------------- + +.. automodule:: camel.toolkits.screenshot_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.search\_toolkit module ------------------------------------- @@ -100,6 +500,30 @@ camel.toolkits.search\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.searxng\_toolkit module +-------------------------------------- + +.. automodule:: camel.toolkits.searxng_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.semantic\_scholar\_toolkit module +------------------------------------------------ + +.. automodule:: camel.toolkits.semantic_scholar_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.skill\_toolkit module +------------------------------------ + +.. automodule:: camel.toolkits.skill_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.slack\_toolkit module ------------------------------------ @@ -108,6 +532,46 @@ camel.toolkits.slack\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.sql\_toolkit module +---------------------------------- + +.. automodule:: camel.toolkits.sql_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.stripe\_toolkit module +------------------------------------- + +.. automodule:: camel.toolkits.stripe_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.sympy\_toolkit module +------------------------------------ + +.. automodule:: camel.toolkits.sympy_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.task\_planning\_toolkit module +--------------------------------------------- + +.. automodule:: camel.toolkits.task_planning_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.thinking\_toolkit module +--------------------------------------- + +.. automodule:: camel.toolkits.thinking_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.twitter\_toolkit module -------------------------------------- @@ -116,6 +580,30 @@ camel.toolkits.twitter\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.vertex\_ai\_veo\_toolkit module +---------------------------------------------- + +.. automodule:: camel.toolkits.vertex_ai_veo_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.video\_analysis\_toolkit module +---------------------------------------------- + +.. automodule:: camel.toolkits.video_analysis_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.video\_download\_toolkit module +---------------------------------------------- + +.. automodule:: camel.toolkits.video_download_toolkit + :members: + :undoc-members: + :show-inheritance: + camel.toolkits.weather\_toolkit module -------------------------------------- @@ -124,6 +612,46 @@ camel.toolkits.weather\_toolkit module :undoc-members: :show-inheritance: +camel.toolkits.web\_deploy\_toolkit module +------------------------------------------ + +.. automodule:: camel.toolkits.web_deploy_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.wechat\_official\_toolkit module +----------------------------------------------- + +.. automodule:: camel.toolkits.wechat_official_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.whatsapp\_toolkit module +--------------------------------------- + +.. automodule:: camel.toolkits.whatsapp_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.wolfram\_alpha\_toolkit module +--------------------------------------------- + +.. automodule:: camel.toolkits.wolfram_alpha_toolkit + :members: + :undoc-members: + :show-inheritance: + +camel.toolkits.zapier\_toolkit module +------------------------------------- + +.. automodule:: camel.toolkits.zapier_toolkit + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/camel.types.rst b/docs/camel.types.rst index 06d1c5cf8e..0edd5fbe92 100644 --- a/docs/camel.types.rst +++ b/docs/camel.types.rst @@ -12,6 +12,14 @@ camel.types.enums module :undoc-members: :show-inheritance: +camel.types.mcp\_registries module +---------------------------------- + +.. automodule:: camel.types.mcp_registries + :members: + :undoc-members: + :show-inheritance: + camel.types.openai\_types module -------------------------------- @@ -20,6 +28,14 @@ camel.types.openai\_types module :undoc-members: :show-inheritance: +camel.types.unified\_model\_type module +--------------------------------------- + +.. automodule:: camel.types.unified_model_type + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/camel.utils.rst b/docs/camel.utils.rst index c828947ffc..73f04c91d1 100644 --- a/docs/camel.utils.rst +++ b/docs/camel.utils.rst @@ -12,6 +12,14 @@ camel.utils.async\_func module :undoc-members: :show-inheritance: +camel.utils.agent\_context module +--------------------------------- + +.. automodule:: camel.utils.agent_context + :members: + :undoc-members: + :show-inheritance: + camel.utils.commons module -------------------------- @@ -28,6 +36,70 @@ camel.utils.constants module :undoc-members: :show-inheritance: +camel.utils.context\_utils module +--------------------------------- + +.. automodule:: camel.utils.context_utils + :members: + :undoc-members: + :show-inheritance: + +camel.utils.deduplication module +-------------------------------- + +.. automodule:: camel.utils.deduplication + :members: + :undoc-members: + :show-inheritance: + +camel.utils.filename module +--------------------------- + +.. automodule:: camel.utils.filename + :members: + :undoc-members: + :show-inheritance: + +camel.utils.langfuse module +--------------------------- + +.. automodule:: camel.utils.langfuse + :members: + :undoc-members: + :show-inheritance: + +camel.utils.mcp module +----------------------- + +.. automodule:: camel.utils.mcp + :members: + :undoc-members: + :show-inheritance: + +camel.utils.mcp\_client module +------------------------------ + +.. automodule:: camel.utils.mcp_client + :members: + :undoc-members: + :show-inheritance: + +camel.utils.message\_summarizer module +-------------------------------------- + +.. automodule:: camel.utils.message_summarizer + :members: + :undoc-members: + :show-inheritance: + +camel.utils.response\_format module +----------------------------------- + +.. automodule:: camel.utils.response_format + :members: + :undoc-members: + :show-inheritance: + camel.utils.token\_counting module ---------------------------------- @@ -36,6 +108,14 @@ camel.utils.token\_counting module :undoc-members: :show-inheritance: +camel.utils.tool\_result module +------------------------------- + +.. automodule:: camel.utils.tool_result + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/camel.verifiers.rst b/docs/camel.verifiers.rst index ff504b36e3..acd3a2a825 100644 --- a/docs/camel.verifiers.rst +++ b/docs/camel.verifiers.rst @@ -28,6 +28,22 @@ camel.verifiers.python\_verifier module :undoc-members: :show-inheritance: +camel.verifiers.math\_verifier module +------------------------------------- + +.. automodule:: camel.verifiers.math_verifier + :members: + :undoc-members: + :show-inheritance: + +camel.verifiers.physics\_verifier module +---------------------------------------- + +.. automodule:: camel.verifiers.physics_verifier + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/index.rst b/docs/index.rst index 1ba6d24614..326c5f496f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -49,7 +49,7 @@ Main Documentation key_modules/embeddings.md key_modules/retrievers.md key_modules/workforce.md - key_modules/benchmark.md + key_modules/Benchmark.md .. toctree:: :maxdepth: 2 diff --git a/docs/key_modules/runtimes.md b/docs/key_modules/runtimes.md index 977fb3ef0a..9eb69a9978 100644 --- a/docs/key_modules/runtimes.md +++ b/docs/key_modules/runtimes.md @@ -122,7 +122,7 @@ All runtimes inherit from BaseRuntime, which defines core methods: ## More Examples -You’ll find runnable scripts for each runtime in [examples/runtime](https://github.com/camel-ai/camel/tree/master/examples/runtimes)/ in our main repo. +You’ll find runnable scripts for each runtime in [examples/runtimes](https://github.com/camel-ai/camel/tree/master/examples/runtimes)/ in our main repo. Each script demonstrates how to initialize and use a specific runtime—perfect for experimentation or production setups. ## Final Note diff --git a/docs/key_modules/storages.md b/docs/key_modules/storages.md index 9c374f95f5..3ea72b29ff 100644 --- a/docs/key_modules/storages.md +++ b/docs/key_modules/storages.md @@ -310,7 +310,8 @@ Here are practical usage patterns for each storage type—pick the ones you need ```python import os - from camel.storages import SurrealStorage, VectorDBQuery, VectorRecord + from camel.storages.vectordb_storages import SurrealStorage + from camel.storages import VectorDBQuery, VectorRecord # Set environment variables for SurrealDB connection os.environ["SURREAL_URL"] = "ws://localhost:8000/rpc" diff --git a/docs/mcp/camel_agents_as_an_mcp_clients.md b/docs/mcp/camel_agents_as_an_mcp_clients.md index 033e8a71b3..387292e7fe 100644 --- a/docs/mcp/camel_agents_as_an_mcp_clients.md +++ b/docs/mcp/camel_agents_as_an_mcp_clients.md @@ -126,7 +126,8 @@ Want your MCP agent discoverable by thousands of clients? Register it with a hub like ACI.dev or similar. ```python Register with ACI Registry lines icon="python" from camel.agents import MCPAgent -from camel.types import ACIRegistryConfig, ModelFactory, ModelPlatformType, ModelType +from camel.models import ModelFactory +from camel.types import ACIRegistryConfig, ModelPlatformType, ModelType import os aci_config = ACIRegistryConfig( @@ -160,7 +161,7 @@ You can visit [PulseMCP.com](https://pulsemcp.com) to browse all available MCP s If you prefer to search programmatically inside your CAMEL code, just use: -from camel.toolkits.mcp import PulseMCPSearchToolkit +from camel.toolkits import PulseMCPSearchToolkit search_toolkit = PulseMCPSearchToolkit() results = search_toolkit.search_mcp_servers(query="Slack", top_k=1) diff --git a/docs/reference/camel.toolkits.file_write_toolkit.md b/docs/reference/camel.toolkits.file_write_toolkit.md index fc5f43fe97..f679d8ecf5 100644 --- a/docs/reference/camel.toolkits.file_write_toolkit.md +++ b/docs/reference/camel.toolkits.file_write_toolkit.md @@ -1,6 +1,6 @@ - + - + ## FileWriteToolkit @@ -16,7 +16,7 @@ replacing text in existing files, automatic filename uniquification to prevent overwrites, custom encoding and enhanced formatting options for specialized formats. - + ### __init__ @@ -39,7 +39,7 @@ Initialize the FileWriteToolkit. - **default_encoding** (str): Default character encoding for text operations. (default: :obj:`utf-8`) - **backup_enabled** (bool): Whether to create backups of existing files before overwriting. (default: :obj:`True`) - + ### _resolve_filepath @@ -62,7 +62,7 @@ in downstream processing. Path: A fully resolved (absolute) and sanitized Path object. - + ### _sanitize_filename @@ -83,7 +83,7 @@ underscore (_). str: The sanitized filename with disallowed characters replaced by underscores. - + ### _write_text_file @@ -104,7 +104,7 @@ Write text content to a plaintext file. - **content** (str): The text content to write. - **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8) - + ### _generate_unique_filename @@ -122,7 +122,7 @@ Generate a unique filename if the target file already exists. Path: A unique file path that doesn't exist yet. - + ### _write_docx_file @@ -137,7 +137,7 @@ Write text content to a DOCX file with default formatting. - **file_path** (Path): The target file path. - **content** (str): The text content to write. - + ### _write_pdf_file @@ -161,7 +161,7 @@ Write text content to a PDF file with LaTeX and table support. - **be**: - String: Supports Markdown-style tables and LaTeX math expressions - List[List[str]]: Table data as list of rows for direct table rendering - **use_latex** (bool): Whether to use LaTeX for math rendering. (default: :obj:`False`) - + ### _process_text_content @@ -184,7 +184,7 @@ Process text content and add to story. - **heading_style**: Style for headings - **body_style**: Style for body text - + ### _find_table_line_ranges @@ -203,7 +203,7 @@ Find line ranges that contain markdown tables. List[Tuple[int, int]]: List of (start_line, end_line) tuples for table ranges. - + ### _register_chinese_font @@ -215,7 +215,7 @@ def _register_chinese_font(self): str: The font name to use for Chinese text. - + ### _parse_markdown_table @@ -234,7 +234,7 @@ Parse markdown-style tables from a list of lines. List[List[List[str]]]: List of tables, where each table is a list of rows, and each row is a list of cells. - + ### _is_table_row @@ -252,7 +252,7 @@ Check if a line appears to be a table row. bool: True if the line looks like a table row. - + ### _is_table_separator @@ -270,7 +270,7 @@ Check if a line is a table separator (e.g., |---|---|). bool: True if the line is a table separator. - + ### _parse_table_row @@ -288,7 +288,7 @@ Parse a single table row into cells. List[str]: List of cell contents. - + ### _create_pdf_table @@ -306,7 +306,7 @@ Create a formatted table for PDF. Table: A formatted reportlab Table object. - + ### _convert_markdown_to_html @@ -324,7 +324,7 @@ Convert basic markdown formatting to HTML for PDF rendering. str: Text with HTML formatting. - + ### _write_csv_file @@ -345,7 +345,7 @@ Write CSV content to a file. - **content** (Union[str, List[List]]): The CSV content as a string or list of lists. - **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8) - + ### _write_json_file @@ -366,7 +366,7 @@ Write JSON content to a file. - **content** (str): The JSON content as a string. - **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8) - + ### _write_simple_text_file @@ -387,7 +387,7 @@ Write text content to a file (used for HTML, Markdown, YAML, etc.). - **content** (str): The content to write. - **encoding** (str): Character encoding to use. (default: :obj:`utf-8`) (default: utf-8) - + ### write_to_file @@ -421,7 +421,7 @@ and HTML (.html, .htm). str: A message indicating success or error details. - + ### get_tools diff --git a/docs/reference/camel.toolkits.hybrid_browser_toolkit.actions.md b/docs/reference/camel.toolkits.hybrid_browser_toolkit.actions.md deleted file mode 100644 index 340b6a1882..0000000000 --- a/docs/reference/camel.toolkits.hybrid_browser_toolkit.actions.md +++ /dev/null @@ -1,36 +0,0 @@ - - - - -## ActionExecutor - -```python -class ActionExecutor: -``` - -Executes high-level actions (click, type …) on a Playwright Page. - - - -### __init__ - -```python -def __init__( - self, - page: 'Page', - session: Optional[Any] = None, - default_timeout: Optional[int] = None, - short_timeout: Optional[int] = None, - max_scroll_amount: Optional[int] = None -): -``` - - - -### should_update_snapshot - -```python -def should_update_snapshot(action: Dict[str, Any]): -``` - -Determine if an action requires a snapshot update. diff --git a/docs/reference/camel.toolkits.hybrid_browser_toolkit.agent.md b/docs/reference/camel.toolkits.hybrid_browser_toolkit.agent.md deleted file mode 100644 index f166c3ed16..0000000000 --- a/docs/reference/camel.toolkits.hybrid_browser_toolkit.agent.md +++ /dev/null @@ -1,66 +0,0 @@ - - - - -## PlaywrightLLMAgent - -```python -class PlaywrightLLMAgent: -``` - -High-level orchestration: snapshot ↔ LLM ↔ action executor. - - - -### __init__ - -```python -def __init__(self): -``` - - - -### _get_chat_agent - -```python -def _get_chat_agent(self): -``` - -Get or create the ChatAgent instance. - - - -### _safe_parse_json - -```python -def _safe_parse_json(self, content: str): -``` - -Safely parse JSON from LLM response with multiple fallback -strategies. - - - -### _get_fallback_response - -```python -def _get_fallback_response(self, error_msg: str): -``` - -Generate a fallback response structure. - - - -### _llm_call - -```python -def _llm_call( - self, - prompt: str, - snapshot: str, - is_initial: bool, - history: Optional[List[Dict[str, Any]]] = None -): -``` - -Call the LLM (via CAMEL ChatAgent) to get plan & next action. diff --git a/docs/reference/camel.toolkits.hybrid_browser_toolkit.browser_session.md b/docs/reference/camel.toolkits.hybrid_browser_toolkit.browser_session.md deleted file mode 100644 index 22a09fb93d..0000000000 --- a/docs/reference/camel.toolkits.hybrid_browser_toolkit.browser_session.md +++ /dev/null @@ -1,44 +0,0 @@ - - - - -## HybridBrowserSession - -```python -class HybridBrowserSession: -``` - -Lightweight wrapper around Playwright for -browsing with multi-tab support. - -It provides multiple *Page* instances plus helper utilities (snapshot & -executor). Multiple toolkits or agents can reuse this class without -duplicating Playwright setup code. - -This class is a singleton per event-loop and session-id combination. - - - -### __new__ - -```python -def __new__(cls): -``` - - - -### __init__ - -```python -def __init__(self): -``` - - - -### _load_stealth_script - -```python -def _load_stealth_script(self): -``` - -Load the stealth JavaScript script from file. diff --git a/docs/reference/camel.toolkits.hybrid_browser_toolkit.snapshot.md b/docs/reference/camel.toolkits.hybrid_browser_toolkit.snapshot.md deleted file mode 100644 index cccf26330d..0000000000 --- a/docs/reference/camel.toolkits.hybrid_browser_toolkit.snapshot.md +++ /dev/null @@ -1,46 +0,0 @@ - - - - -## PageSnapshot - -```python -class PageSnapshot: -``` - -Utility for capturing YAML-like page snapshots and diff-only -variants. - - - -### __init__ - -```python -def __init__(self, page: 'Page'): -``` - - - -### _format_snapshot - -```python -def _format_snapshot(text: str): -``` - - - -### _compute_diff - -```python -def _compute_diff(old: str, new: str): -``` - - - -### _detect_priorities - -```python -def _detect_priorities(self, snapshot_yaml: str): -``` - -Return sorted list of priorities present (1,2,3). diff --git a/docs/reference/camel.toolkits.hybrid_browser_toolkit.stealth_config.md b/docs/reference/camel.toolkits.hybrid_browser_toolkit.stealth_config.md deleted file mode 100644 index 23c7809a0e..0000000000 --- a/docs/reference/camel.toolkits.hybrid_browser_toolkit.stealth_config.md +++ /dev/null @@ -1,64 +0,0 @@ - - -Stealth configuration for browser automation to avoid bot detection. - -This module contains all the configuration needed to make the browser -appear as a regular user browser rather than an automated one. - - - -## StealthConfig - -```python -class StealthConfig: -``` - -Configuration class for stealth browser settings. - - - -### get_launch_args - -```python -def get_launch_args(): -``` - -**Returns:** - - List[str]: Chrome command line arguments to avoid detection. - - - -### get_context_options - -```python -def get_context_options(): -``` - -**Returns:** - - Dict[str, Any]: Browser context configuration options. - - - -### get_http_headers - -```python -def get_http_headers(): -``` - -**Returns:** - - Dict[str, str]: HTTP headers to appear more like a real browser. - - - -### get_all_config - -```python -def get_all_config(): -``` - -**Returns:** - - Dict[str, Any]: Complete stealth configuration. diff --git a/docs/reference/camel.toolkits.non_visual_browser_toolkit.nv_browser_session.md b/docs/reference/camel.toolkits.non_visual_browser_toolkit.nv_browser_session.md deleted file mode 100644 index 1120685723..0000000000 --- a/docs/reference/camel.toolkits.non_visual_browser_toolkit.nv_browser_session.md +++ /dev/null @@ -1,34 +0,0 @@ - - - - -## HybridBrowserSession - -```python -class HybridBrowserSession: -``` - -Lightweight wrapper around Playwright for non-visual (headless) -browsing. - -It provides a single *Page* instance plus helper utilities (snapshot & -executor). Multiple toolkits or agents can reuse this class without -duplicating Playwright setup code. - -This class is a singleton per event-loop. - - - -### __new__ - -```python -def __new__(cls): -``` - - - -### __init__ - -```python -def __init__(self): -``` diff --git a/docs/reference/camel.toolkits.openai_image_toolkit.md b/docs/reference/camel.toolkits.openai_image_toolkit.md index 07c373c225..da0ee700d9 100644 --- a/docs/reference/camel.toolkits.openai_image_toolkit.md +++ b/docs/reference/camel.toolkits.openai_image_toolkit.md @@ -1,6 +1,6 @@ - + - + ## OpenAIImageToolkit @@ -11,7 +11,7 @@ class OpenAIImageToolkit(BaseToolkit): A class toolkit for image generation using OpenAI's Image Generation API. - + ### __init__ @@ -44,7 +44,7 @@ Initializes a new instance of the OpenAIImageToolkit class. - **style** (`Optional[Literal["vivid", "natural"]]`): The style of the image.(default: :obj:`None`) - **working_directory** (Optional[str]): The path to save the generated image.(default: :obj:`"image_save"`) - + ### base64_to_image @@ -63,7 +63,7 @@ Converts a base64 encoded string into a PIL Image object. Optional[Image.Image]: The PIL Image object or None if conversion fails. - + ### _build_base_params @@ -81,7 +81,7 @@ Build base parameters dict for OpenAI API calls. dict: Parameters dictionary with non-None values. - + ### _handle_api_response @@ -106,7 +106,7 @@ Handle API response from OpenAI image operations. str: Success message with image path/URL or error message. - + ### generate_image @@ -128,7 +128,7 @@ formats). str: the content of the model response or format of the response. - + ### get_tools