Class swarmauri_standard.llms.OpenAIReasonModel.OpenAIReasonModel

swarmauri_standard.llms.OpenAIReasonModel.OpenAIReasonModel

OpenAIReasonModel(**data)

Bases: LLMBase

OpenAIReasonModel class for interacting with the OpenAI Reasoning Model language models API. This class provides synchronous and asynchronous methods to send conversation data to the model, receive predictions, and stream responses.

ATTRIBUTE	DESCRIPTION
api_key	API key for authenticating requests to the Groq API. TYPE: SecretStr
allowed_models	List of allowed model names that can be used. TYPE: List[str]
name	The default model name to use for predictions. TYPE: str
type	The type identifier for this class. TYPE: Literal['OpenAIReasonModel']
timeout	Timeout duration for API requests. TYPE: float
_BASE_URL	Base URL for the OpenAI API. TYPE: str
_headers	Headers for API requests. TYPE: Dict[str, str]

Provider resources: https://platform.openai.com/docs/models

Initialize the OpenAIModel class with the provided data.

PARAMETER	DESCRIPTION
**data	Arbitrary keyword arguments containing initialization data. TYPE: Dict[str, Any] DEFAULT: {}

Source code in swarmauri_standard/llms/OpenAIReasonModel.py

def __init__(self, **data: Dict[str, Any]) -> None:
    """
    Initialize the OpenAIModel class with the provided data.

    Args:
        **data (Dict[str, Any]): Arbitrary keyword arguments containing initialization data.
    """
    super().__init__(**data)
    self._headers = {
        "Authorization": f"Bearer {self.api_key.get_secret_value()}",
        "Content-Type": "application/json",
    }

api_key instance-attribute

api_key

allowed_models class-attribute instance-attribute

allowed_models = [
    "o3-deep-research-2025-06-26",
    "o4-mini-deep-research-2025-06-26",
    "o3-pro-2025-06-10",
    "o3-2025-04-16",
    "o4-mini-2025-04-16",
    "o1-pro-2025-03-19",
    "o1-mini",
    "o1",
    "o1-2024-12-17",
    "o1-mini-2024-09-12",
    "o3-mini",
    "o3-mini-2025-01-31",
]

name class-attribute instance-attribute

name = 'o1-mini'

type class-attribute instance-attribute

type = 'OpenAIReasonModel'

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,
    max_completion_tokens=256,
    enable_json=False,
    stop=None,
)

Generates a response from the model based on the given conversation.

PARAMETER	DESCRIPTION
conversation	Conversation object with message history. TYPE: Conversation
max_completion_tokens	Maximum tokens for the model's response. TYPE: int DEFAULT: 256
enable_json	Whether to format the response as JSON. TYPE: bool DEFAULT: False
stop	List of stop sequences for response termination. TYPE: Optional[List[str]] DEFAULT: None

RETURNS	DESCRIPTION
Conversation	Updated conversation with the model's response. TYPE: Conversation

Source code in swarmauri_standard/llms/OpenAIReasonModel.py

@retry_on_status_codes((429, 529), max_retries=1)
def predict(
    self,
    conversation: Conversation,
    max_completion_tokens: int = 256,
    enable_json: bool = False,
    stop: Optional[List[str]] = None,
) -> Conversation:
    """
    Generates a response from the model based on the given conversation.

    Args:
        conversation (Conversation): Conversation object with message history.
        max_completion_tokens (int): Maximum tokens for the model's response.
        enable_json (bool): Whether to format the response as JSON.
        stop (Optional[List[str]]): List of stop sequences for response termination.

    Returns:
        Conversation: Updated conversation with the model's response.
    """
    formatted_messages = self._format_messages(conversation.history)
    payload = {
        "model": self.name,
        "messages": formatted_messages,
        "max_completion_tokens": max_completion_tokens,
        "stop": stop or [],
    }
    if enable_json:
        payload["response_format"] = "json_object"

    with DurationManager() as promt_timer:
        with httpx.Client(timeout=self.timeout) as client:
            logging.info(f"headers: {self._headers}")
            response = client.post(
                self._BASE_URL, headers=self._headers, json=payload
            )
            response.raise_for_status()

    response_data = response.json()

    message_content = response_data["choices"][0]["message"]["content"]
    usage_data = response_data.get("usage", {})

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

    return conversation

apredict async

apredict(
    conversation,
    max_completion_tokens=256,
    enable_json=False,
    stop=None,
)

Async method to generate a response from the model based on the given conversation.

PARAMETER	DESCRIPTION
conversation	Conversation object with message history. TYPE: Conversation
max_completion_tokens	Maximum tokens for the model's response. TYPE: int DEFAULT: 256
enable_json	Whether to format the response as JSON. TYPE: bool DEFAULT: False
stop	List of stop sequences for response termination. TYPE: Optional[List[str]] DEFAULT: None

RETURNS	DESCRIPTION
Conversation	Updated conversation with the model's response. TYPE: Conversation

Source code in swarmauri_standard/llms/OpenAIReasonModel.py

@retry_on_status_codes((429, 529), max_retries=1)
async def apredict(
    self,
    conversation: Conversation,
    max_completion_tokens: int = 256,
    enable_json: bool = False,
    stop: Optional[List[str]] = None,
) -> Conversation:
    """
    Async method to generate a response from the model based on the given conversation.

    Args:
        conversation (Conversation): Conversation object with message history.
        max_completion_tokens (int): Maximum tokens for the model's response.
        enable_json (bool): Whether to format the response as JSON.
        stop (Optional[List[str]]): List of stop sequences for response termination.

    Returns:
        Conversation: Updated conversation with the model's response.
    """
    formatted_messages = self._format_messages(conversation.history)
    payload = {
        "model": self.name,
        "messages": formatted_messages,
        "max_completion_tokens": max_completion_tokens,
        "stop": stop or [],
    }
    if enable_json:
        payload["response_format"] = "json_object"

    with DurationManager() as prompt_timer:
        async with httpx.AsyncClient(timeout=self.timeout) as client:
            response = await client.post(
                self._BASE_URL, headers=self._headers, json=payload
            )
            response.raise_for_status()

    response_data = response.json()

    message_content = response_data["choices"][0]["message"]["content"]
    usage_data = response_data.get("usage", {})

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

    return conversation

get_allowed_models

get_allowed_models()

Queries the LLMProvider API endpoint to retrieve the list of allowed models.

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

Source code in swarmauri_standard/llms/OpenAIReasonModel.py

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

    Returns:
        List[str]: List of allowed model names.
    """
    models_data = [
        "o1-mini",
        "o1",
        "o1-2024-12-17",
        "o1-mini-2024-09-12",
        "o3-mini",
        "o3-mini-2025-01-31",
    ]
    return models_data

stream

stream(
    conversation,
    max_completion_tokens=256,
    enable_json=False,
    stop=None,
)

Not implemented.

PARAMETER	DESCRIPTION
conversation	Conversation object with message history. TYPE: Conversation
max_completion_tokens	Maximum tokens for the model's response. TYPE: int DEFAULT: 256
enable_json	Whether to format the response as JSON. TYPE: bool DEFAULT: False
stop	List of stop sequences for response termination. TYPE: Optional[List[str]] DEFAULT: None

RAISES	DESCRIPTION
NotImplementedError	This method is not implemented.

Source code in swarmauri_standard/llms/OpenAIReasonModel.py

def stream(
    self,
    conversation: Conversation,
    max_completion_tokens: int = 256,
    enable_json: bool = False,
    stop: Optional[List[str]] = None,
) -> None:
    """
    Not implemented.

    Args:
        conversation (Conversation): Conversation object with message history.
        max_completion_tokens (int): Maximum tokens for the model's response.
        enable_json (bool): Whether to format the response as JSON.
        stop (Optional[List[str]]): List of stop sequences for response termination.

    Raises:
        NotImplementedError: This method is not implemented.
    """
    raise NotImplementedError

astream async

astream(
    conversation,
    max_completion_tokens=256,
    enable_json=False,
    stop=None,
)

Not implemented.

PARAMETER	DESCRIPTION
conversation	Conversation object with message history. TYPE: Conversation
max_completion_tokens	Maximum tokens for the model's response. TYPE: int DEFAULT: 256
enable_json	Whether to format the response as JSON. TYPE: bool DEFAULT: False
stop	List of stop sequences for response termination. TYPE: Optional[List[str]] DEFAULT: None

RAISES	DESCRIPTION
NotImplementedError	This method is not implemented.

Source code in swarmauri_standard/llms/OpenAIReasonModel.py

async def astream(
    self,
    conversation: Conversation,
    max_completion_tokens: int = 256,
    enable_json: bool = False,
    stop: Optional[List[str]] = None,
) -> None:
    """
    Not implemented.

    Args:
        conversation (Conversation): Conversation object with message history.
        max_completion_tokens (int): Maximum tokens for the model's response.
        enable_json (bool): Whether to format the response as JSON.
        stop (Optional[List[str]]): List of stop sequences for response termination.

    Raises:
        NotImplementedError: This method is not implemented.
    """
    raise NotImplementedError

batch

batch(
    conversations,
    max_completion_tokens=256,
    enable_json=False,
    stop=None,
)

Not implemented.

PARAMETER	DESCRIPTION
conversations	List of conversations to process. TYPE: List[Conversation]
max_completion_tokens	Maximum tokens for the model's response. TYPE: int DEFAULT: 256
enable_json	Whether to format the response as JSON. TYPE: bool DEFAULT: False
stop	List of stop sequences for response termination. TYPE: Optional[List[str]] DEFAULT: None

RAISES	DESCRIPTION
NotImplementedError	This method is not implemented.

Source code in swarmauri_standard/llms/OpenAIReasonModel.py

def batch(
    self,
    conversations: List[Conversation],
    max_completion_tokens: int = 256,
    enable_json: bool = False,
    stop: Optional[List[str]] = None,
) -> None:
    """
    Not implemented.

    Args:
        conversations (List[Conversation]): List of conversations to process.
        max_completion_tokens (int): Maximum tokens for the model's response.
        enable_json (bool): Whether to format the response as JSON.
        stop (Optional[List[str]]): List of stop sequences for response termination.

    Raises:
        NotImplementedError: This method is not implemented.
    """
    raise NotImplementedError

abatch async

abatch(
    conversations,
    max_completion_tokens=256,
    enable_json=False,
    stop=None,
)

Not implemented.

PARAMETER	DESCRIPTION
conversations	List of conversations to process. TYPE: List[Conversation]
max_completion_tokens	Maximum tokens for the model's response. TYPE: int DEFAULT: 256
enable_json	Whether to format the response as JSON. TYPE: bool DEFAULT: False
stop	List of stop sequences for response termination. TYPE: Optional[List[str]] DEFAULT: None

RAISES	DESCRIPTION
NotImplementedError	This method is not implemented.

Source code in swarmauri_standard/llms/OpenAIReasonModel.py

async def abatch(
    self,
    conversations: List[Conversation],
    max_completion_tokens: int = 256,
    enable_json: bool = False,
    stop: Optional[List[str]] = None,
) -> None:
    """
    Not implemented.

    Args:
        conversations (List[Conversation]): List of conversations to process.
        max_completion_tokens (int): Maximum tokens for the model's response.
        enable_json (bool): Whether to format the response as JSON.
        stop (Optional[List[str]]): List of stop sequences for response termination.

    Raises:
        NotImplementedError: This method is not implemented.
    """
    raise NotImplementedError

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)