🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
<a id="camel.models.anthropic_model"></a>
<a id="camel.models.anthropic_model.strip_trailing_whitespace_from_messages"></a>
## strip_trailing_whitespace_from_messages
```python
def strip_trailing_whitespace_from_messages(messages: List[OpenAIMessage]):
```
Strip trailing whitespace from all message contents in a list of
messages. This is necessary because the Anthropic API doesn't allow
trailing whitespace in message content.
**Parameters:**
- **messages** (List[OpenAIMessage]): List of messages to process
**Returns:**
List[OpenAIMessage]: The processed messages with trailing whitespace
removed
<a id="camel.models.anthropic_model.AnthropicModel"></a>
## AnthropicModel
```python
class AnthropicModel(BaseModelBackend):
```
Anthropic API in a unified BaseModelBackend interface.
**Parameters:**
- **model_type** (Union[ModelType, str]): Model for which a backend is created, one of CLAUDE_* series.
- **model_config_dict** (Optional[Dict[str, Any]], optional): A dictionary that will be fed into Anthropic API. If :obj:`None`, :obj:`AnthropicConfig().as_dict()` will be used. (default: :obj:`None`)
- **api_key** (Optional[str], optional): The API key for authenticating with the Anthropic service. (default: :obj:`None`)
- **url** (Optional[str], optional): The url to the Anthropic service. (default: :obj:`None`)
- **token_counter** (Optional[BaseTokenCounter], optional): Token counter to use for the model. If not provided, :obj:`AnthropicTokenCounter` will be used. (default: :obj:`None`)
- **timeout** (Optional[float], optional): The timeout value in seconds for API calls. If not provided, will fall back to the MODEL_TIMEOUT environment variable or default to 180 seconds. (default: :obj:`None`)
- **max_retries** (int, optional): Maximum number of retries for API calls. (default: :obj:`3`)
- **client** (Optional[Any], optional): A custom synchronous Anthropic client instance. If provided, this client will be used instead of creating a new one. (default: :obj:`None`)
- **async_client** (Optional[Any], optional): A custom asynchronous Anthropic client instance. If provided, this client will be used instead of creating a new one. (default: :obj:`None`) **kwargs (Any): Additional arguments to pass to the client initialization.
<a id="camel.models.anthropic_model.AnthropicModel.__init__"></a>
### __init__
```python
def __init__(
self,
model_type: Union[ModelType, str],
model_config_dict: Optional[Dict[str, Any]] = None,
api_key: Optional[str] = None,
url: Optional[str] = None,
token_counter: Optional[BaseTokenCounter] = None,
timeout: Optional[float] = None,
max_retries: int = 3,
client: Optional[Any] = None,
async_client: Optional[Any] = None,
**kwargs: Any
):
```
<a id="camel.models.anthropic_model.AnthropicModel.token_counter"></a>
### token_counter
```python
def token_counter(self):
```
**Returns:**
AnthropicTokenCounter: The token counter following the model's
tokenization style.
<a id="camel.models.anthropic_model.AnthropicModel.supports_tool_response_format"></a>
### supports_tool_response_format
```python
def supports_tool_response_format(self):
```
Anthropic JSON outputs are independent from strict tool use.
<a id="camel.models.anthropic_model.AnthropicModel._get_block_value"></a>
### _get_block_value
```python
def _get_block_value(block: Any, key: str, default: Any = None):
```
Read a content block value from a dict or SDK object.
<a id="camel.models.anthropic_model.AnthropicModel._content_block_to_dict"></a>
### _content_block_to_dict
```python
def _content_block_to_dict(cls, block: Any):
```
Convert an Anthropic content block to a plain dictionary.
<a id="camel.models.anthropic_model.AnthropicModel._extract_thinking_blocks_from_message"></a>
### _extract_thinking_blocks_from_message
```python
def _extract_thinking_blocks_from_message(cls, message: OpenAIMessage):
```
Extract raw Anthropic thinking blocks from an OpenAI message.
<a id="camel.models.anthropic_model.AnthropicModel._get_tool_call_id"></a>
### _get_tool_call_id
```python
def _get_tool_call_id(tool_call: Any):
```
Extract an OpenAI-style tool call ID from a dict or SDK object.
<a id="camel.models.anthropic_model.AnthropicModel._get_tool_call_extra_content"></a>
### _get_tool_call_extra_content
```python
def _get_tool_call_extra_content(cls, tool_call: Any):
```
Extract non-standard extra content from a tool call.
<a id="camel.models.anthropic_model.AnthropicModel._extract_thinking_blocks_from_tool_call"></a>
### _extract_thinking_blocks_from_tool_call
```python
def _extract_thinking_blocks_from_tool_call(cls, tool_call: Any):
```
Extract raw Anthropic thinking blocks from tool extra content.
<a id="camel.models.anthropic_model.AnthropicModel._get_cached_thinking_blocks_for_tool_calls"></a>
### _get_cached_thinking_blocks_for_tool_calls
```python
def _get_cached_thinking_blocks_for_tool_calls(self, tool_calls: List[Any]):
```
Return cached thinking blocks for the first matching tool call.
<a id="camel.models.anthropic_model.AnthropicModel._cache_thinking_blocks_for_tool_calls"></a>
### _cache_thinking_blocks_for_tool_calls
```python
def _cache_thinking_blocks_for_tool_calls(
self,
thinking_blocks: List[Dict[str, Any]],
tool_calls: List[Any]
):
```
Cache raw thinking blocks for Anthropic tool-use continuation.
<a id="camel.models.anthropic_model.AnthropicModel._is_thinking_enabled"></a>
### _is_thinking_enabled
```python
def _is_thinking_enabled(thinking: Any):
```
Return whether an Anthropic thinking config enables thinking.
<a id="camel.models.anthropic_model.AnthropicModel._validate_tool_choice_for_thinking"></a>
### _validate_tool_choice_for_thinking
```python
def _validate_tool_choice_for_thinking(self, thinking: Any, tool_choice: Any):
```
Validate Anthropic's tool-choice limitation for thinking.
<a id="camel.models.anthropic_model.AnthropicModel._build_request_output_config"></a>
### _build_request_output_config
```python
def _build_request_output_config(
self,
response_format: Optional[Type[BaseModel]],
extra_body: Dict[str, Any]
):
```
Build Anthropic output_config from config and response_format.
<a id="camel.models.anthropic_model.AnthropicModel._convert_openai_to_anthropic_messages"></a>
### _convert_openai_to_anthropic_messages
```python
def _convert_openai_to_anthropic_messages(self, messages: List[OpenAIMessage]):
```
Convert OpenAI format messages to Anthropic format.
**Parameters:**
- **messages** (List[OpenAIMessage]): Messages in OpenAI format.
**Returns:**
tuple[Optional[str], List[Dict[str, Any]]]: A tuple containing
the system message (if any) and the list of messages in
Anthropic format.
<a id="camel.models.anthropic_model.AnthropicModel._extract_usage"></a>
### _extract_usage
```python
def _extract_usage(usage_obj: Any):
```
Extract usage information from an Anthropic usage object.
<a id="camel.models.anthropic_model.AnthropicModel._build_output_config"></a>
### _build_output_config
```python
def _build_output_config(self, response_format: Type[BaseModel]):
```
Build Anthropic output_config.format from a Pydantic model.
<a id="camel.models.anthropic_model.AnthropicModel._normalize_type_list_for_anthropic_schema"></a>
### _normalize_type_list_for_anthropic_schema
```python
def _normalize_type_list_for_anthropic_schema(schema: Any):
```
Convert JSON Schema type lists to Anthropic SDK-supported anyOf.
<a id="camel.models.anthropic_model.AnthropicModel._convert_anthropic_to_openai_response"></a>
### _convert_anthropic_to_openai_response
```python
def _convert_anthropic_to_openai_response(self, response: Any, model: str):
```
Convert Anthropic API response to OpenAI ChatCompletion format.
**Parameters:**
- **response**: The response object from Anthropic API.
- **model** (str): The model name.
**Returns:**
ChatCompletion: Response in OpenAI format.
<a id="camel.models.anthropic_model.AnthropicModel._convert_anthropic_stream_to_openai_chunk"></a>
### _convert_anthropic_stream_to_openai_chunk
```python
def _convert_anthropic_stream_to_openai_chunk(
self,
chunk: Any,
model: str,
tool_call_index: Dict[str, int],
finish_reason_sent: bool = False,
thinking_state: Optional[Dict[str, Any]] = None
):
```
Convert Anthropic streaming chunk to OpenAI ChatCompletionChunk.
**Parameters:**
- **chunk**: The streaming chunk from Anthropic API.
- **model** (str): The model name.
- **tool_call_index** (Dict[str, int]): A mutable dict tracking tool call indices by their IDs, used to maintain consistent indexing across streaming chunks.
**Returns:**
ChatCompletionChunk: Chunk in OpenAI format.
<a id="camel.models.anthropic_model.AnthropicModel._convert_openai_tools_to_anthropic"></a>
### _convert_openai_tools_to_anthropic
```python
def _convert_openai_tools_to_anthropic(self, tools: Optional[List[Dict[str, Any]]]):
```
Convert OpenAI tools format to Anthropic tools format.
**Parameters:**
- **tools** (Optional[List[Dict[str, Any]]]): Tools in OpenAI format.
**Returns:**
Optional[List[Dict[str, Any]]]: Tools in Anthropic format.
<a id="camel.models.anthropic_model.AnthropicModel._get_strict_tools_limit_reason"></a>
### _get_strict_tools_limit_reason
```python
def _get_strict_tools_limit_reason(tools: List[Dict[str, Any]]):
```
Return why Anthropic strict tool limits are exceeded, if any.
Anthropic compiles all strict tool schemas in a request into a single
grammar. Its documented request-wide limits apply to the number of
strict tools, optional parameters, and parameters using union types.
<a id="camel.models.anthropic_model.AnthropicModel._run"></a>
### _run
```python
def _run(
self,
messages: List[OpenAIMessage],
response_format: Optional[Type[BaseModel]] = None,
tools: Optional[List[Dict[str, Any]]] = None
):
```
Runs inference of Anthropic chat completion.
**Parameters:**
- **messages** (List[OpenAIMessage]): Message list with the chat history in OpenAI API format.
- **response_format** (Optional[Type[BaseModel]]): The format of the response.
- **tools** (Optional[List[Dict[str, Any]]]): The schema of the tools to use for the request.
**Returns:**
Union[ChatCompletion, Stream[ChatCompletionChunk]]:
`ChatCompletion` in the non-stream mode, or
`Stream[ChatCompletionChunk]` in the stream mode.
<a id="camel.models.anthropic_model.AnthropicModel._wrap_anthropic_stream"></a>
### _wrap_anthropic_stream
```python
def _wrap_anthropic_stream(self, stream: Any, model: str):
```
Wrap Anthropic streaming response to OpenAI Stream format.
**Parameters:**
- **stream**: The streaming response from Anthropic API.
- **model** (str): The model name.
**Returns:**
Stream[ChatCompletionChunk]: Stream in OpenAI format.
<a id="camel.models.anthropic_model.AnthropicModel._wrap_anthropic_async_stream"></a>
### _wrap_anthropic_async_stream
```python
def _wrap_anthropic_async_stream(self, stream: Any, model: str):
```
Wrap Anthropic async streaming response to OpenAI AsyncStream.
**Parameters:**
- **stream**: The async streaming response from Anthropic API.
- **model** (str): The model name.
**Returns:**
AsyncStream[ChatCompletionChunk]: AsyncStream in OpenAI format.
<a id="camel.models.anthropic_model.AnthropicModel.stream"></a>
### stream
```python
def stream(self):
```
**Returns:**
bool: Whether the model is in stream mode.