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

chore: Doc enhance (#2615)

Tao Sun8ecd952e2f1c
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
index f67be987d..1b06f3dc0 100644
--- a/.github/workflows/documentation.yml
+++ b/.github/workflows/documentation.yml
@@ -78,8 +78,8 @@ jobs:
env:
PAT_TOKEN: ${{ secrets.PAT_TOKEN }}
run: |
- git config --global user.email "[email protected]"
- git config --global user.name "GitHub Action"
+ git config --global user.name "camel-docs-bot"
+ git config --global user.email "[email protected]"
git add docs/mintlify/ docs/mintlify/get_started/ docs/mintlify/key_modules/ docs/mintlify/reference/ docs/mintlify/docs.json
diff --git a/docs/mintlify/build_api_docs.py b/docs/mintlify/build_api_docs.py
index cfaf4a9c6..f0c6d65a3 100755
--- a/docs/mintlify/build_api_docs.py
+++ b/docs/mintlify/build_api_docs.py
@@ -358,6 +358,7 @@ def parse_docstring(docstring):
'returns': '',
'raises': [],
'examples': [],
+ 'notes': [],
}
lines = docstring.strip().split('\n')
@@ -367,6 +368,7 @@ def parse_docstring(docstring):
'returns': '',
'raises': [],
'examples': [],
+ 'notes': [],
}
current_section = 'description'
@@ -377,7 +379,7 @@ def parse_docstring(docstring):
# Check for section headers
if line.lower().startswith(
- ('args:', 'arguments:', 'parameters:', 'param:')
+ ('args:', 'arguments:', 'parameters:', 'param:', 'attributes:')
):
if current_lines and current_section == 'description':
result['description'] = '\n'.join(current_lines).strip()
@@ -410,6 +412,24 @@ def parse_docstring(docstring):
)
current_section = 'examples'
current_lines = []
+ elif line.lower().startswith(
+ ('note:', 'notes:', 'warning:', 'warnings:')
+ ):
+ if current_lines:
+ if current_section == 'args':
+ result['args'].extend(parse_args_section(current_lines))
+ elif current_section == 'returns':
+ result['returns'] = '\n'.join(current_lines).strip()
+ elif current_section == 'raises':
+ result['raises'].extend(
+ parse_raises_section(current_lines)
+ )
+ elif current_section == 'examples':
+ result['examples'] = current_lines
+ elif current_section == 'description':
+ result['description'] = '\n'.join(current_lines).strip()
+ current_section = 'notes'
+ current_lines = []
else:
current_lines.append(line)
@@ -425,6 +445,8 @@ def parse_docstring(docstring):
result['raises'].extend(parse_raises_section(current_lines))
elif current_section == 'examples':
result['examples'] = current_lines
+ elif current_section == 'notes':
+ result['notes'] = current_lines
return result
@@ -867,6 +889,14 @@ def generate_class_docs(class_node, module_name):
)
lines.append("")
+ if doc_info.get('notes'):
+ lines.append('**Note:**')
+ lines.append("")
+ lines.extend(
+ [escape_mdx_content(line) for line in doc_info['notes']]
+ )
+ lines.append("")
+
# Process methods
for node in class_node.body:
if isinstance(node, ast.FunctionDef):
@@ -944,6 +974,14 @@ def generate_function_docs(func_node, module_name):
)
lines.append("")
+ if doc_info.get('notes'):
+ lines.append('**Note:**')
+ lines.append("")
+ lines.extend(
+ [escape_mdx_content(line) for line in doc_info['notes']]
+ )
+ lines.append("")
+
return lines
@@ -1008,6 +1046,14 @@ def generate_method_docs(method_node, class_name, module_name):
lines.append(f" {escaped_returns}")
lines.append("")
+ if doc_info.get('notes'):
+ lines.append('**Note:**')
+ lines.append("")
+ lines.extend(
+ [escape_mdx_content(line) for line in doc_info['notes']]
+ )
+ lines.append("")
+
return lines
diff --git a/docs/mintlify/reference/camel.agents.chat_agent.mdx b/docs/mintlify/reference/camel.agents.chat_agent.mdx
index 3260062d0..78485c61e 100644
--- a/docs/mintlify/reference/camel.agents.chat_agent.mdx
+++ b/docs/mintlify/reference/camel.agents.chat_agent.mdx
@@ -553,7 +553,8 @@ calls and termination reasons.
step, including termination status, reasons, and tool call
information.
-Note:
+**Note:**
+
This method iterates over all response terminators and checks if
any of them signal termination. If a terminator signals
termination, the agent's state is updated accordingly, and the
diff --git a/docs/mintlify/reference/camel.agents.knowledge_graph_agent.mdx b/docs/mintlify/reference/camel.agents.knowledge_graph_agent.mdx
index dcdc3e455..300dce498 100644
--- a/docs/mintlify/reference/camel.agents.knowledge_graph_agent.mdx
+++ b/docs/mintlify/reference/camel.agents.knowledge_graph_agent.mdx
@@ -11,9 +11,9 @@ class KnowledgeGraphAgent(ChatAgent):
An agent that can extract node and relationship information for
different entities from given `Element` content.
-Attributes:
-task_prompt (TextPrompt): A prompt for the agent to extract node and
-relationship information for different entities.
+**Parameters:**
+
+- **task_prompt** (TextPrompt): A prompt for the agent to extract node and relationship information for different entities.
<a id="camel.agents.knowledge_graph_agent.KnowledgeGraphAgent.__init__"></a>
diff --git a/docs/mintlify/reference/camel.agents.mcp_agent.mdx b/docs/mintlify/reference/camel.agents.mcp_agent.mdx
index fd0b1180d..b27c542f9 100644
--- a/docs/mintlify/reference/camel.agents.mcp_agent.mdx
+++ b/docs/mintlify/reference/camel.agents.mcp_agent.mdx
@@ -12,23 +12,14 @@ A specialized agent designed to interact with MCP registries.
The MCPAgent enhances a base ChatAgent by integrating MCP tools from
various registries for search capabilities.
-Attributes:
-system_message (Optional[str]): The system message for the chat agent.
-(default: :str:`"You are an assistant with search capabilities
-using MCP tools."`)
-model (BaseModelBackend): The model backend to use for generating
-responses. (default: :obj:`ModelPlatformType.DEFAULT` with
-`ModelType.DEFAULT`)
-registry_configs (List[BaseMCPRegistryConfig]): List of registry
-configurations (default: :obj:`None`)
-local_config (Optional[Dict[str, Any]]): The local configuration for
-the MCP agent. (default: :obj:`None`)
-local_config_path (Optional[str]): The path to the local configuration
-file for the MCP agent. (default: :obj:`None`)
-function_calling_available (bool): Flag indicating whether the
-model is equipped with the function calling ability.
-(default: :obj:`True`)
-**kwargs: Inherited from ChatAgent
+**Parameters:**
+
+- **system_message** (Optional[str]): The system message for the chat agent. (default: :str:`"You are an assistant with search capabilities using MCP tools."`)
+- **model** (BaseModelBackend): The model backend to use for generating responses. (default: :obj:`ModelPlatformType.DEFAULT` with `ModelType.DEFAULT`)
+- **registry_configs** (List[BaseMCPRegistryConfig]): List of registry configurations (default: :obj:`None`)
+- **local_config** (Optional[Dict[str, Any]]): The local configuration for the MCP agent. (default: :obj:`None`)
+- **local_config_path** (Optional[str]): The path to the local configuration file for the MCP agent. (default: :obj:`None`)
+- **function_calling_available** (bool): Flag indicating whether the model is equipped with the function calling ability. (default: :obj:`True`) **kwargs: Inherited from ChatAgent
<a id="camel.agents.mcp_agent.MCPAgent.__init__"></a>
diff --git a/docs/mintlify/reference/camel.agents.programmed_agent_instruction.mdx b/docs/mintlify/reference/camel.agents.programmed_agent_instruction.mdx
index 44d76af43..f3be83ad4 100644
--- a/docs/mintlify/reference/camel.agents.programmed_agent_instruction.mdx
+++ b/docs/mintlify/reference/camel.agents.programmed_agent_instruction.mdx
@@ -13,9 +13,9 @@ Requirements for programmable agent state.
Defines the possible requirements that can be used to repair the state
of a programmable agent.
-Attributes:
-LAST_MESSAGE_NOT_USER (str): Requires that the last message in the
-conversation was not from the user.
+**Parameters:**
+
+- **LAST_MESSAGE_NOT_USER** (str): Requires that the last message in the conversation was not from the user.
<a id="camel.agents.programmed_agent_instruction.ProgrammedAgentInstructionResult"></a>
@@ -30,10 +30,11 @@ Result of a programmable agent instruction execution.
Contains the messages exchanged during execution and the computed value.
The value type is specified by the generic type parameter T.
-Attributes:
-user_message (BaseMessage): The message sent by the user.
-agent_message (BaseMessage): The message sent by the agent.
-value (T): The computed result value of type T.
+**Parameters:**
+
+- **user_message** (BaseMessage): The message sent by the user.
+- **agent_message** (BaseMessage): The message sent by the agent.
+- **value** (T): The computed result value of type T.
<a id="camel.agents.programmed_agent_instruction.AbstractProgrammableAgent"></a>
@@ -135,10 +136,10 @@ Provides a default implementation of atomic execution using threading locks
and basic state tracking for message roles. Implementing classes need to
provide specific repair logic for their use cases.
-Attributes:
-_operation_lock (threading.Lock): Lock for ensuring atomic operations.
-_last_message_role (Optional[str]): Role of the last message in the
-conversation.
+**Parameters:**
+
+- **_operation_lock** (threading.Lock): Lock for ensuring atomic operations.
+- **_last_message_role** (Optional[str]): Role of the last message in the conversation.
<a id="camel.agents.programmed_agent_instruction.ProgrammableChatAgent.__init__"></a>
diff --git a/docs/mintlify/reference/camel.agents.repo_agent.mdx b/docs/mintlify/reference/camel.agents.repo_agent.mdx
index bd531a4b8..7a232185d 100644
--- a/docs/mintlify/reference/camel.agents.repo_agent.mdx
+++ b/docs/mintlify/reference/camel.agents.repo_agent.mdx
@@ -10,10 +10,11 @@ class GitHubFile(BaseModel):
Model to hold GitHub file information.
-Attributes:
-content (str): The content of the GitHub text.
-file_path (str): The path of the file.
-html_url (str): The actual url of the file.
+**Parameters:**
+
+- **content** (str): The content of the GitHub text.
+- **file_path** (str): The path of the file.
+- **html_url** (str): The actual url of the file.
<a id="camel.agents.repo_agent.RepositoryInfo"></a>
@@ -25,10 +26,11 @@ class RepositoryInfo(BaseModel):
Model to hold GitHub repository information.
-Attributes:
-repo_name (str): The full name of the repository.
-repo_url (str): The URL of the repository.
-contents (list): A list to hold the repository contents.
+**Parameters:**
+
+- **repo_name** (str): The full name of the repository.
+- **repo_url** (str): The URL of the repository.
+- **contents** (list): A list to hold the repository contents.
<a id="camel.agents.repo_agent.RepoAgent"></a>
@@ -48,35 +50,21 @@ prompt.
code/documentation chunks using a vector store when context
length exceeds a specified token limit.
-Attributes:
-vector_retriever (VectorRetriever): Retriever used to
-perform semantic search in RAG mode. Required if repo content
-exceeds context limit.
-system_message (Optional[str]): The system message
-for the chat agent. (default: :str:`"You are a code assistant
-with repo context."`)
-repo_paths (Optional[List[str]]): List of GitHub repository URLs to
-load during initialization. (default: :obj:`None`)
-model (BaseModelBackend): The model backend to use for generating
-responses. (default: :obj:`ModelPlatformType.DEFAULT`
-with `ModelType.DEFAULT`)
-max_context_tokens (Optional[int]): Maximum number of tokens allowed
-before switching to RAG mode. (default: :obj:`2000`)
-github_auth_token (Optional[str]): GitHub personal access token
-for accessing private or rate-limited repositories. (default:
-:obj:`None`)
-chunk_size (Optional[int]): Maximum number of characters per code chunk
-when indexing files for RAG. (default: :obj:`8192`)
-top_k (int): Number of top-matching chunks to retrieve from the vector
-store in RAG mode. (default: :obj:`5`)
-similarity (Optional[float]): Minimum similarity score required to
-include a chunk in the RAG context. (default: :obj:`0.6`)
-collection_name (Optional[str]): Name of the vector database
-collection to use for storing and retrieving chunks. (default:
-:obj:`None`)
-**kwargs: Inherited from ChatAgent
-
-Note:
+**Parameters:**
+
+- **vector_retriever** (VectorRetriever): Retriever used to perform semantic search in RAG mode. Required if repo content exceeds context limit.
+- **system_message** (Optional[str]): The system message for the chat agent. (default: :str:`"You are a code assistant with repo context."`)
+- **repo_paths** (Optional[List[str]]): List of GitHub repository URLs to load during initialization. (default: :obj:`None`)
+- **model** (BaseModelBackend): The model backend to use for generating responses. (default: :obj:`ModelPlatformType.DEFAULT` with `ModelType.DEFAULT`)
+- **max_context_tokens** (Optional[int]): Maximum number of tokens allowed before switching to RAG mode. (default: :obj:`2000`)
+- **github_auth_token** (Optional[str]): GitHub personal access token for accessing private or rate-limited repositories. (default: :obj:`None`)
+- **chunk_size** (Optional[int]): Maximum number of characters per code chunk when indexing files for RAG. (default: :obj:`8192`)
+- **top_k** (int): Number of top-matching chunks to retrieve from the vector store in RAG mode. (default: :obj:`5`)
+- **similarity** (Optional[float]): Minimum similarity score required to include a chunk in the RAG context. (default: :obj:`0.6`)
+- **collection_name** (Optional[str]): Name of the vector database collection to use for storing and retrieving chunks. (default: :obj:`None`) **kwargs: Inherited from ChatAgent
+
+**Note:**
+
The current implementation of RAG mode requires using Qdrant as the
vector storage backend. The VectorRetriever defaults to QdrantStorage
if no storage is explicitly provided. Other vector storage backends
diff --git a/docs/mintlify/reference/camel.agents.role_assignment_agent.mdx b/docs/mintlify/reference/camel.agents.role_assignment_agent.mdx
index d0dd4b673..0a1ec78a1 100644
--- a/docs/mintlify/reference/camel.agents.role_assignment_agent.mdx
+++ b/docs/mintlify/reference/camel.agents.role_assignment_agent.mdx
@@ -12,8 +12,6 @@ An agent that generates role names based on the task prompt.
**Parameters:**
-- **model** (BaseModelBackend, optional): The model backend to use for generating responses. (default: :obj:`OpenAIModel` with `GPT_4O_MINI`)
-- **Attributes**:
- **role_assignment_prompt** (TextPrompt): A prompt for the agent to generate role names.
<a id="camel.agents.role_assignment_agent.RoleAssignmentAgent.__init__"></a>
diff --git a/docs/mintlify/reference/camel.agents.task_agent.mdx b/docs/mintlify/reference/camel.agents.task_agent.mdx
index dc7c139cb..23d752091 100644
--- a/docs/mintlify/reference/camel.agents.task_agent.mdx
+++ b/docs/mintlify/reference/camel.agents.task_agent.mdx
@@ -11,10 +11,6 @@ class TaskSpecifyAgent(ChatAgent):
An agent that specifies a given task prompt by prompting the user to
provide more details.
-Attributes:
-DEFAULT_WORD_LIMIT (int): The default word limit for the task prompt.
-task_specify_prompt (TextPrompt): The prompt for specifying the task.
-
**Parameters:**
- **model** (BaseModelBackend, optional): The model backend to use for generating responses. (default: :obj:`OpenAIModel` with `GPT_4O_MINI`)
@@ -72,10 +68,6 @@ class TaskPlannerAgent(ChatAgent):
An agent that helps divide a task into subtasks based on the input
task prompt.
-Attributes:
-task_planner_prompt (TextPrompt): A prompt for the agent to divide
-the task into subtasks.
-
**Parameters:**
- **model** (BaseModelBackend, optional): The model backend to use for generating responses. (default: :obj:`OpenAIModel` with `GPT_4O_MINI`)
@@ -125,10 +117,6 @@ it's still a task planner, but it has more context information
like last task and incomplete task list. Modified from
`BabyAGI <https://github.com/yoheinakajima/babyagi>`_.
-Attributes:
-task_creation_prompt (TextPrompt): A prompt for the agent to
-create new tasks.
-
**Parameters:**
- **role_name** (str): The role name of the Agent to create the task.
@@ -185,10 +173,6 @@ An agent that helps re-prioritize the task list and
returns numbered prioritized list. Modified from
`BabyAGI <https://github.com/yoheinakajima/babyagi>`_.
-Attributes:
-task_prioritization_prompt (TextPrompt): A prompt for the agent to
-prioritize tasks.
-
**Parameters:**
- **objective** (Union[str, TextPrompt]): The objective of the Agent to perform the task.
diff --git a/docs/mintlify/reference/camel.benchmarks.base.mdx b/docs/mintlify/reference/camel.benchmarks.base.mdx
index b6c2308e7..d0e589dea 100644
--- a/docs/mintlify/reference/camel.benchmarks.base.mdx
+++ b/docs/mintlify/reference/camel.benchmarks.base.mdx
@@ -10,12 +10,12 @@ class BaseBenchmark(ABC):
Base class for benchmarks.
-Attributes:
-name (str): Name of the benchmark.
-data_dir (str): Path to the data directory.
-save_to (str): Path to save the results.
-processes (int): Number of processes to use for parallel
-processing. :(default: :obj:`1`)
+**Parameters:**
+
+- **name** (str): Name of the benchmark.
+- **data_dir** (str): Path to the data directory.
+- **save_to** (str): Path to save the results.
+- **processes** (int): Number of processes to use for parallel processing. :(default: :obj:`1`)
<a id="camel.benchmarks.base.BaseBenchmark.__init__"></a>
diff --git a/docs/mintlify/reference/camel.bots.discord.discord_app.mdx b/docs/mintlify/reference/camel.bots.discord.discord_app.mdx
index a18cd218d..dd8085a7a 100644
--- a/docs/mintlify/reference/camel.bots.discord.discord_app.mdx
+++ b/docs/mintlify/reference/camel.bots.discord.discord_app.mdx
@@ -14,10 +14,10 @@ to interact with Discord servers.
This bot can respond to messages in specific channels and only reacts to
messages that mention the bot.
-Attributes:
-channel_ids (Optional[List[int]]): A list of allowed channel IDs. If
-provided, the bot will only respond to messages in these channels.
-token (Optional[str]): The Discord bot token used for authentication.
+**Parameters:**
+
+- **channel_ids** (Optional[List[int]]): A list of allowed channel IDs. If provided, the bot will only respond to messages in these channels.
+- **token** (Optional[str]): The Discord bot token used for authentication.
<a id="camel.bots.discord.discord_app.DiscordApp.__init__"></a>
diff --git a/docs/mintlify/reference/camel.bots.discord.discord_installation.mdx b/docs/mintlify/reference/camel.bots.discord.discord_installation.mdx
index 254cb36cb..e3128e696 100644
--- a/docs/mintlify/reference/camel.bots.discord.discord_installation.mdx
+++ b/docs/mintlify/reference/camel.bots.discord.discord_installation.mdx
@@ -11,18 +11,13 @@ class DiscordInstallation:
Represents an installation of a Discord application in a
specific guild (server).
-Attributes:
-guild_id (str): The unique identifier for the Discord guild (server)
-where the application is installed.
-access_token (str): The access token used to authenticate API requests
-for the installed application.
-refresh_token (str): The token used to refresh the access token when
-it expires.
-installed_at (datetime): The timestamp indicating when the application
-was installed in the guild.
-token_expires_at (Optional[datetime]): The optional timestamp
-indicating when the access token will expire. Defaults to None
-if the token does not have an expiration time.
+**Parameters:**
+
+- **guild_id** (str): The unique identifier for the Discord guild (server) where the application is installed.
+- **access_token** (str): The access token used to authenticate API requests for the installed application.
+- **refresh_token** (str): The token used to refresh the access token when it expires.
+- **installed_at** (datetime): The timestamp indicating when the application was installed in the guild.
+- **token_expires_at** (Optional[datetime]): The optional timestamp indicating when the access token will expire. Defaults to None if the token does not have an expiration time.
<a id="camel.bots.discord.discord_installation.DiscordInstallation.__init__"></a>
diff --git a/docs/mintlify/reference/camel.bots.discord.discord_store.mdx b/docs/mintlify/reference/camel.bots.discord.discord_store.mdx
index 8f9379814..12bfd4236 100644
--- a/docs/mintlify/reference/camel.bots.discord.discord_store.mdx
+++ b/docs/mintlify/reference/camel.bots.discord.discord_store.mdx
@@ -27,8 +27,9 @@ SQLite-based implementation for managing Discord installations.
This class provides methods for initializing the database, saving,
retrieving, and deleting installation records using SQLite.
-Attributes:
-database (str): Path to the SQLite database file.
+**Parameters:**
+
+- **database** (str): Path to the SQLite database file.
<a id="camel.bots.discord.discord_store.DiscordSQLiteInstallationStore.__init__"></a>
diff --git a/docs/mintlify/reference/camel.bots.telegram_bot.mdx b/docs/mintlify/reference/camel.bots.telegram_bot.mdx
index 609657ce8..4674b3890 100644
--- a/docs/mintlify/reference/camel.bots.telegram_bot.mdx
+++ b/docs/mintlify/reference/camel.bots.telegram_bot.mdx
@@ -10,9 +10,10 @@ class TelegramBot:
Represents a Telegram bot that is powered by an agent.
-Attributes:
-chat_agent (ChatAgent): Chat agent that will power the bot.
-telegram_token (str, optional): The bot token.
+**Parameters:**
+
+- **chat_agent** (ChatAgent): Chat agent that will power the bot.
+- **telegram_token** (str, optional): The bot token.
<a id="camel.bots.telegram_bot.TelegramBot.__init__"></a>
diff --git a/docs/mintlify/reference/camel.datagen.source2synth.data_processor.mdx b/docs/mintlify/reference/camel.datagen.source2synth.data_processor.mdx
index dd161ad4e..38e7a8779 100644
--- a/docs/mintlify/reference/camel.datagen.source2synth.data_processor.mdx
+++ b/docs/mintlify/reference/camel.datagen.source2synth.data_processor.mdx
@@ -15,11 +15,11 @@ This class handles the processing of text data to generate multi-hop
question-answer pairs using either an AI model or rule-based approaches.
It manages the entire pipeline from text preprocessing to dataset curation.
-Attributes:
-config (ProcessorConfig): Configuration for data processing parameters.
-rng (random.Random): Random number generator for reproducibility.
-multi_hop_agent (Optional[MultiHopGeneratorAgent]): Agent for
-generating QA pairs.
+**Parameters:**
+
+- **config** (ProcessorConfig): Configuration for data processing parameters.
+- **rng** (random.Random): Random number generator for reproducibility.
+- **multi_hop_agent** (Optional[MultiHopGeneratorAgent]): Agent for generating QA pairs.
<a id="camel.datagen.source2synth.data_processor.UserDataProcessor.__init__"></a>
@@ -88,10 +88,10 @@ Constructs training examples from raw text data.
This class handles the construction of training examples by preprocessing
text, extracting information pairs, and generating question-answer pairs.
-Attributes:
-config (ProcessorConfig): Configuration for example construction.
-multi_hop_agent (Optional[MultiHopGeneratorAgent]): Agent for QA
-generation.
+**Parameters:**
+
+- **config** (ProcessorConfig): Configuration for example construction.
+- **multi_hop_agent** (Optional[MultiHopGeneratorAgent]): Agent for QA generation.
<a id="camel.datagen.source2synth.data_processor.ExampleConstructor.__init__"></a>
@@ -236,9 +236,10 @@ Manages and curates datasets of multi-hop question-answer pairs.
This class handles dataset management tasks including quality filtering,
complexity filtering, deduplication, and dataset sampling.
-Attributes:
-config (ProcessorConfig): Configuration for data curation parameters.
-rng (random.Random): Random number generator for reproducible sampling.
+**Parameters:**
+
+- **config** (ProcessorConfig): Configuration for data curation parameters.
+- **rng** (random.Random): Random number generator for reproducible sampling.
<a id="camel.datagen.source2synth.data_processor.DataCurator.__init__"></a>
diff --git a/docs/mintlify/reference/camel.datagen.source2synth.models.mdx b/docs/mintlify/reference/camel.datagen.source2synth.models.mdx
index e22f7a580..1a99a4fe8 100644
--- a/docs/mintlify/reference/camel.datagen.source2synth.models.mdx
+++ b/docs/mintlify/reference/camel.datagen.source2synth.models.mdx
@@ -10,8 +10,9 @@ class ReasoningStep(BaseModel):
A single step in a multi-hop reasoning process.
-Attributes:
-step (str): The textual description of the reasoning step.
+**Parameters:**
+
+- **step** (str): The textual description of the reasoning step.
<a id="camel.datagen.source2synth.models.MultiHopQA"></a>
@@ -24,13 +25,13 @@ class MultiHopQA(BaseModel):
A multi-hop question-answer pair with reasoning steps and supporting
facts.
-Attributes:
-question (str): The question requiring multi-hop reasoning.
-reasoning_steps (List[ReasoningStep]): List of reasoning steps to
-answer.
-answer (str): The final answer to the question.
-supporting_facts (List[str]): List of facts supporting the reasoning.
-type (str): The type of question-answer pair.
+**Parameters:**
+
+- **question** (str): The question requiring multi-hop reasoning.
+- **reasoning_steps** (List[ReasoningStep]): List of reasoning steps to answer.
+- **answer** (str): The final answer to the question.
+- **supporting_facts** (List[str]): List of facts supporting the reasoning.
+- **type** (str): The type of question-answer pair.
<a id="camel.datagen.source2synth.models.ContextPrompt"></a>
@@ -42,6 +43,7 @@ class ContextPrompt(BaseModel):
A context prompt for generating multi-hop question-answer pairs.
-Attributes:
-main_context (str): The primary context for generating QA pairs.
-related_contexts (Optional[List[str]]): Additional related contexts.
+**Parameters:**
+
+- **main_context** (str): The primary context for generating QA pairs.
+- **related_contexts** (Optional[List[str]]): Additional related contexts.
diff --git a/docs/mintlify/reference/camel.datasets.base_generator.mdx b/docs/mintlify/reference/camel.datasets.base_generator.mdx
index 4d827f76d..2a43172d2 100644
--- a/docs/mintlify/reference/camel.datasets.base_generator.mdx
+++ b/docs/mintlify/reference/camel.datasets.base_generator.mdx
@@ -85,7 +85,8 @@ def sample(self):
DataPoint: The next DataPoint.
-Note:
+**Note:**
+
This method is intended for synchronous contexts.
Use 'async_sample' in asynchronous contexts to
avoid blocking or runtime errors.
@@ -106,6 +107,12 @@ Each datapoint is stored as a separate JSON object on a new line.
- **file_path** (Union[str, Path]): Path to save the JSONL file.
+**Note:**
+
+- Uses `self._data`, which contains the generated datapoints.
+- Appends to the file if it already exists.
+- Ensures compatibility with large datasets by using JSONL format.
+
<a id="camel.datasets.base_generator.BaseGenerator.flush"></a>
### flush
@@ -119,7 +126,10 @@ Flush the current data to a JSONL file and clear the data.
**Parameters:**
- **file_path** (Union[str, Path]): Path to save the JSONL file.
-- **Notes**: - Uses `save_to_jsonl` to save `self._data`.
+
+**Note:**
+
+- Uses `save_to_jsonl` to save `self._data`.
<a id="camel.datasets.base_generator.BaseGenerator._init_from_jsonl"></a>
diff --git a/docs/mintlify/reference/camel.datasets.models.mdx b/docs/mintlify/reference/camel.datasets.models.mdx
index bd847ee1d..9eff15c84 100644
--- a/docs/mintlify/reference/camel.datasets.models.mdx
+++ b/docs/mintlify/reference/camel.datasets.models.mdx
@@ -10,13 +10,12 @@ class DataPoint(BaseModel):
A single data point in the dataset.
-Attributes:
-question (str): The primary question or issue to be addressed.
-final_answer (str): The final answer.
-rationale (Optional[str]): Logical reasoning or explanation behind the
-answer. (default: :obj:`None`)
-metadata (Optional[Dict[str, Any]]): Additional metadata about the data
-point. (default: :obj:`None`)
+**Parameters:**
+
+- **question** (str): The primary question or issue to be addressed.
+- **final_answer** (str): The final answer.
+- **rationale** (Optional[str]): Logical reasoning or explanation behind the answer. (default: :obj:`None`)
+- **metadata** (Optional[Dict[str, Any]]): Additional metadata about the data point. (default: :obj:`None`)
<a id="camel.datasets.models.DataPoint.to_dict"></a>
diff --git a/docs/mintlify/reference/camel.datasets.self_instruct_generator.mdx b/docs/mintlify/reference/camel.datasets.self_instruct_generator.mdx
index 68ae01a03..012b25182 100644
--- a/docs/mintlify/reference/camel.datasets.self_instruct_generator.mdx
+++ b/docs/mintlify/reference/camel.datasets.self_instruct_generator.mdx
@@ -144,8 +144,9 @@ class QuestionSchema(BaseModel):
Schema for the generated question.
-Attributes:
-question (str): The question generated by the model.
+**Parameters:**
+
+- **question** (str): The question generated by the model.
<a id="camel.datasets.self_instruct_generator.RationaleSchema"></a>
@@ -157,5 +158,6 @@ class RationaleSchema(BaseModel):
Schema for the generated rationale code.
-Attributes:
-code (str): The generated code without any formatting.
+**Parameters:**
+
+- **code** (str): The generated code without any formatting.
diff --git a/docs/mintlify/reference/camel.environments.models.mdx b/docs/mintlify/reference/camel.environments.models.mdx
index 583382c36..0cad4c549 100644
--- a/docs/mintlify/reference/camel.environments.models.mdx
+++ b/docs/mintlify/reference/camel.environments.models.mdx
@@ -14,12 +14,11 @@ This class defines the input context, the LLM-generated output, and
metadata required for verification and tracking within an RL
framework.
-Attributes:
-llm_response (str): The response generated by the LLM.
-metadata (Dict[str, Any]): Additional metadata such as model
-parameters, prompt details, or response confidence scores.
-timestamp (datetime): The timestamp when the action was
-generated (UTC).
+**Parameters:**
+
+- **llm_response** (str): The response generated by the LLM.
+- **metadata** (Dict[str, Any]): Additional metadata such as model parameters, prompt details, or response confidence scores.
+- **timestamp** (datetime): The timestamp when the action was generated (UTC).
<a id="camel.environments.models.Observation"></a>
@@ -31,10 +30,11 @@ class Observation(BaseModel):
Environment observation.
-Attributes:
-question: The question posed to the LLM.
-context: Additional context for the question.
-metadata: Optional metadata about the observation.
+**Parameters:**
+
+- **question**: The question posed to the LLM.
+- **context**: Additional context for the question.
+- **metadata**: Optional metadata about the observation.
<a id="camel.environments.models.StepResult"></a>
@@ -46,11 +46,12 @@ class StepResult(BaseModel):
Result of an environment step.
-Attributes:
-observation: The next observation.
-reward: Dictionary of reward scores for different aspects.
-done: Whether the episode is complete.
-info: Additional information about the step.
+**Parameters:**
+
+- **observation**: The next observation.
+- **reward**: Dictionary of reward scores for different aspects.
+- **done**: Whether the episode is complete.
+- **info**: Additional information about the step.
<a id="camel.environments.models.StepResult.as_tuple"></a>
diff --git a/docs/mintlify/reference/camel.environments.single_step.mdx b/docs/mintlify/reference/camel.environments.single_step.mdx
index 91cd8305f..2304c29f3 100644
--- a/docs/mintlify/reference/camel.environments.single_step.mdx
+++ b/docs/mintlify/reference/camel.environments.single_step.mdx
@@ -47,7 +47,11 @@ Initialize the SingleStepEnv.
- **dataset** (Union[StaticDataset, BaseGenerator]): Dataset to sample problems from.
- **verifier** (BaseVerifier): Verifier used to evaluate LLM responses against ground-truth answers.
- **timeout** (Optional[float], optional): The execution timeout in seconds. (default: :obj:`180.0`) **kwargs: Optional metadata or configuration values.
-- **Notes**: This class assumes all interactions are single-step: one question, one LLM response, one reward.
+
+**Note:**
+
+This class assumes all interactions are single-step: one question,
+one LLM response, one reward.
<a id="camel.environments.single_step.SingleStepEnv._normalize_actions"></a>
diff --git a/docs/mintlify/reference/camel.human.mdx b/docs/mintlify/reference/camel.human.mdx
index 4a0c5aa45..ef72e9168 100644
--- a/docs/mintlify/reference/camel.human.mdx
+++ b/docs/mintlify/reference/camel.human.mdx
@@ -12,9 +12,6 @@ A class representing a human user.
**Parameters:**
-- **name** (str): The name of the human user. (default: :obj:`"Kill Switch Engineer"`).
-- **logger_color** (Any): The color of the menu options displayed to the user. (default: :obj:`Fore.MAGENTA`)
-- **Attributes**:
- **name** (str): The name of the human user.
- **logger_color** (Any): The color of the menu options displayed to the user.
- **input_button** (str): The text displayed for the input button.
diff --git a/docs/mintlify/reference/camel.loaders.mineru_extractor.mdx b/docs/mintlify/reference/camel.loaders.mineru_extractor.mdx
index 6864e5aef..435017f52 100644
--- a/docs/mintlify/reference/camel.loaders.mineru_extractor.mdx
+++ b/docs/mintlify/reference/camel.loaders.mineru_extractor.mdx
@@ -15,7 +15,13 @@ and tables.
- **api_key** (str, optional): Authentication key for MinerU API service. If not provided, will use MINERU_API_KEY environment variable. (default: :obj:`None`)
- **api_url** (str, optional): Base URL endpoint for the MinerU API service. (default: :obj:`"https://mineru.net/api/v4"`)
-- **Note**: - Single file size limit: 200MB - Page limit per file: 600 pages - Daily high-priority parsing quota: 2000 pages - Some URLs (GitHub, AWS) may timeout due to network restrictions
+
+**Note:**
+
+- Single file size limit: 200MB
+- Page limit per file: 600 pages
+- Daily high-priority parsing quota: 2000 pages
+- Some URLs (GitHub, AWS) may timeout due to network restrictions
<a id="camel.loaders.mineru_extractor.MinerU.__init__"></a>
diff --git a/docs/mintlify/reference/camel.loaders.unstructured_io.mdx b/docs/mintlify/reference/camel.loaders.unstructured_io.mdx
index a68f58325..4a45ae9ab 100644
--- a/docs/mintlify/reference/camel.loaders.unstructured_io.mdx
+++ b/docs/mintlify/reference/camel.loaders.unstructured_io.mdx
@@ -71,6 +71,15 @@ Loads a file or a URL and parses its contents into elements.
Union[List[Element],None]: List of elements after parsing the file
or URL if success.
+**Note:**
+
+Supported file types:
+"csv", "doc", "docx", "epub", "image", "md", "msg", "odt",
+"org", "pdf", "ppt", "pptx", "rtf", "rst", "tsv", "xlsx".
+
+References:
+https://unstructured-io.github.io/unstructured/
+
<a id="camel.loaders.unstructured_io.UnstructuredIO.parse_bytes"></a>
### parse_bytes
@@ -90,7 +99,8 @@ Parses a bytes stream and converts its contents into elements.
Union[List[Element], None]: List of elements after parsing the file
if successful, otherwise `None`.
-Notes:
+**Note:**
+
Supported file types:
"csv", "doc", "docx", "epub", "image", "md", "msg", "odt",
"org", "pdf", "ppt", "pptx", "rtf", "rst", "tsv", "xlsx".
@@ -131,6 +141,16 @@ operations is applied. These defaults including operations
str: The cleaned text.
+**Note:**
+
+The 'options' dictionary keys must correspond to valid cleaning
+brick names from the `unstructured` library.
+Each brick's parameters must be provided in a nested dictionary
+as the value for the key.
+
+References:
+https://unstructured-io.github.io/unstructured/
+
<a id="camel.loaders.unstructured_io.UnstructuredIO.extract_data_from_text"></a>
### extract_data_from_text
diff --git a/docs/mintlify/reference/camel.memories.base.mdx b/docs/mintlify/reference/camel.memories.base.mdx
index 987f2ecf0..2565437f3 100644
--- a/docs/mintlify/reference/camel.memories.base.mdx
+++ b/docs/mintlify/reference/camel.memories.base.mdx
@@ -72,11 +72,10 @@ Subclasses should implement the :obj:`token_counter`,:obj: `token_limit`,
and :obj:`create_context` methods to provide specific context creation
logic.
-Attributes:
-token_counter (BaseTokenCounter): A token counter instance responsible
-for counting tokens in a message.
-token_limit (int): The maximum number of tokens allowed in the
-generated context.
+**Parameters:**
+
+- **token_counter** (BaseTokenCounter): A token counter instance responsible for counting tokens in a message.
+- **token_limit** (int): The maximum number of tokens allowed in the generated context.
<a id="camel.memories.base.BaseContextCreator.token_counter"></a>
diff --git a/docs/mintlify/reference/camel.memories.records.mdx b/docs/mintlify/reference/camel.memories.records.mdx
index 657581c0d..5d50186ab 100644
--- a/docs/mintlify/reference/camel.memories.records.mdx
+++ b/docs/mintlify/reference/camel.memories.records.mdx
@@ -10,21 +10,14 @@ class MemoryRecord(BaseModel):
The basic message storing unit in the CAMEL memory system.
-Attributes:
-message (BaseMessage): The main content of the record.
-role_at_backend (OpenAIBackendRole): An enumeration value representing
-the role this message played at the OpenAI backend. Note that this
-value is different from the :obj:`RoleType` used in the CAMEL role
-playing system.
-uuid (UUID, optional): A universally unique identifier for this record.
-This is used to uniquely identify this record in the memory system.
-If not given, it will be assigned with a random UUID.
-extra_info (Dict[str, str], optional): A dictionary of additional
-key-value pairs that provide more information. If not given, it
-will be an empty `Dict`.
-timestamp (float, optional): The timestamp when the record was created.
-agent_id (str): The identifier of the agent associated with this
-memory.
+**Parameters:**
+
+- **message** (BaseMessage): The main content of the record.
+- **role_at_backend** (OpenAIBackendRole): An enumeration value representing the role this message played at the OpenAI backend. Note that this value is different from the :obj:`RoleType` used in the CAMEL role playing system.
+- **uuid** (UUID, optional): A universally unique identifier for this record. This is used to uniquely identify this record in the memory system. If not given, it will be assigned with a random UUID.
+- **extra_info** (Dict[str, str], optional): A dictionary of additional key-value pairs that provide more information. If not given, it will be an empty `Dict`.
+- **timestamp** (float, optional): The timestamp when the record was created.
+- **agent_id** (str): The identifier of the agent associated with this memory.
<a id="camel.memories.records.MemoryRecord.from_dict"></a>
diff --git a/docs/mintlify/reference/camel.models.nemotron_model.mdx b/docs/mintlify/reference/camel.models.nemotron_model.mdx
index 354780f47..c16b5069d 100644
--- a/docs/mintlify/reference/camel.models.nemotron_model.mdx
+++ b/docs/mintlify/reference/camel.models.nemotron_model.mdx
@@ -16,7 +16,10 @@ Nemotron model API backend with OpenAI compatibility.
- **api_key** (Optional[str], optional): The API key for authenticating with the Nvidia service. (default: :obj:`None`)
- **url** (Optional[str], optional): The url to the Nvidia service. (default: :obj:`https://integrate.api.nvidia.com/v1`)
- **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`)
-- **Notes**: Nemotron model doesn't support additional model config like OpenAI.
+
+**Note:**
+
+Nemotron model doesn't support additional model config like OpenAI.
<a id="camel.models.nemotron_model.NemotronModel.__init__"></a>
diff --git a/docs/mintlify/reference/camel.models.reward.nemotron_model.mdx b/docs/mintlify/reference/camel.models.reward.nemotron_model.mdx
index 18c184a5b..51f136179 100644
--- a/docs/mintlify/reference/camel.models.reward.nemotron_model.mdx
+++ b/docs/mintlify/reference/camel.models.reward.nemotron_model.mdx
@@ -15,7 +15,10 @@ Reward model based on the Nemotron model with OpenAI compatibility.
- **model_type** (Union[ModelType, str]): Model for which a backend is created.
- **api_key** (Optional[str], optional): The API key for authenticating with the model service. (default: :obj:`None`)
- **url** (Optional[str], optional): The url to the model service.
-- **Note**: The Nemotron model does not support model config.
+
+**Note:**
+
+The Nemotron model does not support model config.
<a id="camel.models.reward.nemotron_model.NemotronRewardModel.__init__"></a>
diff --git a/docs/mintlify/reference/camel.personas.persona.mdx b/docs/mintlify/reference/camel.personas.persona.mdx
index 90608e900..d675fead5 100644
--- a/docs/mintlify/reference/camel.personas.persona.mdx
+++ b/docs/mintlify/reference/camel.personas.persona.mdx
@@ -10,20 +10,15 @@ class Persona(BaseModel):
A persona is a character in the society.
-Attributes:
-name (Optional[str]): Name of the persona.
-description (Optional[str]): Description of the persona.
-text_to_persona_prompt (Union[TextPrompt, str]): The prompt to convert
-text into a persona.
-persona_to_persona_prompt (Union[TextPrompt, str]): Persona-to-Persona
-interaction prompt.
-id (uuid.UUID): The unique identifier for the persona, automatically
-generated.
-_id (uuid.UUID): Internal unique identifier for the persona,
-generated lazily using `uuid.uuid4`.
-model_config (ClassVar[ConfigDict]): Configuration for the Pydantic
-model. Allows arbitrary types and includes custom JSON schema
-settings.
+**Parameters:**
+
+- **name** (Optional[str]): Name of the persona.
+- **description** (Optional[str]): Description of the persona.
+- **text_to_persona_prompt** (Union[TextPrompt, str]): The prompt to convert text into a persona.
+- **persona_to_persona_prompt** (Union[TextPrompt, str]): Persona-to-Persona interaction prompt.
+- **id** (uuid.UUID): The unique identifier for the persona, automatically generated.
+- **_id** (uuid.UUID): Internal unique identifier for the persona, generated lazily using `uuid.uuid4`.
+- **model_config** (ClassVar[ConfigDict]): Configuration for the Pydantic model. Allows arbitrary types and includes custom JSON schema settings.
<a id="camel.personas.persona.Persona.id"></a>
diff --git a/docs/mintlify/reference/camel.prompts.ai_society.mdx b/docs/mintlify/reference/camel.prompts.ai_society.mdx
index 807728195..9a8cc5553 100644
--- a/docs/mintlify/reference/camel.prompts.ai_society.mdx
+++ b/docs/mintlify/reference/camel.prompts.ai_society.mdx
@@ -11,21 +11,14 @@ class AISocietyPromptTemplateDict(TextPromptDict):
A dictionary containing :obj:`TextPrompt` used in the `AI Society`
task.
-Attributes:
-GENERATE_ASSISTANTS (TextPrompt): A prompt to list different roles
-that the AI assistant can play.
-GENERATE_USERS (TextPrompt): A prompt to list common groups of
-internet users or occupations.
-GENERATE_TASKS (TextPrompt): A prompt to list diverse tasks that
-the AI assistant can assist AI user with.
-TASK_SPECIFY_PROMPT (TextPrompt): A prompt to specify a task in more
-detail.
-ASSISTANT_PROMPT (TextPrompt): A system prompt for the AI assistant
-that outlines the rules of the conversation and provides
-instructions for completing tasks.
-USER_PROMPT (TextPrompt): A system prompt for the AI user that
-outlines the rules of the conversation and provides instructions
-for giving instructions to the AI assistant.
+**Parameters:**
+
+- **GENERATE_ASSISTANTS** (TextPrompt): A prompt to list different roles that the AI assistant can play.
+- **GENERATE_USERS** (TextPrompt): A prompt to list common groups of internet users or occupations.
+- **GENERATE_TASKS** (TextPrompt): A prompt to list diverse tasks that the AI assistant can assist AI user with.
+- **TASK_SPECIFY_PROMPT** (TextPrompt): A prompt to specify a task in more detail.
+- **ASSISTANT_PROMPT** (TextPrompt): A system prompt for the AI assistant that outlines the rules of the conversation and provides instructions for completing tasks.
+- **USER_PROMPT** (TextPrompt): A system prompt for the AI user that outlines the rules of the conversation and provides instructions for giving instructions to the AI assistant.
<a id="camel.prompts.ai_society.AISocietyPromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.base.mdx b/docs/mintlify/reference/camel.prompts.base.mdx
index 6a7adfff4..46cc6e080 100644
--- a/docs/mintlify/reference/camel.prompts.base.mdx
+++ b/docs/mintlify/reference/camel.prompts.base.mdx
@@ -53,9 +53,9 @@ A class that represents a text prompt. The :obj:`TextPrompt` class
extends the built-in :obj:`str` class to provide a property for retrieving
the set of keywords in the prompt.
-Attributes:
-key_words (set): A set of strings representing the keywords in the
-prompt.
+**Parameters:**
+
+- **key_words** (set): A set of strings representing the keywords in the prompt.
<a id="camel.prompts.base.TextPrompt.key_words"></a>
@@ -95,8 +95,9 @@ class CodePrompt(TextPrompt):
A class that represents a code prompt. It extends the :obj:`TextPrompt`
class with a :obj:`code_type` property.
-Attributes:
-code_type (str, optional): The type of code. Defaults to None.
+**Parameters:**
+
+- **code_type** (str, optional): The type of code. Defaults to None.
<a id="camel.prompts.base.CodePrompt.__new__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.code.mdx b/docs/mintlify/reference/camel.prompts.code.mdx
index 2d79fcd6a..36013b902 100644
--- a/docs/mintlify/reference/camel.prompts.code.mdx
+++ b/docs/mintlify/reference/camel.prompts.code.mdx
@@ -10,21 +10,14 @@ class CodePromptTemplateDict(TextPromptDict):
A dictionary containing :obj:`TextPrompt` used in the `Code` task.
-Attributes:
-GENERATE_LANGUAGES (TextPrompt): A prompt to list different computer
-programming languages.
-GENERATE_DOMAINS (TextPrompt): A prompt to list common fields of study
-that programming could help with.
-GENERATE_TASKS (TextPrompt): A prompt to list diverse tasks that
-the AI assistant can assist AI user with.
-TASK_SPECIFY_PROMPT (TextPrompt): A prompt to specify a task in more
-detail.
-ASSISTANT_PROMPT (TextPrompt): A system prompt for the AI assistant
-that outlines the rules of the conversation and provides
-instructions for completing tasks.
-USER_PROMPT (TextPrompt): A system prompt for the AI user that
-outlines the rules of the conversation and provides instructions
-for giving instructions to the AI assistant.
+**Parameters:**
+
+- **GENERATE_LANGUAGES** (TextPrompt): A prompt to list different computer programming languages.
+- **GENERATE_DOMAINS** (TextPrompt): A prompt to list common fields of study that programming could help with.
+- **GENERATE_TASKS** (TextPrompt): A prompt to list diverse tasks that the AI assistant can assist AI user with.
+- **TASK_SPECIFY_PROMPT** (TextPrompt): A prompt to specify a task in more detail.
+- **ASSISTANT_PROMPT** (TextPrompt): A system prompt for the AI assistant that outlines the rules of the conversation and provides instructions for completing tasks.
+- **USER_PROMPT** (TextPrompt): A system prompt for the AI user that outlines the rules of the conversation and provides instructions for giving instructions to the AI assistant.
<a id="camel.prompts.code.CodePromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.evaluation.mdx b/docs/mintlify/reference/camel.prompts.evaluation.mdx
index 6789afc37..d5e53cf6c 100644
--- a/docs/mintlify/reference/camel.prompts.evaluation.mdx
+++ b/docs/mintlify/reference/camel.prompts.evaluation.mdx
@@ -11,10 +11,9 @@ class EvaluationPromptTemplateDict(TextPromptDict):
A dictionary containing :obj:`TextPrompt` used in the `Evaluation`
task.
-Attributes:
-GENERATE_QUESTIONS (TextPrompt): A prompt to generate a set of
-questions to be used for evaluating emergence of knowledge based
-on a particular field of knowledge.
+**Parameters:**
+
+- **GENERATE_QUESTIONS** (TextPrompt): A prompt to generate a set of questions to be used for evaluating emergence of knowledge based on a particular field of knowledge.
<a id="camel.prompts.evaluation.EvaluationPromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.generate_text_embedding_data.mdx b/docs/mintlify/reference/camel.prompts.generate_text_embedding_data.mdx
index 1cc79c2aa..f44d83e81 100644
--- a/docs/mintlify/reference/camel.prompts.generate_text_embedding_data.mdx
+++ b/docs/mintlify/reference/camel.prompts.generate_text_embedding_data.mdx
@@ -12,16 +12,12 @@ A :obj:`TextPrompt` dictionary containing text embedding tasks
generation, query, positive and hard negative samples generation,
from the ["Improving Text Embeddings with Large Language Models"](https://arxiv.org/abs/2401.00368) paper.
+**Parameters:**
-Attributes:
-GENERATE_TASKS (TextPrompt): A prompt to generate a list
-of :obj:`num_tasks` synthetic text_embedding tasks.
-ASSISTANT_PROMPT (TextPrompt): A system prompt for the AI assistant
-to generate synthetic :obj:`user_query`, :obj:`positive document`,
-and :obj:`hard_negative_document` for a specific :obj:`task` with
-specified parameters including :obj:`query_type`,
-:obj:`query_length`, :obj:`clarity`, :obj:`num_words`,
-:obj:`language` and :obj:`difficulty`.
+- **GENERATE_TASKS** (TextPrompt): A prompt to generate a list
+- **of**: obj:`num_tasks` synthetic text_embedding tasks.
+- **ASSISTANT_PROMPT** (TextPrompt): A system prompt for the AI assistant to generate synthetic :obj:`user_query`, :obj:`positive document`,
+- **and**: obj:`hard_negative_document` for a specific :obj:`task` with specified parameters including :obj:`query_type`, :obj:`query_length`, :obj:`clarity`, :obj:`num_words`, :obj:`language` and :obj:`difficulty`.
<a id="camel.prompts.generate_text_embedding_data.GenerateTextEmbeddingDataPromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.image_craft.mdx b/docs/mintlify/reference/camel.prompts.image_craft.mdx
index 7fe2cb796..ba5a5d5f6 100644
--- a/docs/mintlify/reference/camel.prompts.image_craft.mdx
+++ b/docs/mintlify/reference/camel.prompts.image_craft.mdx
@@ -11,9 +11,9 @@ class ImageCraftPromptTemplateDict(TextPromptDict):
A dictionary containing :obj:`TextPrompt` used in the `ImageCraft`
task.
-Attributes:
-ASSISTANT_PROMPT (TextPrompt): A prompt for the AI assistant to create
-an original image based on the provided descriptive captions.
+**Parameters:**
+
+- **ASSISTANT_PROMPT** (TextPrompt): A prompt for the AI assistant to create an original image based on the provided descriptive captions.
<a id="camel.prompts.image_craft.ImageCraftPromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.misalignment.mdx b/docs/mintlify/reference/camel.prompts.misalignment.mdx
index d2d2893a0..8c4901fe8 100644
--- a/docs/mintlify/reference/camel.prompts.misalignment.mdx
+++ b/docs/mintlify/reference/camel.prompts.misalignment.mdx
@@ -11,18 +11,13 @@ class MisalignmentPromptTemplateDict(TextPromptDict):
A dictionary containing :obj:`TextPrompt` used in the `Misalignment`
task.
-Attributes:
-DAN_PROMPT (TextPrompt): A prompt for jail breaking.
-GENERATE_TASKS (TextPrompt): A prompt to list unique malicious that
-the AI assistant can assist AI user with.
-TASK_SPECIFY_PROMPT (TextPrompt): A prompt to specify a task in more
-detail.
-ASSISTANT_PROMPT (TextPrompt): A system prompt for the AI assistant
-that outlines the rules of the conversation and provides
-instructions for completing tasks.
-USER_PROMPT (TextPrompt): A system prompt for the AI user that
-outlines the rules of the conversation and provides instructions
-for giving instructions to the AI assistant.
+**Parameters:**
+
+- **DAN_PROMPT** (TextPrompt): A prompt for jail breaking.
+- **GENERATE_TASKS** (TextPrompt): A prompt to list unique malicious that the AI assistant can assist AI user with.
+- **TASK_SPECIFY_PROMPT** (TextPrompt): A prompt to specify a task in more detail.
+- **ASSISTANT_PROMPT** (TextPrompt): A system prompt for the AI assistant that outlines the rules of the conversation and provides instructions for completing tasks.
+- **USER_PROMPT** (TextPrompt): A system prompt for the AI user that outlines the rules of the conversation and provides instructions for giving instructions to the AI assistant.
<a id="camel.prompts.misalignment.MisalignmentPromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.persona_hub.mdx b/docs/mintlify/reference/camel.prompts.persona_hub.mdx
index 7111867b2..478ecf40b 100644
--- a/docs/mintlify/reference/camel.prompts.persona_hub.mdx
+++ b/docs/mintlify/reference/camel.prompts.persona_hub.mdx
@@ -14,17 +14,10 @@ relating personas based on given text or existing personas.
This class inherits from TextPromptDict, allowing for easy access and
management of the prompts.
-Attributes:
-TEXT_TO_PERSONA (TextPrompt): A prompt for inferring a persona from a
-given text. This prompt asks to identify who is likely to interact
-with the provided text in various ways (read, write, like,
-dislike). The response should follow a specific template format.
-
-PERSONA_TO_PERSONA (TextPrompt): A prompt for deriving related personas
-based on a given persona. This prompt asks to describe personas who
-might have a close relationship with the provided persona. The
-response should follow a specific template format, allowing for
-multiple related personas.
+**Parameters:**
+
+- **TEXT_TO_PERSONA** (TextPrompt): A prompt for inferring a persona from a given text. This prompt asks to identify who is likely to interact with the provided text in various ways (read, write, like, dislike). The response should follow a specific template format.
+- **PERSONA_TO_PERSONA** (TextPrompt): A prompt for deriving related personas based on a given persona. This prompt asks to describe personas who might have a close relationship with the provided persona. The response should follow a specific template format, allowing for multiple related personas.
<a id="camel.prompts.persona_hub.PersonaHubPrompt.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.role_description_prompt_template.mdx b/docs/mintlify/reference/camel.prompts.role_description_prompt_template.mdx
index 665f20cd9..32136552c 100644
--- a/docs/mintlify/reference/camel.prompts.role_description_prompt_template.mdx
+++ b/docs/mintlify/reference/camel.prompts.role_description_prompt_template.mdx
@@ -11,15 +11,11 @@ class RoleDescriptionPromptTemplateDict(AISocietyPromptTemplateDict):
A dictionary containing :obj:`TextPrompt` used in the `role description`
task.
-Attributes:
-ROLE_DESCRIPTION_PROMPT (TextPrompt): A default prompt to
-describe the role descriptions.
-ASSISTANT_PROMPT (TextPrompt): A system prompt for the AI assistant
-that outlines the rules of the conversation and provides
-instructions for completing tasks.
-USER_PROMPT (TextPrompt): A system prompt for the AI user that
-outlines the rules of the conversation and provides instructions
-for giving instructions to the AI assistant.
+**Parameters:**
+
+- **ROLE_DESCRIPTION_PROMPT** (TextPrompt): A default prompt to describe the role descriptions.
+- **ASSISTANT_PROMPT** (TextPrompt): A system prompt for the AI assistant that outlines the rules of the conversation and provides instructions for completing tasks.
+- **USER_PROMPT** (TextPrompt): A system prompt for the AI user that outlines the rules of the conversation and provides instructions for giving instructions to the AI assistant.
<a id="camel.prompts.role_description_prompt_template.RoleDescriptionPromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.solution_extraction.mdx b/docs/mintlify/reference/camel.prompts.solution_extraction.mdx
index d25c35d27..52e95374d 100644
--- a/docs/mintlify/reference/camel.prompts.solution_extraction.mdx
+++ b/docs/mintlify/reference/camel.prompts.solution_extraction.mdx
@@ -11,10 +11,9 @@ class SolutionExtractionPromptTemplateDict(TextPromptDict):
A dictionary containing :obj:`TextPrompt` used in the `SolutionExtraction`
task.
-Attributes:
-ASSISTANT_PROMPT (TextPrompt): A system prompt for the AI assistant
-that outlines the rules of the conversation and provides
-instructions for completing tasks.
+**Parameters:**
+
+- **ASSISTANT_PROMPT** (TextPrompt): A system prompt for the AI assistant that outlines the rules of the conversation and provides instructions for completing tasks.
<a id="camel.prompts.solution_extraction.SolutionExtractionPromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.translation.mdx b/docs/mintlify/reference/camel.prompts.translation.mdx
index 144a1ff1a..9d95acf9a 100644
--- a/docs/mintlify/reference/camel.prompts.translation.mdx
+++ b/docs/mintlify/reference/camel.prompts.translation.mdx
@@ -11,10 +11,9 @@ class TranslationPromptTemplateDict(TextPromptDict):
A dictionary containing :obj:`TextPrompt` used in the `Translation`
task.
-Attributes:
-ASSISTANT_PROMPT (TextPrompt): A system prompt for the AI assistant
-that outlines the rules of the conversation and provides
-instructions for completing tasks.
+**Parameters:**
+
+- **ASSISTANT_PROMPT** (TextPrompt): A system prompt for the AI assistant that outlines the rules of the conversation and provides instructions for completing tasks.
<a id="camel.prompts.translation.TranslationPromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.prompts.video_description_prompt.mdx b/docs/mintlify/reference/camel.prompts.video_description_prompt.mdx
index c47e833bd..82f4ba738 100644
--- a/docs/mintlify/reference/camel.prompts.video_description_prompt.mdx
+++ b/docs/mintlify/reference/camel.prompts.video_description_prompt.mdx
@@ -11,9 +11,9 @@ class VideoDescriptionPromptTemplateDict(TextPromptDict):
A dictionary containing :obj:`TextPrompt` used in the `VideoDescription`
task.
-Attributes:
-ASSISTANT_PROMPT (TextPrompt): A prompt for the AI assistant to
-provide a shot description of the content of the current video.
+**Parameters:**
+
+- **ASSISTANT_PROMPT** (TextPrompt): A prompt for the AI assistant to provide a shot description of the content of the current video.
<a id="camel.prompts.video_description_prompt.VideoDescriptionPromptTemplateDict.__init__"></a>
diff --git a/docs/mintlify/reference/camel.responses.agent_responses.mdx b/docs/mintlify/reference/camel.responses.agent_responses.mdx
index 5c7ba765a..c5a0bc108 100644
--- a/docs/mintlify/reference/camel.responses.agent_responses.mdx
+++ b/docs/mintlify/reference/camel.responses.agent_responses.mdx
@@ -10,14 +10,11 @@ class ChatAgentResponse(BaseModel):
Response of a ChatAgent.
-Attributes:
-msgs (List[BaseMessage]): A list of zero, one or several messages.
-If the list is empty, there is some error in message generation.
-If the list has one message, this is normal mode.
-If the list has several messages, this is the critic mode.
-terminated (bool): A boolean indicating whether the agent decided
-to terminate the chat session.
-info (Dict[str, Any]): Extra information about the chat message.
+**Parameters:**
+
+- **msgs** (List[BaseMessage]): A list of zero, one or several messages. If the list is empty, there is some error in message generation. If the list has one message, this is normal mode. If the list has several messages, this is the critic mode.
+- **terminated** (bool): A boolean indicating whether the agent decided to terminate the chat session.
+- **info** (Dict[str, Any]): Extra information about the chat message.
<a id="camel.responses.agent_responses.ChatAgentResponse.msg"></a>
diff --git a/docs/mintlify/reference/camel.retrievers.auto_retriever.mdx b/docs/mintlify/reference/camel.retrievers.auto_retriever.mdx
index b8d1ba9dd..4143b74e3 100644
--- a/docs/mintlify/reference/camel.retrievers.auto_retriever.mdx
+++ b/docs/mintlify/reference/camel.retrievers.auto_retriever.mdx
@@ -11,15 +11,12 @@ class AutoRetriever:
Facilitates the automatic retrieval of information using a
query-based approach with pre-defined elements.
-Attributes:
-url_and_api_key (Optional[Tuple[str, str]]): URL and API key for
-accessing the vector storage remotely.
-vector_storage_local_path (Optional[str]): Local path for vector
-storage, if applicable.
-storage_type (Optional[StorageType]): The type of vector storage to
-use. Defaults to `StorageType.QDRANT`.
-embedding_model (Optional[BaseEmbedding]): Model used for embedding
-queries and documents. Defaults to `OpenAIEmbedding()`.
+**Parameters:**
+
+- **url_and_api_key** (Optional[Tuple[str, str]]): URL and API key for accessing the vector storage remotely.
+- **vector_storage_local_path** (Optional[str]): Local path for vector storage, if applicable.
+- **storage_type** (Optional[StorageType]): The type of vector storage to use. Defaults to `StorageType.QDRANT`.
+- **embedding_model** (Optional[BaseEmbedding]): Model used for embedding queries and documents. Defaults to `OpenAIEmbedding()`.
<a id="camel.retrievers.auto_retriever.AutoRetriever.__init__"></a>
diff --git a/docs/mintlify/reference/camel.retrievers.bm25_retriever.mdx b/docs/mintlify/reference/camel.retrievers.bm25_retriever.mdx
index 58e199c04..80674920e 100644
--- a/docs/mintlify/reference/camel.retrievers.bm25_retriever.mdx
+++ b/docs/mintlify/reference/camel.retrievers.bm25_retriever.mdx
@@ -14,16 +14,13 @@ This class facilitates the retriever of relevant information using a
query-based approach, it ranks documents based on the occurrence and
frequency of the query terms.
-Attributes:
-bm25 (BM25Okapi): An instance of the BM25Okapi class used for
-calculating document scores.
-content_input_path (str): The path to the content that has been
-processed and stored.
-unstructured_modules (UnstructuredIO): A module for parsing files and
-URLs and chunking content based on specified parameters.
-
-References:
-https://github.com/dorianbrown/rank_bm25
+**Parameters:**
+
+- **bm25** (BM25Okapi): An instance of the BM25Okapi class used for calculating document scores.
+- **content_input_path** (str): The path to the content that has been processed and stored.
+- **unstructured_modules** (UnstructuredIO): A module for parsing files and URLs and chunking content based on specified parameters.
+- **References**:
+- **https**: //github.com/dorianbrown/rank_bm25
<a id="camel.retrievers.bm25_retriever.BM25Retriever.__init__"></a>
diff --git a/docs/mintlify/reference/camel.retrievers.cohere_rerank_retriever.mdx b/docs/mintlify/reference/camel.retrievers.cohere_rerank_retriever.mdx
index 8dba680b6..692844e38 100644
--- a/docs/mintlify/reference/camel.retrievers.cohere_rerank_retriever.mdx
+++ b/docs/mintlify/reference/camel.retrievers.cohere_rerank_retriever.mdx
@@ -11,13 +11,12 @@ class CohereRerankRetriever(BaseRetriever):
An implementation of the `BaseRetriever` using the `Cohere Re-ranking`
model.
-Attributes:
-model_name (str): The model name to use for re-ranking.
-api_key (Optional[str]): The API key for authenticating with the
-Cohere service.
+**Parameters:**
-References:
-https://txt.cohere.com/rerank/
+- **model_name** (str): The model name to use for re-ranking.
+- **api_key** (Optional[str]): The API key for authenticating with the Cohere service.
+- **References**:
+- **https**: //txt.cohere.com/rerank/
<a id="camel.retrievers.cohere_rerank_retriever.CohereRerankRetriever.__init__"></a>
diff --git a/docs/mintlify/reference/camel.retrievers.vector_retriever.mdx b/docs/mintlify/reference/camel.retrievers.vector_retriever.mdx
index 4fdbb2cc2..a53d9ed56 100644
--- a/docs/mintlify/reference/camel.retrievers.vector_retriever.mdx
+++ b/docs/mintlify/reference/camel.retrievers.vector_retriever.mdx
@@ -14,12 +14,11 @@ embedding model.
This class facilitates the retriever of relevant information using a
query-based approach, backed by vector embeddings.
-Attributes:
-embedding_model (BaseEmbedding): Embedding model used to generate
-vector embeddings.
-storage (BaseVectorStorage): Vector storage to query.
-unstructured_modules (UnstructuredIO): A module for parsing files and
-URLs and chunking content based on specified parameters.
+**Parameters:**
+
+- **embedding_model** (BaseEmbedding): Embedding model used to generate vector embeddings.
+- **storage** (BaseVectorStorage): Vector storage to query.
+- **unstructured_modules** (UnstructuredIO): A module for parsing files and URLs and chunking content based on specified parameters.
<a id="camel.retrievers.vector_retriever.VectorRetriever.__init__"></a>
diff --git a/docs/mintlify/reference/camel.runtimes.ubuntu_docker_runtime.mdx b/docs/mintlify/reference/camel.runtimes.ubuntu_docker_runtime.mdx
index b98411999..35c9d26f3 100644
--- a/docs/mintlify/reference/camel.runtimes.ubuntu_docker_runtime.mdx
+++ b/docs/mintlify/reference/camel.runtimes.ubuntu_docker_runtime.mdx
@@ -15,9 +15,10 @@ containers, including proper Python path handling and environment setup.
It provides methods for executing Python files, managing the container
lifecycle, and handling file operations within the Ubuntu container.
-Attributes:
-python_path (str): Path to the Python interpreter in the container
-docker_config (dict): Configuration dict for Docker container setup
+**Parameters:**
+
+- **python_path** (str): Path to the Python interpreter in the container
+- **docker_config** (dict): Configuration dict for Docker container setup
<a id="camel.runtimes.ubuntu_docker_runtime.UbuntuDockerRuntime.__init__"></a>
diff --git a/docs/mintlify/reference/camel.societies.workforce.task_channel.mdx b/docs/mintlify/reference/camel.societies.workforce.task_channel.mdx
index d76392906..e05999f77 100644
--- a/docs/mintlify/reference/camel.societies.workforce.task_channel.mdx
+++ b/docs/mintlify/reference/camel.societies.workforce.task_channel.mdx
@@ -32,10 +32,6 @@ and the task's status.
**Parameters:**
-- **task** (Task): The task that is wrapped inside the packet.
-- **publisher_id** (str): The ID of the workforce that published the task.
-- **assignee_id** (str): The ID of the workforce that is assigned to the task. Defaults to None, meaning that the task is posted as a dependency in the channel.
-- **Attributes**:
- **task** (Task): The task that is wrapped inside the packet.
- **publisher_id** (str): The ID of the workforce that published the task.
- **assignee_id** (Optional[str], optional): The ID of the workforce that is assigned to the task. Would be None if the task is a dependency. Defaults to None.
diff --git a/docs/mintlify/reference/camel.storages.graph_storages.graph_element.mdx b/docs/mintlify/reference/camel.storages.graph_storages.graph_element.mdx
index f70476ed1..f92b569d0 100644
--- a/docs/mintlify/reference/camel.storages.graph_storages.graph_element.mdx
+++ b/docs/mintlify/reference/camel.storages.graph_storages.graph_element.mdx
@@ -10,11 +10,11 @@ class Node(BaseModel):
Represents a node in a graph with associated properties.
-Attributes:
-id (Union[str, int]): A unique identifier for the node.
-type (str): The type of the relationship.
-properties (dict): Additional properties and metadata associated with
-the node.
+**Parameters:**
+
+- **id** (Union[str, int]): A unique identifier for the node.
+- **type** (str): The type of the relationship.
+- **properties** (dict): Additional properties and metadata associated with the node.
<a id="camel.storages.graph_storages.graph_element.Relationship"></a>
@@ -26,13 +26,13 @@ class Relationship(BaseModel):
Represents a directed relationship between two nodes in a graph.
-Attributes:
-subj (Node): The subject/source node of the relationship.
-obj (Node): The object/target node of the relationship.
-type (str): The type of the relationship.
-timestamp (str, optional): The timestamp of the relationship.
-properties (dict): Additional properties associated with the
-relationship.
+**Parameters:**
+
+- **subj** (Node): The subject/source node of the relationship.
+- **obj** (Node): The object/target node of the relationship.
+- **type** (str): The type of the relationship.
+- **timestamp** (str, optional): The timestamp of the relationship.
+- **properties** (dict): Additional properties associated with the relationship.
<a id="camel.storages.graph_storages.graph_element.GraphElement"></a>
@@ -44,12 +44,11 @@ class GraphElement(BaseModel):
A graph element with lists of nodes and relationships.
-Attributes:
-nodes (List[Node]): A list of nodes in the graph.
-relationships (List[Relationship]): A list of relationships in the
-graph.
-source (Element): The element from which the graph information is
-derived.
+**Parameters:**
+
+- **nodes** (List[Node]): A list of nodes in the graph.
+- **relationships** (List[Relationship]): A list of relationships in the graph.
+- **source** (Element): The element from which the graph information is derived.
<a id="camel.storages.graph_storages.graph_element.GraphElement.__post_init__"></a>
diff --git a/docs/mintlify/reference/camel.storages.vectordb_storages.base.mdx b/docs/mintlify/reference/camel.storages.vectordb_storages.base.mdx
index e811669b5..8d946e52e 100644
--- a/docs/mintlify/reference/camel.storages.vectordb_storages.base.mdx
+++ b/docs/mintlify/reference/camel.storages.vectordb_storages.base.mdx
@@ -12,12 +12,11 @@ Encapsulates information about a vector's unique identifier and its
payload, which is primarily used as a data transfer object when saving
to vector storage.
-Attributes:
-vector (List[float]): The numerical representation of the vector.
-id (str, optional): A unique identifier for the vector. If not
-provided, an random uuid will be assigned.
-payload (Optional[Dict[str, Any]], optional): Any additional metadata
-or information related to the vector. (default: :obj:`None`)
+**Parameters:**
+
+- **vector** (List[float]): The numerical representation of the vector.
+- **id** (str, optional): A unique identifier for the vector. If not provided, an random uuid will be assigned.
+- **payload** (Optional[Dict[str, Any]], optional): Any additional metadata or information related to the vector. (default: :obj:`None`)
<a id="camel.storages.vectordb_storages.base.VectorDBQuery"></a>
@@ -29,11 +28,10 @@ class VectorDBQuery(BaseModel):
Represents a query to a vector database.
-Attributes:
-query_vector (List[float]): The numerical representation of the query
-vector.
-top_k (int, optional): The number of top similar vectors to retrieve
-from the database. (default: :obj:`1`)
+**Parameters:**
+
+- **query_vector** (List[float]): The numerical representation of the query vector.
+- **top_k** (int, optional): The number of top similar vectors to retrieve from the database. (default: :obj:`1`)
<a id="camel.storages.vectordb_storages.base.VectorDBQuery.__init__"></a>
@@ -65,10 +63,10 @@ class VectorDBQueryResult(BaseModel):
Encapsulates the result of a query against a vector database.
-Attributes:
-record (VectorRecord): The target vector record.
-similarity (float): The similarity score between the query vector and
-the record.
+**Parameters:**
+
+- **record** (VectorRecord): The target vector record.
+- **similarity** (float): The similarity score between the query vector and the record.
<a id="camel.storages.vectordb_storages.base.VectorDBQueryResult.create"></a>
@@ -96,9 +94,10 @@ class VectorDBStatus(BaseModel):
Vector database status.
-Attributes:
-vector_dim (int): The dimension of stored vectors.
-vector_count (int): The number of stored vectors.
+**Parameters:**
+
+- **vector_dim** (int): The dimension of stored vectors.
+- **vector_count** (int): The number of stored vectors.
<a id="camel.storages.vectordb_storages.base.BaseVectorStorage"></a>
diff --git a/docs/mintlify/reference/camel.storages.vectordb_storages.faiss.mdx b/docs/mintlify/reference/camel.storages.vectordb_storages.faiss.mdx
index f0a268551..d25f16d59 100644
--- a/docs/mintlify/reference/camel.storages.vectordb_storages.faiss.mdx
+++ b/docs/mintlify/reference/camel.storages.vectordb_storages.faiss.mdx
@@ -23,7 +23,16 @@ The detailed information about FAISS is available at:
- **distance** (VectorDistance, optional): The distance metric for vector comparison (default: :obj:`VectorDistance.COSINE`)
- **nlist** (int, optional): Number of cluster centroids for IVF indexes. Only used if index_type includes 'IVF'. (default: :obj:`100`)
- **m** (int, optional): HNSW parameter. Number of connections per node. Only used if index_type includes 'HNSW'. (default: :obj:`16`) **kwargs (Any): Additional keyword arguments.
-- **Notes**: - FAISS offers various index types optimized for different use cases: - 'Flat': Exact search, but slowest for large datasets - 'IVF': Inverted file index, good balance of speed and recall - 'HNSW': Hierarchical Navigable Small World, fast with high recall - 'PQ': Product Quantization for memory-efficient storage - The choice of index should be based on your specific requirements for search speed, memory usage, and accuracy.
+
+**Note:**
+
+- FAISS offers various index types optimized for different use cases:
+- 'Flat': Exact search, but slowest for large datasets
+- 'IVF': Inverted file index, good balance of speed and recall
+- 'HNSW': Hierarchical Navigable Small World, fast with high recall
+- 'PQ': Product Quantization for memory-efficient storage
+- The choice of index should be based on your specific requirements
+for search speed, memory usage, and accuracy.
<a id="camel.storages.vectordb_storages.faiss.FaissStorage.__init__"></a>
@@ -182,6 +191,14 @@ filters.
- **ids** (Optional[List[str]], optional): List of unique identifiers for the vectors to be deleted.
- **payload_filter** (Optional[Dict[str, Any]], optional): A filter for the payload to delete points matching specific conditions. **kwargs (Any): Additional keyword arguments.
+**Note:**
+
+- FAISS does not support efficient single vector removal for most
+index types. This implementation recreates the index without the
+deleted vectors, which can be inefficient for large datasets.
+- If both `ids` and `payload_filter` are provided, both filters
+will be applied (vectors matching either will be deleted).
+
<a id="camel.storages.vectordb_storages.faiss.FaissStorage.status"></a>
### status
diff --git a/docs/mintlify/reference/camel.storages.vectordb_storages.qdrant.mdx b/docs/mintlify/reference/camel.storages.vectordb_storages.qdrant.mdx
index 1a6aadcb2..986f8f2ff 100644
--- a/docs/mintlify/reference/camel.storages.vectordb_storages.qdrant.mdx
+++ b/docs/mintlify/reference/camel.storages.vectordb_storages.qdrant.mdx
@@ -22,7 +22,16 @@ The detailed information about Qdrant is available at:
- **path** (Optional[str], optional): Path to a directory for initializing a local Qdrant client. (default: :obj:`None`)
- **distance** (VectorDistance, optional): The distance metric for vector comparison (default: :obj:`VectorDistance.COSINE`)
- **delete_collection_on_del** (bool, optional): Flag to determine if the collection should be deleted upon object destruction. (default: :obj:`False`) **kwargs (Any): Additional keyword arguments for initializing `QdrantClient`.
-- **Notes**: - If `url_and_api_key` is provided, it takes priority and the client will attempt to connect to the remote Qdrant instance using the URL endpoint. - If `url_and_api_key` is not provided and `path` is given, the client will use the local path to initialize Qdrant. - If neither `url_and_api_key` nor `path` is provided, the client will be initialized with an in-memory storage (`":memory:"`).
+
+**Note:**
+
+- If `url_and_api_key` is provided, it takes priority and the client
+will attempt to connect to the remote Qdrant instance using the URL
+endpoint.
+- If `url_and_api_key` is not provided and `path` is given, the client
+will use the local path to initialize Qdrant.
+- If neither `url_and_api_key` nor `path` is provided, the client will
+be initialized with an in-memory storage (`":memory:"`).
<a id="camel.storages.vectordb_storages.qdrant.QdrantStorage.__init__"></a>
@@ -223,6 +232,13 @@ filters.
- **ids** (Optional[List[str]], optional): List of unique identifiers for the vectors to be deleted.
- **payload_filter** (Optional[Dict[str, Any]], optional): A filter for the payload to delete points matching specific conditions. If `ids` is provided, `payload_filter` will be ignored unless both are combined explicitly. **kwargs (Any): Additional keyword arguments pass to `QdrantClient. delete`.
+**Note:**
+
+- If `ids` is provided, the points with these IDs will be deleted
+directly, and the `payload_filter` will be ignored.
+- If `ids` is not provided but `payload_filter` is, then points
+matching the `payload_filter` will be deleted.
+
<a id="camel.storages.vectordb_storages.qdrant.QdrantStorage.status"></a>
### status
diff --git a/docs/mintlify/reference/camel.storages.vectordb_storages.weaviate.mdx b/docs/mintlify/reference/camel.storages.vectordb_storages.weaviate.mdx
index a2b873f2e..ace0de10e 100644
--- a/docs/mintlify/reference/camel.storages.vectordb_storages.weaviate.mdx
+++ b/docs/mintlify/reference/camel.storages.vectordb_storages.weaviate.mdx
@@ -48,6 +48,12 @@ This class provides multiple ways to connect to Weaviate instances:
- **additional_config** (Optional[Any], optional): Advanced configuration options like timeouts. (default: :obj:`None`)
- **skip_init_checks** (bool, optional): Skip initialization checks. (default: :obj:`False`)
+**Note:**
+
+This implementation supports synchronous operations only.
+The client connection is automatically handled and closed when the
+storage instance is destroyed.
+
<a id="camel.storages.vectordb_storages.weaviate.WeaviateStorage.__init__"></a>
### __init__
diff --git a/docs/mintlify/reference/camel.tasks.task.mdx b/docs/mintlify/reference/camel.tasks.task.mdx
index b916aa671..4008f750b 100644
--- a/docs/mintlify/reference/camel.tasks.task.mdx
+++ b/docs/mintlify/reference/camel.tasks.task.mdx
@@ -45,24 +45,17 @@ class Task(BaseModel):
Task is specific assignment that can be passed to a agent.
-Attributes:
-content (str): string content for task.
-id (str): An unique string identifier for the task. This should
-ideally be provided by the provider/model which created the task.
-(default: :obj: `""`)
-state (TaskState): The state which should be OPEN, RUNNING, DONE or
-DELETED. (default: :obj: `TaskState.OPEN`)
-type (Optional[str]): task type. (default: :obj: `None`)
-parent (Optional[Task]): The parent task, None for root task.
-(default: :obj: `None`)
-subtasks (List[Task]): The childrent sub-tasks for the task.
-(default: :obj: `[]`)
-result (Optional[str]): The answer for the task.
-(default: :obj: `""`)
-failure_count (int): The failure count for the task.
-(default: :obj: `0`)
-additional_info (Optional[Dict[str, Any]]): Additional information for
-the task. (default: :obj: `None`)
+**Parameters:**
+
+- **content** (str): string content for task.
+- **id** (str): An unique string identifier for the task. This should ideally be provided by the provider/model which created the task. (default: :obj: `""`)
+- **state** (TaskState): The state which should be OPEN, RUNNING, DONE or DELETED. (default: :obj: `TaskState.OPEN`)
+- **type** (Optional[str]): task type. (default: :obj: `None`) (default: None)
+- **parent** (Optional[Task]): The parent task, None for root task. (default: :obj: `None`)
+- **subtasks** (List[Task]): The childrent sub-tasks for the task. (default: :obj: `[]`)
+- **result** (Optional[str]): The answer for the task. (default: :obj: `""`)
+- **failure_count** (int): The failure count for the task. (default: :obj: `0`)
+- **additional_info** (Optional[Dict[str, Any]]): Additional information for the task. (default: :obj: `None`)
<a id="camel.tasks.task.Task.__repr__"></a>
@@ -296,12 +289,6 @@ class TaskManager:
TaskManager is used to manage tasks.
-Attributes:
-root_task: The root task.
-tasks: The ordered tasks.
-task_map: A map for task.id to Task.
-current_task_id: The current "RUNNING" task.id.
-
**Parameters:**
- **task** (Task): The root Task.
diff --git a/docs/mintlify/reference/camel.toolkits.dappier_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.dappier_toolkit.mdx
index 5126e07e0..2c941527a 100644
--- a/docs/mintlify/reference/camel.toolkits.dappier_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.dappier_toolkit.mdx
@@ -63,7 +63,8 @@ polygon.io, with AI-powered insights and up-to-the-minute updates.
AI model ID. This may include real time search data,
depending on the selected AI model.
-Note:
+**Note:**
+
Multiple AI model IDs are available, which can be found at:
https://marketplace.dappier.com/marketplace
@@ -113,7 +114,8 @@ sources like The Mix, Snipdaily, Nerdable, and Familyproof.
List[Dict[str, str]]: A list of recommended articles or content
based on the specified parameters, query, and data model.
-Note:
+**Note:**
+
Multiple data model IDs are available and can be found at:
https://marketplace.dappier.com/marketplace
diff --git a/docs/mintlify/reference/camel.toolkits.data_commons_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.data_commons_toolkit.mdx
index e224c8af0..54ecf50ad 100644
--- a/docs/mintlify/reference/camel.toolkits.data_commons_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.data_commons_toolkit.mdx
@@ -56,7 +56,8 @@ Query the Data Commons knowledge graph using SPARQL.
representing a node matching the query conditions if success,
(default: :obj:`None`) otherwise.
-Note:
+**Note:**
+
- Only supports a limited subset of SPARQL functionality (ORDER BY,
DISTINCT, LIMIT).
- Each variable in the query should have a 'typeOf' condition.
@@ -87,7 +88,8 @@ Retrieve triples associated with nodes.
DCIDs and values are lists of associated triples if success,
(default: :obj:`None`) otherwise.
-Note:
+**Note:**
+
- The function will raise a ValueError if any of the required
arguments are missing.
- The function will raise a TypeError if the dcids are not a string
diff --git a/docs/mintlify/reference/camel.toolkits.function_tool.mdx b/docs/mintlify/reference/camel.toolkits.function_tool.mdx
index 843e97f40..a6120a127 100644
--- a/docs/mintlify/reference/camel.toolkits.function_tool.mdx
+++ b/docs/mintlify/reference/camel.toolkits.function_tool.mdx
@@ -60,16 +60,6 @@ This function creates a schema compatible with OpenAI's API specifications,
based on the provided Python function. It processes the function's
parameters, types, and docstrings, and constructs a schema accordingly.
-Note:
-- Each parameter in `func` must have a type annotation; otherwise, it's
-treated as 'Any'.
-- Variable arguments (*args) and keyword arguments (**kwargs) are not
-supported and will be ignored.
-- A functional description including a brief and detailed explanation
-should be provided in the docstring of `func`.
-- All parameters of `func` must be described in its docstring.
-- Supported docstring styles: ReST, Google, Numpydoc, and Epydoc.
-
**Parameters:**
- **func** (Callable): The Python function to be converted into an OpenAI JSON schema.
diff --git a/docs/mintlify/reference/camel.toolkits.google_scholar_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.google_scholar_toolkit.mdx
index 87327e3df..6000c6fd5 100644
--- a/docs/mintlify/reference/camel.toolkits.google_scholar_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.google_scholar_toolkit.mdx
@@ -11,14 +11,12 @@ class GoogleScholarToolkit(BaseToolkit):
A toolkit for retrieving information about authors and their
publications from Google Scholar.
-Attributes:
-author_identifier (Union[str, None]): The author's Google Scholar URL
-or name of the author to search for.
-is_author_name (bool): Flag to indicate if the identifier is a name.
-(default: :obj:`False`)
-scholarly (module): The scholarly module for querying Google Scholar.
-author (Optional[Dict[str, Any]]): Cached author details, allowing
-manual assignment if desired.
+**Parameters:**
+
+- **author_identifier** (Union[str, None]): The author's Google Scholar URL or name of the author to search for.
+- **is_author_name** (bool): Flag to indicate if the identifier is a name. (default: :obj:`False`)
+- **scholarly** (module): The scholarly module for querying Google Scholar.
+- **author** (Optional[Dict[str, Any]]): Cached author details, allowing manual assignment if desired.
<a id="camel.toolkits.google_scholar_toolkit.GoogleScholarToolkit.__init__"></a>
diff --git a/docs/mintlify/reference/camel.toolkits.klavis_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.klavis_toolkit.mdx
index 407c3d248..fe4a51030 100644
--- a/docs/mintlify/reference/camel.toolkits.klavis_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.klavis_toolkit.mdx
@@ -14,12 +14,11 @@ This class provides methods for interacting with Klavis MCP server
instances, retrieving server information, managing tools, and handling
authentication.
-Attributes:
-api_key (str): The API key for authenticating with Klavis API.
-base_url (str): The base URL for Klavis API endpoints.
-timeout (Optional[float]): The timeout value for API requests
-in seconds. If None, no timeout is applied.
-(default: :obj:`None`)
+**Parameters:**
+
+- **api_key** (str): The API key for authenticating with Klavis API.
+- **base_url** (str): The base URL for Klavis API endpoints.
+- **timeout** (Optional[float]): The timeout value for API requests in seconds. If None, no timeout is applied. (default: :obj:`None`)
<a id="camel.toolkits.klavis_toolkit.KlavisToolkit.__init__"></a>
diff --git a/docs/mintlify/reference/camel.toolkits.mcp_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.mcp_toolkit.mdx
index d007e0127..d0b5081c2 100644
--- a/docs/mintlify/reference/camel.toolkits.mcp_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.mcp_toolkit.mdx
@@ -70,11 +70,6 @@ tools = toolkit.get_tools()
# Don't forget to disconnect when done!
await toolkit.disconnect()
-Note:
-Both MCPClient and MCPToolkit now use the same async context manager
-pattern for consistent connection management. MCPToolkit automatically
-manages multiple MCPClient instances using AsyncExitStack.
-
**Parameters:**
- **clients** (Optional[List[MCPClient]], optional): List of :obj:`MCPClient` instances to manage. (default: :obj:`None`)
@@ -82,8 +77,6 @@ manages multiple MCPClient instances using AsyncExitStack.
- **config_dict** (Optional[Dict[str, Any]], optional): Dictionary containing MCP server configurations in the same format as the config file. This allows for programmatic configuration without file I/O. (default: :obj:`None`)
- **timeout** (Optional[float], optional): Timeout for connection attempts in seconds. This timeout applies to individual client connections. (default: :obj:`None`)
- **strict** (Optional[bool], optional): Flag to indicate strict mode. (default: :obj:`False`)
-- **Note**: At least one of :obj:`clients`, :obj:`config_path`, or :obj:`config_dict` must be provided. If multiple sources are provided, clients from all sources will be combined. For web servers in the config, you can specify authorization headers using the "headers" field to connect to protected MCP server endpoints. Example configuration: .. code-block:: json `{ "mcpServers": { "filesystem": { "command": "npx", "args": ["-y", "@modelcontextprotocol/server-filesystem", "/path"] }, "protected-server": { "url": "https://example.com/mcp", "timeout": 30, "headers": { "Authorization": "Bearer YOUR_TOKEN", "X-API-Key": "YOUR_API_KEY" } } } }`
-- **Attributes**:
- **clients** (List[MCPClient]): List of :obj:`MCPClient` instances being managed by this toolkit.
<a id="camel.toolkits.mcp_toolkit.MCPToolkit.__init__"></a>
@@ -220,12 +213,6 @@ def get_tools(self):
from all connected MCP servers. Returns an empty list if no
clients are connected or if no tools are available.
-Note:
-This method can be called even when the toolkit is not connected,
-but it will log a warning and may return incomplete results.
-For best results, ensure the toolkit is connected before calling
-this method.
-
<a id="camel.toolkits.mcp_toolkit.MCPToolkit.get_text_tools"></a>
### get_text_tools
diff --git a/docs/mintlify/reference/camel.toolkits.mineru_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.mineru_toolkit.mdx
index 728b42825..e247e386c 100644
--- a/docs/mintlify/reference/camel.toolkits.mineru_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.mineru_toolkit.mdx
@@ -15,7 +15,8 @@ Provides comprehensive document processing capabilities including content
extraction from URLs and files, with support for OCR, formula recognition,
and table detection through the MinerU API service.
-Note:
+**Note:**
+
- Maximum file size: 200MB per file
- Maximum pages: 600 pages per file
- Daily quota: 2000 pages for high-priority parsing
@@ -93,7 +94,8 @@ Retrieve current status of an individual extraction task.
Dict: Status information and results (if task is completed) for
the specified task.
-Note:
+**Note:**
+
This is a low-level status checking method. For most use cases,
prefer using extract_from_url with wait=True for automatic
completion handling.
@@ -117,7 +119,8 @@ Retrieve current status of a batch extraction task.
Dict: Comprehensive status information and results for all files
in the batch task.
-Note:
+**Note:**
+
This is a low-level status checking method. For most use cases,
prefer using batch_extract_from_urls with wait=True for automatic
completion handling.
diff --git a/docs/mintlify/reference/camel.toolkits.notion_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.notion_toolkit.mdx
index e3530090a..ca25d19c8 100644
--- a/docs/mintlify/reference/camel.toolkits.notion_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.notion_toolkit.mdx
@@ -49,11 +49,10 @@ class NotionToolkit(BaseToolkit):
A toolkit for retrieving information from the user's notion pages.
-Attributes:
-notion_token (Optional[str], optional): The notion_token used to
-interact with notion APIs. (default: :obj:`None`)
-notion_client (module): The notion module for interacting with
-the notion APIs.
+**Parameters:**
+
+- **notion_token** (Optional[str], optional): The notion_token used to interact with notion APIs. (default: :obj:`None`)
+- **notion_client** (module): The notion module for interacting with the notion APIs.
<a id="camel.toolkits.notion_toolkit.NotionToolkit.__init__"></a>
diff --git a/docs/mintlify/reference/camel.toolkits.open_api_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.open_api_toolkit.mdx
index 5217ae037..effdbb710 100644
--- a/docs/mintlify/reference/camel.toolkits.open_api_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.open_api_toolkit.mdx
@@ -66,6 +66,14 @@ lacks a description or summary.
function in the OpenAI schema format, including details about
the function's name, description, and parameters.
+**Note:**
+
+This function assumes that the OpenAPI specification
+follows the 3.0+ format.
+
+Reference:
+https://swagger.io/specification/
+
<a id="camel.toolkits.open_api_toolkit.OpenAPIToolkit.openapi_function_decorator"></a>
### openapi_function_decorator
diff --git a/docs/mintlify/reference/camel.toolkits.playwright_mcp_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.playwright_mcp_toolkit.mdx
index 4b185e56f..21966ff79 100644
--- a/docs/mintlify/reference/camel.toolkits.playwright_mcp_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.playwright_mcp_toolkit.mdx
@@ -12,11 +12,12 @@ PlaywrightMCPToolkit provides an interface for interacting with web
browsers using the Playwright automation library through the Model Context
Protocol (MCP).
-Attributes:
-timeout (Optional[float]): Connection timeout in seconds.
-(default: :obj:`None`)
+**Parameters:**
+
+- **timeout** (Optional[float]): Connection timeout in seconds. (default: :obj:`None`)
+
+**Note:**
-Note:
Currently only supports asynchronous operation mode.
<a id="camel.toolkits.playwright_mcp_toolkit.PlaywrightMCPToolkit.__init__"></a>
diff --git a/docs/mintlify/reference/camel.toolkits.reddit_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.reddit_toolkit.mdx
index 688997614..e3130e004 100644
--- a/docs/mintlify/reference/camel.toolkits.reddit_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.reddit_toolkit.mdx
@@ -14,10 +14,11 @@ This toolkit provides methods to interact with the Reddit API, allowing
users to collect top posts, perform sentiment analysis on comments, and
track keyword discussions across multiple subreddits.
-Attributes:
-retries (int): Number of retries for API requests in case of failure.
-delay (float): Delay between retries in seconds.
-reddit (Reddit): An instance of the Reddit client.
+**Parameters:**
+
+- **retries** (int): Number of retries for API requests in case of failure.
+- **delay** (float): Delay between retries in seconds.
+- **reddit** (Reddit): An instance of the Reddit client.
<a id="camel.toolkits.reddit_toolkit.RedditToolkit.__init__"></a>
diff --git a/docs/mintlify/reference/camel.toolkits.stripe_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.stripe_toolkit.mdx
index b32525f1b..0715a7962 100644
--- a/docs/mintlify/reference/camel.toolkits.stripe_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.stripe_toolkit.mdx
@@ -17,8 +17,9 @@ Balance, BalanceTransaction, Payment, Refund
Use the Developers Dashboard https://dashboard.stripe.com/test/apikeys to
create an API keys as STRIPE_API_KEY.
-Attributes:
-logger (Logger): a logger to write logs.
+**Parameters:**
+
+- **logger** (Logger): a logger to write logs.
<a id="camel.toolkits.stripe_toolkit.StripeToolkit.__init__"></a>
diff --git a/docs/mintlify/reference/camel.toolkits.terminal_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.terminal_toolkit.mdx
index 29c1bc1bf..da1b1c62c 100644
--- a/docs/mintlify/reference/camel.toolkits.terminal_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.terminal_toolkit.mdx
@@ -23,7 +23,12 @@ managing terminal sessions.
- **use_shell_mode** (bool): Whether to use shell mode for command execution. (default: :obj:`True`)
- **clone_current_env** (bool): Whether to clone the current Python environment.(default: :obj:`False`)
- **safe_mode** (bool): Whether to enable safe mode to restrict operations. (default: :obj:`True`)
-- **Note**: Most functions are compatible with Unix-based systems (macOS, Linux). For Windows compatibility, additional implementation details are needed.
+
+**Note:**
+
+Most functions are compatible with Unix-based systems (macOS, Linux).
+For Windows compatibility, additional implementation details are
+needed.
<a id="camel.toolkits.terminal_toolkit.TerminalToolkit.__init__"></a>
diff --git a/docs/mintlify/reference/camel.toolkits.twitter_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.twitter_toolkit.mdx
index 9bad0a6b1..e39ad5104 100644
--- a/docs/mintlify/reference/camel.toolkits.twitter_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.twitter_toolkit.mdx
@@ -34,7 +34,8 @@ before the tweet is created.
including the tweet ID and text. If the request to the
Twitter API is not successful, the return is an error message.
-Note:
+**Note:**
+
You can only provide either the `quote_tweet_id` parameter or
the pair of `poll_duration_minutes` and `poll_options` parameters,
not both.
@@ -178,7 +179,8 @@ getting the authenticated user's profile information.
References:
https://developer.x.com/en/portal/dashboard
-Notes:
+**Note:**
+
To use this toolkit, you need to set the following environment
variables:
- TWITTER_CONSUMER_KEY: The consumer key for the Twitter API.
diff --git a/docs/mintlify/reference/camel.toolkits.weather_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.weather_toolkit.mdx
index b98f0efc0..2ffbb0031 100644
--- a/docs/mintlify/reference/camel.toolkits.weather_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.weather_toolkit.mdx
@@ -81,7 +81,8 @@ Min temp : 12°C.
Wind: 5 m/s at 270 degrees. Visibility: 10 kilometers.
Sunrise at 05:46:05 (UTC), Sunset at 18:42:20 (UTC)."
-Note:
+**Note:**
+
Please ensure that the API key is valid and has permissions
to access the weather data.
diff --git a/docs/mintlify/reference/camel.toolkits.whatsapp_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.whatsapp_toolkit.mdx
index 7aa0d2c61..d97d0100f 100644
--- a/docs/mintlify/reference/camel.toolkits.whatsapp_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.whatsapp_toolkit.mdx
@@ -14,11 +14,12 @@ This toolkit provides methods to interact with the WhatsApp Business API,
allowing users to send messages, retrieve message templates, and get
business profile information.
-Attributes:
-retries (int): Number of retries for API requests in case of failure.
-delay (int): Delay between retries in seconds.
-base_url (str): Base URL for the WhatsApp Business API.
-version (str): API version.
+**Parameters:**
+
+- **retries** (int): Number of retries for API requests in case of failure.
+- **delay** (int): Delay between retries in seconds.
+- **base_url** (str): Base URL for the WhatsApp Business API.
+- **version** (str): API version.
<a id="camel.toolkits.whatsapp_toolkit.WhatsAppToolkit.__init__"></a>
diff --git a/docs/mintlify/reference/camel.toolkits.zapier_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.zapier_toolkit.mdx
index edbd2c440..89275b003 100644
--- a/docs/mintlify/reference/camel.toolkits.zapier_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.zapier_toolkit.mdx
@@ -14,12 +14,11 @@ This class provides methods for executing Zapier actions through natural
language commands, allowing integration with various web services and
automation of workflows through the Zapier platform.
-Attributes:
-api_key (str): The API key for authenticating with Zapier's API.
-base_url (str): The base URL for Zapier's API endpoints.
-timeout (Optional[float]): The timeout value for API requests
-in seconds. If None, no timeout is applied.
-(default: :obj:`None`)
+**Parameters:**
+
+- **api_key** (str): The API key for authenticating with Zapier's API.
+- **base_url** (str): The base URL for Zapier's API endpoints.
+- **timeout** (Optional[float]): The timeout value for API requests in seconds. If None, no timeout is applied. (default: :obj:`None`)
<a id="camel.toolkits.zapier_toolkit.ZapierToolkit.__init__"></a>
diff --git a/docs/mintlify/reference/camel.types.agents.tool_calling_record.mdx b/docs/mintlify/reference/camel.types.agents.tool_calling_record.mdx
index 6c83fc31c..e4f64fb77 100644
--- a/docs/mintlify/reference/camel.types.agents.tool_calling_record.mdx
+++ b/docs/mintlify/reference/camel.types.agents.tool_calling_record.mdx
@@ -10,11 +10,12 @@ class ToolCallingRecord(BaseModel):
Historical records of tools called in the conversation.
-Attributes:
-func_name (str): The name of the tool being called.
-args (Dict[str, Any]): The dictionary of arguments passed to the tool.
-result (Any): The execution result of calling this tool.
-tool_call_id (str): The ID of the tool call, if available.
+**Parameters:**
+
+- **func_name** (str): The name of the tool being called.
+- **args** (Dict[str, Any]): The dictionary of arguments passed to the tool.
+- **result** (Any): The execution result of calling this tool.
+- **tool_call_id** (str): The ID of the tool call, if available.
<a id="camel.types.agents.tool_calling_record.ToolCallingRecord.__str__"></a>
diff --git a/docs/mintlify/reference/camel.types.mcp_registries.mdx b/docs/mintlify/reference/camel.types.mcp_registries.mdx
index 7fcf3259c..6456ba8b2 100644
--- a/docs/mintlify/reference/camel.types.mcp_registries.mdx
+++ b/docs/mintlify/reference/camel.types.mcp_registries.mdx
@@ -20,12 +20,11 @@ class BaseMCPRegistryConfig(BaseModel):
Base configuration for an MCP registry.
-Attributes:
-type (MCPRegistryType): The type of the registry.
-os (Literal["darwin", "linux", "windows"]): The operating system. It
-is automatically set to "darwin" for MacOS, "linux" for Linux, and
-"windows" for Windows.
-api_key (Optional[str]): API key for the registry.
+**Parameters:**
+
+- **type** (MCPRegistryType): The type of the registry.
+- **os** (`Literal["darwin", "linux", "windows"]`): The operating system. It is automatically set to "darwin" for MacOS, "linux" for Linux, and "windows" for Windows.
+- **api_key** (Optional[str]): API key for the registry.
<a id="camel.types.mcp_registries.BaseMCPRegistryConfig.get_config"></a>
diff --git a/docs/mintlify/reference/camel.utils.chunker.code_chunker.mdx b/docs/mintlify/reference/camel.utils.chunker.code_chunker.mdx
index 5310f9ee3..4a1916ea8 100644
--- a/docs/mintlify/reference/camel.utils.chunker.code_chunker.mdx
+++ b/docs/mintlify/reference/camel.utils.chunker.code_chunker.mdx
@@ -15,12 +15,11 @@ This class ensures that structured elements such as functions,
classes, and regions are not arbitrarily split across chunks.
It also handles oversized lines and Base64-encoded images.
-Attributes:
-chunk_size (int, optional): The maximum token size per chunk.
-(default: :obj:`8192`)
-remove_image: (bool, optional): If the chunker should skip the images.
-model_name (str, optional): The tokenizer model name used
-for token counting. (default: :obj:`"cl100k_base"`)
+**Parameters:**
+
+- **chunk_size** (int, optional): The maximum token size per chunk. (default: :obj:`8192`)
+- **remove_image**: (bool, optional): If the chunker should skip the images.
+- **model_name** (str, optional): The tokenizer model name used for token counting. (default: :obj:`"cl100k_base"`)
<a id="camel.utils.chunker.code_chunker.CodeChunker.__init__"></a>
diff --git a/docs/mintlify/reference/camel.utils.commons.mdx b/docs/mintlify/reference/camel.utils.commons.mdx
index 0f23559c0..5ae9582a2 100644
--- a/docs/mintlify/reference/camel.utils.commons.mdx
+++ b/docs/mintlify/reference/camel.utils.commons.mdx
@@ -608,7 +608,12 @@ later to maintain authenticated sessions without requiring manual login.
- **url** (str): The URL to navigate to for authentication (e.g., a login page).
- **wait_time** (int): The time in seconds to wait for the user to manually authenticate.
- **Usage**: 1. The function opens a browser window and navigates to the specified URL 2. User manually logs in during the wait_time wait period 3. Browser storage state (including auth cookies) is saved to the specified file 4. The saved state can be used in subsequent browser sessions to maintain authentication
-- **Note**: The wait_time sleep is intentional to give the user enough time to complete the manual authentication process before the storage state is captured.
+
+**Note:**
+
+The wait_time sleep is intentional to give the user enough time to
+complete the manual authentication process before the storage state
+is captured.
<a id="camel.utils.commons.run_async"></a>
diff --git a/docs/mintlify/reference/camel.utils.deduplication.mdx b/docs/mintlify/reference/camel.utils.deduplication.mdx
index c87a092e1..d296b5bf1 100644
--- a/docs/mintlify/reference/camel.utils.deduplication.mdx
+++ b/docs/mintlify/reference/camel.utils.deduplication.mdx
@@ -10,14 +10,12 @@ class DeduplicationResult(BaseModel):
The result of deduplication.
-Attributes:
-original_texts (List[str]): The original texts.
-unique_ids (List[int]): A list of ids that are unique (not duplicates).
-unique_embeddings_dict (Dict[int, List[float]]): A mapping from the
-index of each unique text to its embedding.
-duplicate_to_target_map (Dict[int, int]): A mapping from the index of
-the duplicate text to the index of the text it is considered a
-duplicate of.
+**Parameters:**
+
+- **original_texts** (List[str]): The original texts.
+- **unique_ids** (List[int]): A list of ids that are unique (not duplicates).
+- **unique_embeddings_dict** (Dict[int, List[float]]): A mapping from the index of each unique text to its embedding.
+- **duplicate_to_target_map** (Dict[int, int]): A mapping from the index of the duplicate text to the index of the text it is considered a duplicate of.
<a id="camel.utils.deduplication.deduplicate_internally"></a>
diff --git a/docs/mintlify/reference/camel.utils.langfuse.mdx b/docs/mintlify/reference/camel.utils.langfuse.mdx
index 6a0f1df24..11b232a8f 100644
--- a/docs/mintlify/reference/camel.utils.langfuse.mdx
+++ b/docs/mintlify/reference/camel.utils.langfuse.mdx
@@ -23,7 +23,11 @@ Configure Langfuse for CAMEL models.
- **host** (Optional[str]): Langfuse host URL. Can be set via LANGFUSE_HOST. (default: :obj:`https://cloud.langfuse.com`)
- **debug** (Optional[bool]): Enable debug mode. Can be set via LANGFUSE_DEBUG. (default: :obj:`None`)
- **enabled** (Optional[bool]): Enable/disable tracing. Can be set via LANGFUSE_ENABLED. (default: :obj:`None`)
-- **Note**: This function configures the native langfuse_context which works with @observe() decorators. Set enabled=False to disable all tracing.
+
+**Note:**
+
+This function configures the native langfuse_context which works with
+@observe() decorators. Set enabled=False to disable all tracing.
<a id="camel.utils.langfuse.is_langfuse_available"></a>
diff --git a/docs/mintlify/reference/camel.utils.mcp_client.mdx b/docs/mintlify/reference/camel.utils.mcp_client.mdx
index e2989266c..dfec0fcf3 100644
--- a/docs/mintlify/reference/camel.utils.mcp_client.mdx
+++ b/docs/mintlify/reference/camel.utils.mcp_client.mdx
@@ -70,6 +70,9 @@ connectionmanagement.
- **client_info** (Optional[types.Implementation], optional): Client implementation information to send to the server during initialization. (default: :obj:`None`)
- **timeout** (Optional[float], optional): Timeout for waiting for messages from the server in seconds. (default: :obj:`10.0`)
- **strict** (Optional[bool], optional): Strict mode for generating FunctionTool objects. (default: :obj:`False`)
+- **config** (ServerConfig): The server configuration object.
+- **client_info** (Optional[types.Implementation]): Client implementation information.
+- **read_timeout_seconds** (timedelta): Timeout for reading from the server.
<a id="camel.utils.mcp_client.MCPClient.__init__"></a>
@@ -182,7 +185,8 @@ def get_tools(self):
representing the available tools from the MCP server. Returns
an empty list if the client is not connected.
-Note:
+**Note:**
+
This method requires an active connection to the MCP server.
If the client is not connected, an empty list will be returned.