Skip to content

Commit bc6545a

Browse files
committed
Auto-update documentation after merge
1 parent 9a59aa5 commit bc6545a

File tree

4 files changed

+96
-3
lines changed

4 files changed

+96
-3
lines changed

docs/mintlify/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,8 @@
585585
"reference/camel.benchmarks.gaia",
586586
"reference/camel.benchmarks.nexus",
587587
"reference/camel.benchmarks.ragbench",
588-
"reference/camel.benchmarks.mock_website.app"
588+
"reference/camel.benchmarks.mock_website.app",
589+
"reference/camel.benchmarks.mock_website.mock_web"
589590
]
590591
},
591592
{

docs/mintlify/reference/camel.agents.chat_agent.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Class for managing conversations of CAMEL Chat Agents.
2020
- **tools** (Optional[List[Union[FunctionTool, Callable]]], optional): List of available :obj:`FunctionTool` or :obj:`Callable`. (default: :obj:`None`) external_tools (Optional[List[Union[FunctionTool, Callable, Dict[str, Any]]]], optional): List of external tools (:obj:`FunctionTool` or :obj:`Callable` or :obj:`Dict[str, Any]`) bind to one chat agent. When these tools are called, the agent will directly return the request instead of processing it. (default: :obj:`None`)
2121
- **response_terminators** (List[ResponseTerminator], optional): List of :obj:`ResponseTerminator` bind to one chat agent. (default: :obj:`None`)
2222
- **scheduling_strategy** (str): name of function that defines how to select the next model in ModelManager. (default: :str:`round_robin`)
23-
- **single_iteration** (bool): Whether to let the agent perform only one model calling at each step. (default: :obj:`False`)
23+
- **max_iteration** (Optional[int], optional): Maximum number of model calling iterations allowed per step. If `None` (default), there's no explicit limit. If `1`, it performs a single model call. If `N > 1`, it allows up to N model calls. (default: :obj:`None`)
2424
- **agent_id** (str, optional): The ID of the agent. If not provided, a random UUID will be generated. (default: :obj:`None`)
2525
- **stop_event** (Optional[threading.Event], optional): Event to signal termination of the agent's operation. When set, the agent will terminate its execution. (default: :obj:`None`)
2626

@@ -41,7 +41,7 @@ def __init__(
4141
external_tools: Optional[List[Union[FunctionTool, Callable, Dict[str, Any]]]] = None,
4242
response_terminators: Optional[List[ResponseTerminator]] = None,
4343
scheduling_strategy: str = 'round_robin',
44-
single_iteration: bool = False,
44+
max_iteration: Optional[int] = None,
4545
agent_id: Optional[str] = None,
4646
stop_event: Optional[threading.Event] = None
4747
):
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<a id="camel.benchmarks.mock_website.mock_web"></a>
2+
3+
<a id="camel.benchmarks.mock_website.mock_web.setup_dispatcher_logging"></a>
4+
5+
## setup_dispatcher_logging
6+
7+
```python
8+
def setup_dispatcher_logging():
9+
```
10+
11+
<a id="camel.benchmarks.mock_website.mock_web.download_website_assets"></a>
12+
13+
## download_website_assets
14+
15+
```python
16+
def download_website_assets(project_name: str):
17+
```
18+
19+
<a id="camel.benchmarks.mock_website.mock_web.enqueue_output"></a>
20+
21+
## enqueue_output
22+
23+
```python
24+
def enqueue_output(stream, queue):
25+
```
26+
27+
<a id="camel.benchmarks.mock_website.mock_web.run_project"></a>
28+
29+
## run_project
30+
31+
```python
32+
def run_project(project_name: str, port: int):
33+
```
34+
35+
<a id="camel.benchmarks.mock_website.mock_web.main"></a>
36+
37+
## main
38+
39+
```python
40+
def main():
41+
```
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<a id="camel.benchmarks.mock_website.shopping_mall.app"></a>
2+
3+
<a id="camel.benchmarks.mock_website.shopping_mall.app.load_products"></a>
4+
5+
## load_products
6+
7+
```python
8+
def load_products(file_path: str = 'products.json'):
9+
```
10+
11+
<a id="camel.benchmarks.mock_website.shopping_mall.app.setup_logging"></a>
12+
13+
## setup_logging
14+
15+
```python
16+
def setup_logging(application):
17+
```
18+
19+
<a id="camel.benchmarks.mock_website.shopping_mall.app.check_task_completion"></a>
20+
21+
## check_task_completion
22+
23+
```python
24+
def check_task_completion(current_cart_raw, ground_truth_spec):
25+
```
26+
27+
<a id="camel.benchmarks.mock_website.shopping_mall.app._trigger_task_completion_check"></a>
28+
29+
## _trigger_task_completion_check
30+
31+
```python
32+
def _trigger_task_completion_check():
33+
```
34+
35+
Checks for task completion if in task mode and not already signaled.
36+
37+
<a id="camel.benchmarks.mock_website.shopping_mall.app.create_app"></a>
38+
39+
## create_app
40+
41+
```python
42+
def create_app():
43+
```
44+
45+
<a id="camel.benchmarks.mock_website.shopping_mall.app.main"></a>
46+
47+
## main
48+
49+
```python
50+
def main():
51+
```

0 commit comments

Comments
 (0)