Class swarmauri_standard.llms.AnthropicModel.AnthropicModel

swarmauri_standard.llms.AnthropicModel.AnthropicModel

AnthropicModel(**data)

Bases: LLMBase

A class representing an integration with the Anthropic API to interact with the Claude model series.

ATTRIBUTE	DESCRIPTION
api_key	The API key for accessing the Anthropic API. TYPE: str
allowed_models	List of models that can be used with this class. TYPE: List[str]
name	The default model name. TYPE: str
type	Specifies the type of the model as "AnthropicModel". TYPE: Literal

Link to Allowed Models: https://docs.anthropic.com/en/docs/about-claude/models Link to API KEY: https://console.anthropic.com/settings/keys

Source code in swarmauri_standard/llms/AnthropicModel.py

def __init__(self, **data):
    super().__init__(**data)
    headers = {
        "Content-Type": "application/json",
        "x-api-key": self.api_key.get_secret_value(),
        "anthropic-version": "2023-06-01",
    }
    self._client = httpx.Client(
        headers=headers, base_url=self._BASE_URL, timeout=self.timeout
    )
    self._async_client = httpx.AsyncClient(
        headers=headers, base_url=self._BASE_URL, timeout=self.timeout
    )

api_key instance-attribute

api_key

allowed_models class-attribute instance-attribute

allowed_models = [
    "claude-opus-4-1",
    "claude-opus-4-0",
    "claude-sonnet-4-0",
    "claude-3-7-sonnet-latest",
    "claude-3-5-haiku-latest",
    "claude-3-5-haiku-20241022",
    "claude-3-7-sonnet-20250219",
]

name class-attribute instance-attribute

name = 'claude-opus-4-1'

type class-attribute instance-attribute

type = 'AnthropicModel'

timeout class-attribute instance-attribute

timeout = 600.0

model_config class-attribute instance-attribute

model_config = ConfigDict(
    extra="allow", arbitrary_types_allowed=True
)

id class-attribute instance-attribute

id = Field(default_factory=generate_id)

members class-attribute instance-attribute

members = None

owners class-attribute instance-attribute

owners = None

host class-attribute instance-attribute

host = None

default_logger class-attribute

default_logger = None

logger class-attribute instance-attribute

logger = None

resource class-attribute instance-attribute

resource = Field(default=LLM.value, frozen=True)

version class-attribute instance-attribute

version = '0.1.0'

include_usage class-attribute instance-attribute

include_usage = True

BASE_URL class-attribute instance-attribute

BASE_URL = None

predict

predict(conversation, temperature=0.7, max_tokens=256)

Sends a prediction request to the Anthropic API and processes the response.

PARAMETER	DESCRIPTION
conversation	The conversation object containing the history of messages. TYPE: Conversation
temperature	The temperature setting for controlling response randomness. TYPE: float DEFAULT: 0.7
max_tokens	The maximum number of tokens for the generated response. TYPE: int DEFAULT: 256

RETURNS	DESCRIPTION
Conversation	The updated conversation object with the generated response added. TYPE: Conversation

Source code in swarmauri_standard/llms/AnthropicModel.py

@retry_on_status_codes((429, 529), max_retries=1)
def predict(
    self, conversation: Conversation, temperature=0.7, max_tokens=256
) -> Conversation:
    """
    Sends a prediction request to the Anthropic API and processes the response.

    Args:
        conversation (Conversation): The conversation object containing the history of messages.
        temperature (float, optional): The temperature setting for controlling response randomness.
        max_tokens (int, optional): The maximum number of tokens for the generated response.

    Returns:
        Conversation: The updated conversation object with the generated response added.
    """
    system_context = self._get_system_context(conversation.history)
    formatted_messages = self._format_messages(conversation.history)

    payload = {
        "model": self.name,
        "messages": formatted_messages,
        "temperature": temperature,
        "max_tokens": max_tokens,
    }

    if system_context:
        payload["system"] = system_context

    with DurationManager() as prompt_timer:
        response = self._client.post("/messages", json=payload)
        response.raise_for_status()
        response_data = response.json()

    with DurationManager() as completion_timer:
        message_content = response_data["content"][0]["text"]

    usage_data = response_data["usage"]

    if self.include_usage and usage_data:
        usage = self._prepare_usage_data(
            usage_data, prompt_timer.duration, completion_timer.duration
        )
        conversation.add_message(AgentMessage(content=message_content, usage=usage))
    else:
        conversation.add_message(AgentMessage(content=message_content))

    return conversation

stream

stream(conversation, temperature=0.7, max_tokens=256)

Streams the response from the model in real-time.

PARAMETER	DESCRIPTION
conversation	The conversation history and context. TYPE: Conversation
temperature	Sampling temperature for the model. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens for the response. TYPE: int DEFAULT: 256

YIELDS	DESCRIPTION
str	Incremental parts of the model's response as they are received. TYPE:: str

Source code in swarmauri_standard/llms/AnthropicModel.py

@retry_on_status_codes((429, 529), max_retries=1)
def stream(
    self, conversation: Conversation, temperature=0.7, max_tokens=256
) -> Iterator[str]:
    """
    Streams the response from the model in real-time.

    Args:
        conversation (Conversation): The conversation history and context.
        temperature (float, optional): Sampling temperature for the model.
        max_tokens (int, optional): Maximum number of tokens for the response.

    Yields:
        str: Incremental parts of the model's response as they are received.
    """
    system_context = self._get_system_context(conversation.history)
    formatted_messages = self._format_messages(conversation.history)

    payload = {
        "model": self.name,
        "messages": formatted_messages,
        "temperature": temperature,
        "max_tokens": max_tokens,
        "stream": True,
    }

    if system_context:
        payload["system"] = system_context

    message_content = ""
    usage_data = {"input_tokens": 0, "output_tokens": 0}

    with DurationManager() as prompt_timer:
        with self._client.stream("POST", "/messages", json=payload) as response:
            response.raise_for_status()
            with DurationManager() as completion_timer:
                for line in response.iter_lines():
                    if line:
                        try:
                            # Handle the case where line might be bytes or str
                            line_text = (
                                line
                                if isinstance(line, str)
                                else line.decode("utf-8")
                            )
                            if line_text.startswith("data: "):
                                line_text = line_text.removeprefix("data: ")

                            if not line_text or line_text == "[DONE]":
                                continue

                            event = json.loads(line_text)
                            if event["type"] == "message_start":
                                usage_data["input_tokens"] = event["message"][
                                    "usage"
                                ]["input_tokens"]
                            elif event["type"] == "content_block_start":
                                continue
                            elif event["type"] == "content_block_delta":
                                delta = event["delta"]["text"]
                                message_content += delta
                                yield delta
                            elif event["type"] == "message_delta":
                                if "usage" in event:
                                    usage_data["output_tokens"] = event["usage"][
                                        "output_tokens"
                                    ]
                            elif event["type"] == "message_stop":
                                if (
                                    "message" in event
                                    and "usage" in event["message"]
                                ):
                                    usage_data = event["message"]["usage"]
                        except (json.JSONDecodeError, KeyError):
                            continue

    if self.include_usage:
        usage = self._prepare_usage_data(
            usage_data, prompt_timer.duration, completion_timer.duration
        )
        conversation.add_message(AgentMessage(content=message_content, usage=usage))
    else:
        conversation.add_message(AgentMessage(content=message_content))

apredict async

apredict(conversation, temperature=0.7, max_tokens=256)

Asynchronously sends a request to the model for generating a prediction.

PARAMETER	DESCRIPTION
conversation	The conversation history and context. TYPE: Conversation
temperature	Sampling temperature for the model. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens for the response. TYPE: int DEFAULT: 256

RETURNS	DESCRIPTION
Conversation	The updated conversation including the model's response. TYPE: Conversation

Source code in swarmauri_standard/llms/AnthropicModel.py

@retry_on_status_codes((429, 529), max_retries=1)
async def apredict(
    self, conversation: Conversation, temperature=0.7, max_tokens=256
) -> Conversation:
    """
    Asynchronously sends a request to the model for generating a prediction.

    Args:
        conversation (Conversation): The conversation history and context.
        temperature (float, optional): Sampling temperature for the model.
        max_tokens (int, optional): Maximum number of tokens for the response.

    Returns:
        Conversation: The updated conversation including the model's response.
    """
    system_context = self._get_system_context(conversation.history)
    formatted_messages = self._format_messages(conversation.history)

    payload = {
        "model": self.name,
        "messages": formatted_messages,
        "temperature": temperature,
        "max_tokens": max_tokens,
    }

    if system_context:
        payload["system"] = system_context

    with DurationManager() as prompt_timer:
        response = await self._async_client.post("/messages", json=payload)
        response.raise_for_status()
        response_data = response.json()

    with DurationManager() as completion_timer:
        message_content = response_data["content"][0]["text"]

    usage_data = response_data["usage"]

    if self.include_usage:
        usage = self._prepare_usage_data(
            usage_data, prompt_timer.duration, completion_timer.duration
        )
        conversation.add_message(AgentMessage(content=message_content, usage=usage))
    else:
        conversation.add_message(AgentMessage(content=message_content))

    return conversation

astream async

astream(conversation, temperature=0.7, max_tokens=256)

Asynchronously streams the response from the model in real-time.

PARAMETER	DESCRIPTION
conversation	The conversation history and context. TYPE: Conversation
temperature	Sampling temperature for the model. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens for the response. TYPE: int DEFAULT: 256

YIELDS	DESCRIPTION
str	Incremental parts of the model's response as they are received. TYPE:: AsyncIterator[str]

Source code in swarmauri_standard/llms/AnthropicModel.py

@retry_on_status_codes((429, 529), max_retries=1)
async def astream(
    self, conversation: Conversation, temperature=0.7, max_tokens=256
) -> AsyncIterator[str]:
    """
    Asynchronously streams the response from the model in real-time.

    Args:
        conversation (Conversation): The conversation history and context.
        temperature (float, optional): Sampling temperature for the model.
        max_tokens (int, optional): Maximum number of tokens for the response.

    Yields:
        str: Incremental parts of the model's response as they are received.
    """
    system_context = self._get_system_context(conversation.history)
    formatted_messages = self._format_messages(conversation.history)

    payload = {
        "model": self.name,
        "messages": formatted_messages,
        "temperature": temperature,
        "max_tokens": max_tokens,
        "stream": True,
    }

    if system_context:
        payload["system"] = system_context

    message_content = ""
    usage_data = {"input_tokens": 0, "output_tokens": 0}

    with DurationManager() as prompt_timer:
        async with self._async_client.stream(
            "POST", "/messages", json=payload
        ) as response:
            response.raise_for_status()
            with DurationManager() as completion_timer:
                async for line in response.aiter_lines():
                    if line:
                        try:
                            # Handle the case where line might be bytes or str
                            line_text = (
                                line
                                if isinstance(line, str)
                                else line.decode("utf-8")
                            )
                            if line_text.startswith("data: "):
                                line_text = line_text.removeprefix("data: ")

                            if not line_text or line_text == "[DONE]":
                                continue

                            event = json.loads(line_text)
                            if event["type"] == "message_start":
                                usage_data["input_tokens"] = event["message"][
                                    "usage"
                                ]["input_tokens"]
                            elif event["type"] == "content_block_start":
                                continue
                            elif event["type"] == "content_block_delta":
                                delta = event["delta"]["text"]
                                message_content += delta
                                yield delta
                            elif event["type"] == "message_delta":
                                if "usage" in event:
                                    usage_data["output_tokens"] = event["usage"][
                                        "output_tokens"
                                    ]
                            elif event["type"] == "message_stop":
                                if (
                                    "message" in event
                                    and "usage" in event["message"]
                                ):
                                    usage_data = event["message"]["usage"]
                        except (json.JSONDecodeError, KeyError):
                            continue

    if self.include_usage:
        usage = self._prepare_usage_data(
            usage_data, prompt_timer.duration, completion_timer.duration
        )
        conversation.add_message(AgentMessage(content=message_content, usage=usage))
    else:
        conversation.add_message(AgentMessage(content=message_content))

batch

batch(conversations, temperature=0.7, max_tokens=256)

Processes multiple conversations synchronously.

PARAMETER	DESCRIPTION
conversations	List of conversation objects. TYPE: List[Conversation]
temperature	Sampling temperature for the model. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens for the response. TYPE: int DEFAULT: 256

RETURNS	DESCRIPTION
List	List[Conversation]: A list of updated conversations including the model's responses.

Source code in swarmauri_standard/llms/AnthropicModel.py

def batch(
    self, conversations: List[Conversation], temperature=0.7, max_tokens=256
) -> List:
    """
    Processes multiple conversations synchronously.

    Args:
        conversations (List[Conversation]): List of conversation objects.
        temperature (float, optional): Sampling temperature for the model.
        max_tokens (int, optional): Maximum number of tokens for the response.

    Returns:
        List[Conversation]: A list of updated conversations including the model's responses.
    """
    return [
        self.predict(conv, temperature=temperature, max_tokens=max_tokens)
        for conv in conversations
    ]

abatch async

abatch(
    conversations,
    temperature=0.7,
    max_tokens=256,
    max_concurrent=5,
)

Processes multiple conversations asynchronously with controlled concurrency.

PARAMETER	DESCRIPTION
conversations	List of conversation objects. TYPE: List[Conversation]
temperature	Sampling temperature for the model. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens for the response. TYPE: int DEFAULT: 256
max_concurrent	Maximum number of concurrent tasks. TYPE: int DEFAULT: 5

RETURNS	DESCRIPTION
List	List[Conversation]: A list of updated conversations including the model's responses.

Source code in swarmauri_standard/llms/AnthropicModel.py

async def abatch(
    self,
    conversations: List[Conversation],
    temperature=0.7,
    max_tokens=256,
    max_concurrent=5,
) -> List:
    """
    Processes multiple conversations asynchronously with controlled concurrency.

    Args:
        conversations (List[Conversation]): List of conversation objects.
        temperature (float, optional): Sampling temperature for the model.
        max_tokens (int, optional): Maximum number of tokens for the response.
        max_concurrent (int, optional): Maximum number of concurrent tasks.

    Returns:
        List[Conversation]: A list of updated conversations including the model's responses.
    """
    semaphore = asyncio.Semaphore(max_concurrent)

    async def process_conversation(conv):
        async with semaphore:
            return await self.apredict(
                conv, temperature=temperature, max_tokens=max_tokens
            )

    tasks = [process_conversation(conv) for conv in conversations]
    return await asyncio.gather(*tasks)

get_allowed_models

get_allowed_models()

Queries the Anthropic API to retrieve the list of allowed models.

RETURNS	DESCRIPTION
List[str]	List[str]: A list of allowed model names.

Source code in swarmauri_standard/llms/AnthropicModel.py

def get_allowed_models(self) -> List[str]:
    """
    Queries the Anthropic API to retrieve the list of allowed models.

    Returns:
        List[str]: A list of allowed model names.
    """
    response = self._client.get("/models")
    response.raise_for_status()
    models_data = response.json()
    return [model["id"] for model in models_data["data"]]

register_model classmethod

register_model()

Decorator to register a base model in the unified registry.

RETURNS	DESCRIPTION
Callable	A decorator function that registers the model class. TYPE: Callable[[Type[BaseModel]], Type[BaseModel]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_model(cls) -> Callable[[Type[BaseModel]], Type[BaseModel]]:
    """
    Decorator to register a base model in the unified registry.

    Returns:
        Callable: A decorator function that registers the model class.
    """

    def decorator(model_cls: Type[BaseModel]):
        """Register ``model_cls`` as a base model."""
        model_name = model_cls.__name__
        if model_name in cls._registry:
            glogger.warning(
                "Model '%s' is already registered; skipping duplicate.", model_name
            )
            return model_cls

        cls._registry[model_name] = {"model_cls": model_cls, "subtypes": {}}
        glogger.debug("Registered base model '%s'.", model_name)
        DynamicBase._recreate_models()
        return model_cls

    return decorator

register_type classmethod

register_type(resource_type=None, type_name=None)

Decorator to register a subtype under one or more base models in the unified registry.

PARAMETER	DESCRIPTION
resource_type	The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used. TYPE: Optional[Union[Type[T], List[Type[T]]]] DEFAULT: None
type_name	An optional custom type name for the subtype. TYPE: Optional[str] DEFAULT: None

RETURNS	DESCRIPTION
Callable	A decorator function that registers the subtype. TYPE: Callable[[Type[DynamicBase]], Type[DynamicBase]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_type(
    cls,
    resource_type: Optional[Union[Type[T], List[Type[T]]]] = None,
    type_name: Optional[str] = None,
) -> Callable[[Type["DynamicBase"]], Type["DynamicBase"]]:
    """
    Decorator to register a subtype under one or more base models in the unified registry.

    Parameters:
        resource_type (Optional[Union[Type[T], List[Type[T]]]]):
            The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase)
            are used.
        type_name (Optional[str]): An optional custom type name for the subtype.

    Returns:
        Callable: A decorator function that registers the subtype.
    """

    def decorator(subclass: Type["DynamicBase"]):
        """Register ``subclass`` as a subtype."""
        if resource_type is None:
            resource_types = [
                base for base in subclass.__bases__ if base is not cls
            ]
        elif not isinstance(resource_type, list):
            resource_types = [resource_type]
        else:
            resource_types = resource_type

        for rt in resource_types:
            if not issubclass(subclass, rt):
                raise TypeError(
                    f"'{subclass.__name__}' must be a subclass of '{rt.__name__}'."
                )
            final_type_name = type_name or getattr(
                subclass, "_type", subclass.__name__
            )
            base_model_name = rt.__name__

            if base_model_name not in cls._registry:
                cls._registry[base_model_name] = {"model_cls": rt, "subtypes": {}}
                glogger.debug(
                    "Created new registry entry for base model '%s'.",
                    base_model_name,
                )

            subtypes_dict = cls._registry[base_model_name]["subtypes"]
            if final_type_name in subtypes_dict:
                glogger.warning(
                    "Type '%s' already exists under '%s'; skipping duplicate.",
                    final_type_name,
                    base_model_name,
                )
                continue

            subtypes_dict[final_type_name] = subclass
            glogger.debug(
                "Registered '%s' as '%s' under '%s'.",
                subclass.__name__,
                final_type_name,
                base_model_name,
            )

        DynamicBase._recreate_models()
        return subclass

    return decorator

model_validate_toml classmethod

model_validate_toml(toml_data)

Validate a model from a TOML string.

Source code in swarmauri_base/TomlMixin.py

@classmethod
def model_validate_toml(cls, toml_data: str):
    """Validate a model from a TOML string."""
    try:
        # Parse TOML into a Python dictionary
        toml_content = tomllib.loads(toml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(toml_content))
    except tomllib.TOMLDecodeError as e:
        raise ValueError(f"Invalid TOML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_toml

model_dump_toml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a TOML representation of the model.

Source code in swarmauri_base/TomlMixin.py

def model_dump_toml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a TOML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into TOML
    return toml.dumps(filtered_data)

model_validate_yaml classmethod

model_validate_yaml(yaml_data)

Validate a model from a YAML string.

Source code in swarmauri_base/YamlMixin.py

@classmethod
def model_validate_yaml(cls, yaml_data: str):
    """Validate a model from a YAML string."""
    try:
        # Parse YAML into a Python dictionary
        yaml_content = yaml.safe_load(yaml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(yaml_content))
    except yaml.YAMLError as e:
        raise ValueError(f"Invalid YAML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_yaml

model_dump_yaml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a YAML representation of the model.

Source code in swarmauri_base/YamlMixin.py

def model_dump_yaml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a YAML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into YAML using safe mode
    return yaml.safe_dump(filtered_data, default_flow_style=False)

model_post_init

model_post_init(logger=None)

Assign a logger instance after model initialization.

Source code in swarmauri_base/LoggerMixin.py

def model_post_init(self, logger: Optional[FullUnion[LoggerBase]] = None) -> None:
    """Assign a logger instance after model initialization."""

    # Directly assign the provided FullUnion[LoggerBase] or fallback to the
    # class-level default.
    self.logger = self.logger or logger or self.default_logger

add_allowed_model

add_allowed_model(model)

Add a new model to the list of allowed models.

RAISES	DESCRIPTION
ValueError	If the model is already in the allowed models list.

Source code in swarmauri_base/llms/LLMBase.py

def add_allowed_model(self, model: str) -> None:
    """
    Add a new model to the list of allowed models.

    Raises:
        ValueError: If the model is already in the allowed models list.
    """
    if model in self.allowed_models:
        raise ValueError(f"Model '{model}' is already allowed.")
    self.allowed_models.append(model)

remove_allowed_model

remove_allowed_model(model)

Remove a model from the list of allowed models.

RAISES	DESCRIPTION
ValueError	If the model is not in the allowed models list.

Source code in swarmauri_base/llms/LLMBase.py

def remove_allowed_model(self, model: str) -> None:
    """
    Remove a model from the list of allowed models.

    Raises:
        ValueError: If the model is not in the allowed models list.
    """
    if model not in self.allowed_models:
        raise ValueError(f"Model '{model}' is not in the allowed models list.")
    self.allowed_models.remove(model)