aixplain.modules.agent.model_with_params

A generic class that wraps a model with extra parameters.

This is an abstract base class that must be extended by specific model wrappers.

Example usage:

class MyModel(ModelWithParams): model_id: Text = "my_model" extra_param: int = 10

@field_validator("extra_param") def validate_extra_param(cls, v: int) -> int: if v < 0: raise ValueError("Extra parameter must be positive") return v

ModelWithParams Objects

class ModelWithParams(BaseModel, ABC)

[view_source]

A generic class that wraps a model with extra parameters.

The extra parameters are not part of the model's input/output parameters. This is an abstract base class that must be extended by specific model wrappers.

Attributes:

• model_id - The ID of the model to wrap.

validate_model_id

@field_validator("model_id")
def validate_model_id(cls, v: Text) -> Text

[view_source]

Validate the model_id field.

This validator ensures that the model_id is not empty or whitespace-only.

Arguments:

• cls - The class (automatically provided by pydantic).
• v Text - The value to validate.

Returns:

• Text - The validated model ID.

Raises:

• ValueError - If the model ID is empty or contains only whitespace.

__new__

def __new__(cls, *args, **kwargs)

[view_source]

Create a new instance of a ModelWithParams subclass.

This method prevents direct instantiation of the abstract base class while allowing subclasses to be instantiated normally.

Arguments:

• cls - The class being instantiated.
• *args - Positional arguments for instance creation.
• **kwargs - Keyword arguments for instance creation.

Returns:

• ModelWithParams - A new instance of a ModelWithParams subclass.

Raises:

• TypeError - If attempting to instantiate ModelWithParams directly.