Skip to content

Commit b8cc4cc

Browse files
author
camel-docs-bot
committed
Auto-update documentation after merge [skip ci]
1 parent 6bc92cd commit b8cc4cc

33 files changed

+1986
-109
lines changed

docs/mintlify/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -766,4 +766,4 @@
766766
"measurementId": "G-XV5VXFS2RG"
767767
}
768768
}
769-
}
769+
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1453,7 +1453,7 @@ intermediate responses as they are generated.
14531453

14541454
- **input_message** (Union[BaseMessage, str]): The input message for the agent.
14551455
- **response_format** (Optional[Type[BaseModel]], optional): A Pydantic model defining the expected structure of the response.
1456-
- **Yields**:
1456+
- **Yields**:
14571457
- **ChatAgentResponse**: Intermediate responses containing partial content, tool calls, and other information as they become available.
14581458

14591459
<a id="camel.agents.chat_agent.ChatAgent._get_token_count"></a>

docs/mintlify/reference/camel.loaders.firecrawl_reader.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Firecrawl allows you to turn entire websites into LLM-ready markdown.
1414

1515
- **api_key** (Optional[str]): API key for authenticating with the Firecrawl API.
1616
- **api_url** (Optional[str]): Base URL for the Firecrawl API.
17-
- **References**:
17+
- **References**:
1818
- **https**: //docs.firecrawl.dev/introduction
1919

2020
<a id="camel.loaders.firecrawl_reader.Firecrawl.__init__"></a>

docs/mintlify/reference/camel.loaders.jina_url_reader.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ replace the UnstructuredIO URL Reader in the pipeline.
1818
- **return_format** (ReturnFormat, optional): The level of detail of the returned content, which is optimized for LLMs. For now screenshots are not supported. Defaults to ReturnFormat.DEFAULT.
1919
- **json_response** (bool, optional): Whether to return the response in JSON format. Defaults to False.
2020
- **timeout** (int, optional): The maximum time in seconds to wait for the page to be rendered. Defaults to 30. **kwargs (Any): Additional keyword arguments, including proxies, cookies, etc. It should align with the HTTP Header field and value pairs listed in the reference.
21-
- **References**:
21+
- **References**:
2222
- **https**: //jina.ai/reader
2323

2424
<a id="camel.loaders.jina_url_reader.JinaURLReader.__init__"></a>

docs/mintlify/reference/camel.loaders.scrapegraph_reader.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ searching.
1414
**Parameters:**
1515

1616
- **api_key** (Optional[str]): API key for authenticating with the ScrapeGraphAI API.
17-
- **References**:
17+
- **References**:
1818
- **https**: //scrapegraph.ai/
1919

2020
<a id="camel.loaders.scrapegraph_reader.ScrapeGraphAI.__init__"></a>

docs/mintlify/reference/camel.models.aws_bedrock_model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ AWS Bedrock API in a unified OpenAICompatibleModel interface.
2020
- **token_counter** (BaseTokenCounter, optional): Token counter to use for the model. If not provided, :obj:`OpenAITokenCounter( ModelType.GPT_4O_MINI)` will be used. (default: :obj:`None`)
2121
- **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`)
2222
- **max_retries** (int, optional): Maximum number of retries for API calls. (default: :obj:`3`) **kwargs (Any): Additional arguments to pass to the client initialization.
23-
- **References**:
23+
- **References**:
2424
- **https**: //docs.aws.amazon.com/bedrock/latest/APIReference/welcome.html
2525

2626
<a id="camel.models.aws_bedrock_model.AWSBedrockModel.__init__"></a>

docs/mintlify/reference/camel.models.azure_openai_model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Azure OpenAI API in a unified BaseModelBackend interface.
2525
- **client** (Optional[Any], optional): A custom synchronous AzureOpenAI client instance. If provided, this client will be used instead of creating a new one. Useful for RL frameworks like AReaL or rLLM that provide Azure OpenAI-compatible clients. The client should implement the AzureOpenAI client interface with `.chat.completions.create()` and `.beta.chat.completions.parse()` methods. (default: :obj:`None`)
2626
- **async_client** (Optional[Any], optional): A custom asynchronous AzureOpenAI client instance. If provided, this client will be used instead of creating a new one. The client should implement the AsyncAzureOpenAI client interface. (default: :obj:`None`)
2727
- **azure_deployment_name** (Optional[str], optional): **Deprecated**. Use `model_type` parameter instead. This parameter is kept for backward compatibility and will be removed in a future version. (default: :obj:`None`) **kwargs (Any): Additional arguments to pass to the client initialization. Ignored if custom clients are provided.
28-
- **References**:
28+
- **References**:
2929
- **https**: //learn.microsoft.com/en-us/azure/ai-services/openai/
3030

3131
<a id="camel.models.azure_openai_model.AzureOpenAIModel.__init__"></a>

docs/mintlify/reference/camel.models.deepseek_model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ DeepSeek API in a unified OpenAICompatibleModel interface.
1919
- **token_counter** (Optional[BaseTokenCounter], optional): Token counter to use for the model. If not provided, :obj:`OpenAITokenCounter` will be used. (default: :obj:`None`)
2020
- **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`)
2121
- **max_retries** (int, optional): Maximum number of retries for API calls. (default: :obj:`3`) **kwargs (Any): Additional arguments to pass to the client initialization.
22-
- **References**:
22+
- **References**:
2323
- **https**: //api-docs.deepseek.com/
2424

2525
<a id="camel.models.deepseek_model.DeepSeekModel.__init__"></a>

docs/mintlify/reference/camel.models.ollama_model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Ollama service interface.
2020
- **token_counter** (Optional[BaseTokenCounter], optional): Token counter to use for the model. If not provided, :obj:`OpenAITokenCounter( ModelType.GPT_4O_MINI)` will be used. (default: :obj:`None`)
2121
- **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`)
2222
- **max_retries** (int, optional): Maximum number of retries for API calls. (default: :obj:`3`) **kwargs (Any): Additional arguments to pass to the client initialization.
23-
- **References**:
23+
- **References**:
2424
- **https**: //github.com/ollama/ollama/blob/main/docs/openai.md
2525

2626
<a id="camel.models.ollama_model.OllamaModel.__init__"></a>

docs/mintlify/reference/camel.models.vllm_model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ vLLM service interface.
1919
- **token_counter** (Optional[BaseTokenCounter], optional): Token counter to use for the model. If not provided, :obj:`OpenAITokenCounter( ModelType.GPT_4O_MINI)` will be used. (default: :obj:`None`)
2020
- **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`)
2121
- **max_retries** (int, optional): Maximum number of retries for API calls. (default: :obj:`3`) **kwargs (Any): Additional arguments to pass to the client initialization.
22-
- **References**:
22+
- **References**:
2323
- **https**: //docs.vllm.ai/en/latest/serving/openai_compatible_server.html
2424

2525
<a id="camel.models.vllm_model.VLLMModel.__init__"></a>

0 commit comments

Comments
 (0)