Class swarmauri_standard.llms.DeepSeekModel.DeepSeekModel

swarmauri_standard.llms.DeepSeekModel.DeepSeekModel

DeepSeekModel(**data)

Bases: LLMBase

A client class for interfacing with DeepSeek's language model for chat completions.

This class provides methods for synchronous and asynchronous prediction, streaming, and batch processing. It handles message formatting, payload construction, and response parsing to seamlessly integrate with the DeepSeek API.

ATTRIBUTE	DESCRIPTION
api_key	The API key for authenticating with DeepSeek. TYPE: SecretStr
allowed_models	List of models supported by DeepSeek, defaulting to ["deepseek-chat"]. TYPE: List[str]
name	The model name, defaulting to "deepseek-chat". TYPE: str
type	The class type for identifying the LLM, set to "DeepSeekModel". TYPE: Literal

Link to Allowed Models: https://platform.deepseek.com/api-docs/quick_start/pricing Link to API KEY: https://platform.deepseek.com/api_keys

Source code in swarmauri_standard/llms/DeepSeekModel.py

def __init__(self, **data: Dict[str, Any]) -> None:
    super().__init__(**data)

    self._client = httpx.Client(
        headers={"Authorization": f"Bearer {self.api_key.get_secret_value()}"},
        base_url=self._BASE_URL,
        timeout=self.timeout,
    )
    self._async_client = httpx.AsyncClient(
        headers={"Authorization": f"Bearer {self.api_key.get_secret_value()}"},
        base_url=self._BASE_URL,
        timeout=self.timeout,
    )

api_key instance-attribute

api_key

allowed_models class-attribute instance-attribute

allowed_models = ['deepseek-chat', 'deepseek-reasoner']

name class-attribute instance-attribute

name = 'deepseek-chat'

type class-attribute instance-attribute

type = 'DeepSeekModel'

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,
    frequency_penalty=0,
    presence_penalty=0,
    stop="\n",
    top_p=1.0,
)

Sends a synchronous request to the DeepSeek API to generate a chat response.

PARAMETER	DESCRIPTION
conversation	The conversation object containing message history. TYPE: Conversation
temperature	Sampling temperature for randomness in response. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens in the response. TYPE: int DEFAULT: 256
frequency_penalty	Penalty for frequent tokens in the response. TYPE: float DEFAULT: 0
presence_penalty	Penalty for new topics in the response. TYPE: float DEFAULT: 0
stop	Token at which response generation should stop. TYPE: Optional[str] DEFAULT: '\n'
top_p	Top-p sampling value for nucleus sampling. TYPE: float DEFAULT: 1.0

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

Source code in swarmauri_standard/llms/DeepSeekModel.py

@retry_on_status_codes((429, 529), max_retries=1)
def predict(
    self,
    conversation: Conversation,
    temperature: float = 0.7,
    max_tokens: int = 256,
    frequency_penalty: float = 0,
    presence_penalty: float = 0,
    stop: Optional[str] = "\n",
    top_p: float = 1.0,
) -> Conversation:
    """
    Sends a synchronous request to the DeepSeek API to generate a chat response.

    Args:
        conversation (Conversation): The conversation object containing message history.
        temperature (float): Sampling temperature for randomness in response.
        max_tokens (int): Maximum number of tokens in the response.
        frequency_penalty (float): Penalty for frequent tokens in the response.
        presence_penalty (float): Penalty for new topics in the response.
        stop (Optional[str]): Token at which response generation should stop.
        top_p (float): Top-p sampling value for nucleus sampling.

    Returns:
        Conversation: Updated conversation object with the generated response added.
    """
    formatted_messages = self._format_messages(conversation.history)
    payload = {
        "messages": formatted_messages,
        "model": self.name,
        "temperature": temperature,
        "max_tokens": max_tokens,
        "frequency_penalty": frequency_penalty,
        "presence_penalty": presence_penalty,
        "response_format": {"type": "text"},
        "stop": stop,
        "top_p": top_p,
    }
    response = self._client.post("/chat/completions", json=payload)
    response.raise_for_status()
    message_content = response.json()["choices"][0]["message"]["content"]
    conversation.add_message(AgentMessage(content=message_content))
    return conversation

apredict async

apredict(
    conversation,
    temperature=0.7,
    max_tokens=256,
    frequency_penalty=0,
    presence_penalty=0,
    stop="\n",
    top_p=1.0,
)

Sends an asynchronous request to the DeepSeek API to generate a chat response.

PARAMETER	DESCRIPTION
conversation	The conversation object containing message history. TYPE: Conversation
temperature	Sampling temperature for randomness in response. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens in the response. TYPE: int DEFAULT: 256
frequency_penalty	Penalty for frequent tokens in the response. TYPE: float DEFAULT: 0
presence_penalty	Penalty for new topics in the response. TYPE: float DEFAULT: 0
stop	Token at which response generation should stop. TYPE: Optional[str] DEFAULT: '\n'
top_p	Top-p sampling value for nucleus sampling. TYPE: float DEFAULT: 1.0

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

Source code in swarmauri_standard/llms/DeepSeekModel.py

@retry_on_status_codes((429, 529), max_retries=1)
async def apredict(
    self,
    conversation: Conversation,
    temperature: float = 0.7,
    max_tokens: int = 256,
    frequency_penalty: float = 0,
    presence_penalty: float = 0,
    stop: Optional[str] = "\n",
    top_p: float = 1.0,
) -> Conversation:
    """
    Sends an asynchronous request to the DeepSeek API to generate a chat response.

    Args:
        conversation (Conversation): The conversation object containing message history.
        temperature (float): Sampling temperature for randomness in response.
        max_tokens (int): Maximum number of tokens in the response.
        frequency_penalty (float): Penalty for frequent tokens in the response.
        presence_penalty (float): Penalty for new topics in the response.
        stop (Optional[str]): Token at which response generation should stop.
        top_p (float): Top-p sampling value for nucleus sampling.

    Returns:
        Conversation: Updated conversation object with the generated response added.
    """
    formatted_messages = self._format_messages(conversation.history)
    payload = {
        "messages": formatted_messages,
        "model": self.name,
        "temperature": temperature,
        "max_tokens": max_tokens,
        "frequency_penalty": frequency_penalty,
        "presence_penalty": presence_penalty,
        "response_format": {"type": "text"},
        "stop": stop,
        "top_p": top_p,
    }
    response = await self._async_client.post("/chat/completions", json=payload)
    response.raise_for_status()
    message_content = response.json()["choices"][0]["message"]["content"]
    conversation.add_message(AgentMessage(content=message_content))
    return conversation

stream

stream(
    conversation,
    temperature=0.7,
    max_tokens=256,
    frequency_penalty=0,
    presence_penalty=0,
    stop="\n",
    top_p=1.0,
)

Streams the response token by token synchronously from the DeepSeek API.

PARAMETER	DESCRIPTION
conversation	The conversation object containing message history. TYPE: Conversation
temperature	Sampling temperature for randomness in response. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens in the response. TYPE: int DEFAULT: 256
frequency_penalty	Penalty for frequent tokens in the response. TYPE: float DEFAULT: 0
presence_penalty	Penalty for new topics in the response. TYPE: float DEFAULT: 0
stop	Token at which response generation should stop. TYPE: Optional[str] DEFAULT: '\n'
top_p	Top-p sampling value for nucleus sampling. TYPE: float DEFAULT: 1.0

YIELDS	DESCRIPTION
str	Token of the response being streamed. TYPE:: str

Source code in swarmauri_standard/llms/DeepSeekModel.py

@retry_on_status_codes((429, 529), max_retries=1)
def stream(
    self,
    conversation: Conversation,
    temperature: float = 0.7,
    max_tokens: int = 256,
    frequency_penalty: float = 0,
    presence_penalty: float = 0,
    stop: Optional[str] = "\n",
    top_p: float = 1.0,
) -> Iterator[str]:
    """
    Streams the response token by token synchronously from the DeepSeek API.

    Args:
        conversation (Conversation): The conversation object containing message history.
        temperature (float): Sampling temperature for randomness in response.
        max_tokens (int): Maximum number of tokens in the response.
        frequency_penalty (float): Penalty for frequent tokens in the response.
        presence_penalty (float): Penalty for new topics in the response.
        stop (Optional[str]): Token at which response generation should stop.
        top_p (float): Top-p sampling value for nucleus sampling.

    Yields:
        str: Token of the response being streamed.
    """
    formatted_messages = self._format_messages(conversation.history)
    payload = {
        "messages": formatted_messages,
        "model": self.name,
        "temperature": temperature,
        "max_tokens": max_tokens,
        "frequency_penalty": frequency_penalty,
        "presence_penalty": presence_penalty,
        "response_format": {"type": "text"},
        "stop": stop,
        "top_p": top_p,
        "stream": True,
    }
    with self._client.stream("POST", "/chat/completions", json=payload) as response:
        response.raise_for_status()
        collected_content = []
        for line in response.iter_lines():
            json_str = line.replace("data: ", "")
            if json_str:
                try:
                    chunk = json.loads(json_str)
                    if chunk["choices"][0]["delta"]["content"]:
                        content = chunk["choices"][0]["delta"]["content"]
                        collected_content.append(content)
                        yield content
                except json.JSONDecodeError:
                    pass

        full_content = "".join(collected_content)
        conversation.add_message(AgentMessage(content=full_content))

astream async

astream(
    conversation,
    temperature=0.7,
    max_tokens=256,
    frequency_penalty=0,
    presence_penalty=0,
    stop="\n",
    top_p=1.0,
)

Asynchronously streams the response token by token from the DeepSeek API.

PARAMETER	DESCRIPTION
conversation	The conversation object containing message history. TYPE: Conversation
temperature	Sampling temperature for randomness in response. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens in the response. TYPE: int DEFAULT: 256
frequency_penalty	Penalty for frequent tokens in the response. TYPE: float DEFAULT: 0
presence_penalty	Penalty for new topics in the response. TYPE: float DEFAULT: 0
stop	Token at which response generation should stop. TYPE: Optional[str] DEFAULT: '\n'
top_p	Top-p sampling value for nucleus sampling. TYPE: float DEFAULT: 1.0

YIELDS	DESCRIPTION
str	Token of the response being streamed. TYPE:: AsyncIterator[str]

Source code in swarmauri_standard/llms/DeepSeekModel.py

@retry_on_status_codes((429, 529), max_retries=1)
async def astream(
    self,
    conversation: Conversation,
    temperature: float = 0.7,
    max_tokens: int = 256,
    frequency_penalty: float = 0,
    presence_penalty: float = 0,
    stop: Optional[str] = "\n",
    top_p: float = 1.0,
) -> AsyncIterator[str]:
    """
    Asynchronously streams the response token by token from the DeepSeek API.

    Args:
        conversation (Conversation): The conversation object containing message history.
        temperature (float): Sampling temperature for randomness in response.
        max_tokens (int): Maximum number of tokens in the response.
        frequency_penalty (float): Penalty for frequent tokens in the response.
        presence_penalty (float): Penalty for new topics in the response.
        stop (Optional[str]): Token at which response generation should stop.
        top_p (float): Top-p sampling value for nucleus sampling.

    Yields:
        str: Token of the response being streamed.
    """
    formatted_messages = self._format_messages(conversation.history)
    payload = {
        "messages": formatted_messages,
        "model": self.name,
        "temperature": temperature,
        "max_tokens": max_tokens,
        "frequency_penalty": frequency_penalty,
        "presence_penalty": presence_penalty,
        "response_format": {"type": "text"},
        "stop": stop,
        "top_p": top_p,
        "stream": True,
    }
    async with self._async_client.stream(
        "POST", "/chat/completions", json=payload
    ) as response:
        response.raise_for_status()
        collected_content = []
        async for line in response.aiter_lines():
            json_str = line.replace("data: ", "")
            if json_str:
                try:
                    chunk = json.loads(json_str)
                    if chunk["choices"][0]["delta"]["content"]:
                        content = chunk["choices"][0]["delta"]["content"]
                        collected_content.append(content)
                        yield content
                except json.JSONDecodeError:
                    pass

        full_content = "".join(collected_content)
        conversation.add_message(AgentMessage(content=full_content))

batch

batch(
    conversations,
    temperature=0.7,
    max_tokens=256,
    frequency_penalty=0,
    presence_penalty=0,
    stop="\n",
    top_p=1.0,
)

Processes multiple conversations synchronously in a batch.

PARAMETER	DESCRIPTION
conversations	List of conversation objects. TYPE: List[Conversation]
temperature	Sampling temperature for randomness in response. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens in the response. TYPE: int DEFAULT: 256
frequency_penalty	Penalty for frequent tokens in the response. TYPE: float DEFAULT: 0
presence_penalty	Penalty for new topics in the response. TYPE: float DEFAULT: 0
stop	Token at which response generation should stop. TYPE: Optional[str] DEFAULT: '\n'
top_p	Top-p sampling value for nucleus sampling. TYPE: float DEFAULT: 1.0

RETURNS	DESCRIPTION
List[Conversation]	List[Conversation]: List of updated conversation objects with responses added.

Source code in swarmauri_standard/llms/DeepSeekModel.py

def batch(
    self,
    conversations: List[Conversation],
    temperature: float = 0.7,
    max_tokens: int = 256,
    frequency_penalty: float = 0,
    presence_penalty: float = 0,
    stop: Optional[str] = "\n",
    top_p: float = 1.0,
) -> List[Conversation]:
    """
    Processes multiple conversations synchronously in a batch.

    Args:
        conversations (List[Conversation]): List of conversation objects.
        temperature (float): Sampling temperature for randomness in response.
        max_tokens (int): Maximum number of tokens in the response.
        frequency_penalty (float): Penalty for frequent tokens in the response.
        presence_penalty (float): Penalty for new topics in the response.
        stop (Optional[str]): Token at which response generation should stop.
        top_p (float): Top-p sampling value for nucleus sampling.

    Returns:
        List[Conversation]: List of updated conversation objects with responses added.
    """
    return [
        self.predict(
            conv,
            temperature=temperature,
            max_tokens=max_tokens,
            frequency_penalty=frequency_penalty,
            presence_penalty=presence_penalty,
            stop=stop,
            top_p=top_p,
        )
        for conv in conversations
    ]

abatch async

abatch(
    conversations,
    temperature=0.7,
    max_tokens=256,
    frequency_penalty=0,
    presence_penalty=0,
    stop="\n",
    top_p=1.0,
    max_concurrent=5,
)

Processes multiple conversations asynchronously in parallel, with concurrency control.

PARAMETER	DESCRIPTION
conversations	List of conversation objects. TYPE: List[Conversation]
temperature	Sampling temperature for randomness in response. TYPE: float DEFAULT: 0.7
max_tokens	Maximum number of tokens in the response. TYPE: int DEFAULT: 256
frequency_penalty	Penalty for frequent tokens in the response. TYPE: float DEFAULT: 0
presence_penalty	Penalty for new topics in the response. TYPE: float DEFAULT: 0
stop	Token at which response generation should stop. TYPE: Optional[str] DEFAULT: '\n'
top_p	Top-p sampling value for nucleus sampling. TYPE: float DEFAULT: 1.0
max_concurrent	Maximum number of concurrent tasks allowed. TYPE: int DEFAULT: 5

RETURNS	DESCRIPTION
List[Conversation]	List[Conversation]: List of updated conversation objects with responses added.

Source code in swarmauri_standard/llms/DeepSeekModel.py

async def abatch(
    self,
    conversations: List[Conversation],
    temperature: float = 0.7,
    max_tokens: int = 256,
    frequency_penalty: float = 0,
    presence_penalty: float = 0,
    stop: Optional[str] = "\n",
    top_p: float = 1.0,
    max_concurrent: int = 5,
) -> List[Conversation]:
    """
    Processes multiple conversations asynchronously in parallel, with concurrency control.

    Args:
        conversations (List[Conversation]): List of conversation objects.
        temperature (float): Sampling temperature for randomness in response.
        max_tokens (int): Maximum number of tokens in the response.
        frequency_penalty (float): Penalty for frequent tokens in the response.
        presence_penalty (float): Penalty for new topics in the response.
        stop (Optional[str]): Token at which response generation should stop.
        top_p (float): Top-p sampling value for nucleus sampling.
        max_concurrent (int): Maximum number of concurrent tasks allowed.

    Returns:
        List[Conversation]: List of updated conversation objects with responses added.
    """
    semaphore = asyncio.Semaphore(max_concurrent)

    async def process_conversation(conv: Conversation) -> Conversation:
        async with semaphore:
            return await self.apredict(
                conv,
                temperature=temperature,
                max_tokens=max_tokens,
                frequency_penalty=frequency_penalty,
                presence_penalty=presence_penalty,
                stop=stop,
                top_p=top_p,
            )

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

get_allowed_models

get_allowed_models()

Queries the DeepSeek API to get the list of allowed models.

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

Source code in swarmauri_standard/llms/DeepSeekModel.py

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

    Returns:
        List[str]: List of allowed model names.
    """
    response = self._client.get("/models")
    response.raise_for_status()
    models = response.json().get("models", [])
    return models

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)