PluginMeta Model

class smarter.apps.plugin.models.PluginMeta(*args, **kwargs)[source]

Bases: MetaDataWithOwnershipModel, SmarterHelperMixin

Represents the core metadata for a Smarter plugin, serving as the central registry for all plugin types.

This class defines the essential identifying and descriptive information for a plugin, including its name, description, type (static, SQL, or API), version, user_profile, and associated tags. Each plugin is uniquely associated with an account and a user_profile, ensuring that plugin names are unique per account and enforcing a snake_case naming convention for consistency and compatibility.

The PluginMeta model acts as the anchor point for related plugin configuration and data models, such as PluginDataStatic, PluginDataSql, and PluginDataApi, which store the specific data and behavior for each plugin type. It is also linked to selection and prompt configuration through PluginSelector and PluginPrompt, enabling flexible plugin discovery and LLM prompt customization.

Validation logic within this class ensures that plugin names conform to required standards, and class methods provide efficient, cached access to plugin instances for a given user or account.

This model is foundational for the Smarter plugin system, enabling the organization, discovery, and management of all plugins within an account, and supporting integration with the broader plugin data and connection models defined in this module.

Parameters:

  • id (BigAutoField) – Primary key: ID

  • created_at (DateTimeField) – Created at

  • updated_at (DateTimeField) – Updated at

  • name (CharField) – Name. Name in camelCase, e.g., ‘apiKey’, no special characters.

  • description (TextField) – Description. A brief description of this resource. Be verbose, but not too verbose.

  • version (CharField) – Version. Semantic version in the format MAJOR.MINOR.PATCH, e.g., ‘1.0.0’.

  • annotations (JSONField) – Annotations. Key-value pairs for annotating this resource.

  • plugin_class (CharField) – Plugin class. The class name of the plugin

Relationship fields:

Parameters:

  • user_profile (ForeignKey to UserProfile) – User profile (related name: pluginmetas)

  • tags (TaggableManager to Tag) – Tags. Tags for categorizing and organizing this resource. (related name: pluginmeta)

  • tagged_items (GenericRelation to TaggedItem) – Tagged items (related name: +)

Reverse relationships:

Parameters:
exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)
add_note(object, /)

Exception.add_note(note) – add a note to the exception

args
silent_variable_failure = True
with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

HASH_FLOOR = 1000000
HASH_PREFIX = 'r'
HASH_SUFFIX = 'x'
exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)
add_note(object, /)

Exception.add_note(note) – add a note to the exception

args
with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

PLUGIN_CLASSES = [('static', 'static'), ('sql', 'sql'), ('api', 'api')]

The classes of plugins supported by Smarter.

__init__(*args, **kwargs)
async adelete(using=None, keep_parents=False)
property amnesty_urls: list[str]

Returns a list of URLs that are exempt from certain checks.

This is a placeholder and should be overridden in subclasses.

Returns:

List of URL path strings that are exempt.

Return type:

list[str]

annotations

JSONField

Annotations. Key-value pairs for annotating this resource.

Type:

Type

async arefresh_from_db(using=None, fields=None, from_queryset=None)
async asave(*args, force_insert=False, force_update=False, using=None, update_fields=None)
cache_expiration = 60
chatbotplugin_set

Reverse ForeignKey from ChatBotPlugin

All ChatBot Plugins of this Plugin (related name of plugin_meta)

Type:

Type

chatpluginusage_set

Reverse ForeignKey from ChatPluginUsage

All Plugin Usage of this Plugin (related name of plugin)

Type:

Type

chattoolcall_set

Reverse ForeignKey from ChatToolCall

All Chat Tool Call History of this Plugin (related name of plugin)

Type:

Type

classmethod check(**kwargs)
clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

created_at

DateTimeField

Created at

Timestamp indicating when the model instance was created. This field is automatically set to the current date and time when the instance is first created. It is indexed in the database for efficient querying.

Type:

Type

data_to_dict(data)

Converts data to a dictionary, handling different types of input.

This method accepts either a dictionary or a string. If a string is provided, it will attempt to parse it as JSON first, and if that fails, as YAML. If parsing fails or the data type is unsupported, a SmarterValueError is raised.

Parameters:

data (dict or str) – The data to convert, either a dict or a JSON/YAML string.

Returns:

The data as a dictionary.

Return type:

dict

Raises:

SmarterValueError – If the data cannot be converted to a dictionary.

date_error_message(lookup_type, field_name, unique_for)
delete(using=None, keep_parents=False)
description

TextField

Description. A brief description of this resource. Be verbose, but not too verbose.

Type:

Type

property elapsed_updated: int | None

Calculate the absolute time difference in seconds between a given datetime and the model’s updated_at timestamp.

This property is useful for determining how much time has elapsed since the model instance was last updated, or for comparing the updated_at field to any arbitrary datetime.

Parameters:

  • dt (datetime, optional): The reference datetime to compare against updated_at. - If dt is not provided, the current time is used. - Both naive and timezone-aware datetime objects are supported; the method will handle conversions as needed.

Returns:

  • int or None: The absolute difference in seconds between updated_at and dt. Returns None if updated_at is not set.

Example Usage:

obj = MyModel.objects.get(pk=1)
# Time since last update
seconds = obj.elapsed_updated
print(f"Seconds since last update: {seconds}")

# Compare to a specific datetime
import datetime
dt = datetime.datetime(2025, 12, 1, 12, 0, 0)
diff = obj.elapsed_updated(dt)
print(f"Seconds between updated_at and 2025-12-01 12:00:00: {diff}")

Note

  • Handles both naive and aware datetime objects, converting as necessary to ensure accurate calculation.

  • If updated_at is not set (e.g., the object has not been saved), returns None.

Attention

  • If dt is provided and is not a datetime.datetime instance, a TypeError will be raised.

  • Always ensure that updated_at is set before relying on this property for calculations.

classmethod find_hash(value)

Finds and returns the first substring in the given value that matches the hashed ID format.

Parameters:

value (str) – The string to search for a hashed ID.

Returns:

The first matching hashed ID if found, otherwise None.

Return type:

Optional[str]

property formatted_class_name: str

Returns the class name formatted for logging.

Returns:

The formatted class name as a string.

Return type:

str

property formatted_state_not_ready: str

Returns the not-ready state formatted for logging.

Returns:

The formatted not-ready state as a string.

Return type:

str

property formatted_state_ready: str

Returns the readiness state formatted for logging.

Returns:

The formatted readiness state as a string.

Return type:

str

classmethod from_db(db, field_names, values)
full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

classmethod get_cached_object(invalidate=False, pk=None, name=None, user=None, user_profile=None, username=None, account=None, plugin_class=None)[source]

Return a single instance of PluginMeta by primary key or by name and user.

This method caches the results to improve performance.

Parameters:

  • name (str) – The name of the plugin to retrieve.

  • user (User) – The user who owns the plugin.

  • account (Account) – The account associated with the plugin.

  • username (str) – The username of the user who owns the plugin.

  • invalidate (bool) – If True, invalidate the cache for this query.

Returns:

A PluginMeta instance if found, otherwise None.

Return type:

Optional[PluginMeta]

classmethod get_cached_objects(invalidate=False, user_profile=None)[source]

Return a QuerySet of all PluginMeta instances for the given user profile. This method caches the results to improve performance.

Parameters:

  • invalidate (bool) – If True, invalidate the cache for this query.

  • user_profile (UserProfile) – The user profile whose plugins should be retrieved.

Returns:

A QuerySet of PluginMeta instances for the user profile.

Return type:

QuerySet[PluginMeta]

classmethod get_cached_plugins_for_user_profile_id(invalidate=False, user_profile_id=None)[source]

Return a list of all instances of PluginMeta for the given user.

This method caches the results to improve performance.

Parameters:

  • user_profile_id (int) – The ID of the user profile whose plugins should be retrieved.

  • invalidate (bool) – Whether to invalidate the cache before retrieving the plugins.

Returns:

A list of PluginMeta instances for the user profile.

Return type:

list[PluginMeta]

See also:

  • smarter.lib.cache.cache_results()

get_constraints()
get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_object_by_locator(locator)

Retrieves an object based on its record locator.

Example:

obj = MyModel.objects.create()
print(obj.id)  # e.g., 123
locator = obj.record_locator # e.g., "mymodel-rc2x"

retrieved_obj = MyModel.get_object_by_locator(locator)
print(type(retrieved_obj))  # Should be <class 'MyModel'>
print(retrieved_obj)  # Should be the same as obj
Parameters:

locator (str) – The record locator string to decode and search for.

Returns:

The model instance if found, otherwise None.

Return type:

Optional[TimestampedModel]

get_plugin_class_display(*, field=<django.db.models.CharField: plugin_class>)

Shows the label of the plugin_class. See get_FOO_display() for more information.

classmethod hash_regex()

Returns a regex pattern that matches the hashed ID format for this model anywhere in a string.

The hashed ID format is defined by the HASH_PREFIX and HASH_SUFFIX class attributes, with a base64-encoded string in between. This regex can be used to validate or extract hashed IDs from strings, including when embedded in URLs.

Returns:

A regex pattern for matching hashed IDs.

Return type:

re.Pattern

property hashed_id: str

Returns a URL-friendly hashed version of the object’s ID for use in URLs and other contexts where an obscured, non-identifying, non-sequential identifier is preferred.

Encoding scheme: 1. Take the object’s ID and add a large constant (HASH_FLOOR) to ensure it’s not easily guessable. 2. Convert the resulting number to a string and encode it using URL-safe base64 encoding. 3. Remove any padding characters from the encoded string. 4. Add a prefix and suffix to the encoded string to create a recognizable format.

Example:

obj = MyModel.objects.create()
print(obj.id)  # e.g., 123
print(obj.hashed_id)  # e.g., "rc2x"
Returns:

Hashed ID string (URL-safe, no padding)

Return type:

str

id

BigAutoField

Primary key: ID

Type:

Type

classmethod id_from_hashed_id(hashed_id)

Decodes a hashed ID back to the original object ID.

decoding scheme: 1. Validate that the hashed ID starts with the expected prefix and ends with the expected suffix. 2. Remove the prefix and suffix to isolate the base64-encoded string. 3. Add padding if necessary to make the length of the encoded string a multiple of 4. 4. Decode the base64 string to get the original number as a string. 5. Convert the decoded string to an integer and subtract the HASH_FLOOR to get the original ID.

Example:

my_record = MyModel.objects.create()
print(my_record.id)  # e.g., 123
hashed_id = my_record.hashed_id  # e.g., "rc2x"

original_id = MyModel.id_from_hashed_id(hashed_id)
print(original_id)  # Should print the original ID (e.g., 123)
Parameters:

hashed_id (str) – The hashed ID string to decode (URL-safe, no padding).

Returns:

The original object ID if decoding is successful, otherwise None.

Return type:

Optional[int]

property kind: SAMKinds

Return the kind of the plugin based on its class.

This property is used to determine how the plugin should be handled by the system. It maps the plugin’s class to a corresponding SAMKinds enumeration value.

Returns:

The kind of the plugin as a SAMKinds enum.

Return type:

SAMKinds

Example:

plugin.plugin_class = 'static'
plugin.kind  # SAMKinds.STATIC_PLUGIN
mask_string(string='', mask_char='*', mask_length=4, string_length=8)

Masks a string for secure logging.

This utility function masks all but the last unmasked_chars characters of the input string, replacing them with asterisks. It is useful for logging sensitive information like API keys or passwords.

Parameters:

  • string (str) – The string to be masked.

  • mask_char (str) – The character used for masking.

  • mask_length (int) – The number of characters to mask.

  • string_length (int) – The length of the string to consider for masking.

Returns:

The masked string.

Return type:

str

name

CharField

Name. Name in camelCase, e.g., ‘apiKey’, no special characters.

Type:

Type

objects = <django.db.models.Manager object>
property pk
plugin_class

CharField

Plugin class. The class name of the plugin

Choices:

  • static

  • sql

  • api

Type:

Type

plugin_data_base_plugin

Reverse OneToOneField from PluginDataBase

The plugin data base plugin of this Plugin (related name of plugin)

Type:

Type

plugin_prompt_plugin

Reverse OneToOneField from PluginPrompt

The plugin prompt plugin of this Plugin (related name of plugin)

Type:

Type

plugin_selector_plugin

Reverse OneToOneField from PluginSelector

The plugin selector plugin of this Plugin (related name of plugin)

Type:

Type

prepare_database_save(field)
property ready: bool

Indicates whether the object is ready for use. This is a placeholder that should be overridden in subclasses.

Returns:

True if ready, False otherwise.

Return type:

bool

property record_locator: str

Returns a short, URL-friendly record locator derived from the object’s ID.

Example:

obj = MyModel.objects.create(name="Example")
print(obj.id)  # e.g., 123
print(obj.record_locator)  # e.g., "chatbot-rc2x"
Returns:

Record locator string (URL-safe, no padding)

Return type:

str

refresh_from_db(using=None, fields=None, from_queryset=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

property rfc1034_compliant_kind: str | None

Returns a URL-friendly kind for the chatbot.

This is a convenience property that returns an RFC 1034-compliant kind for the chatbot, suitable for use in URLs and DNS labels.

Example:

self.kind  # 'Static'
self.rfc1034_compliant_kind  # 'static'
Returns:

The RFC 1034-compliant kind, or None if self.kind is not set.

Return type:

Optional[str]

property rfc1034_compliant_name: str | None

Returns a URL-friendly name for the chatbot.

This property returns an RFC 1034-compliant name for the chatbot, suitable for use in URLs and DNS labels.

Example:

self.name = 'Example ChatBot 1'
self.rfc1034_compliant_name  # 'example-chatbot-1'
Returns:

The RFC 1034-compliant name, or None if self.name is not set.

Return type:

Optional[str]

save(*args, **kwargs)[source]

Override the save method to validate the field dicts.

This method ensures that all relevant fields are validated before saving the model instance. For example, it checks that the name is in snake_case and converts it if necessary, logs a warning if conversion occurs, and calls the model’s validate() method to enforce any additional validation logic defined on the model. After validation, it proceeds with the standard Django save operation.

Parameters:

  • args – Positional arguments passed to the parent save method.

  • kwargs – Keyword arguments passed to the parent save method.

Returns:

None

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

smarter_build_absolute_uri(request)

Attempts to get the absolute URI from a request object.

This utility function tries to retrieve the request URL from any valid child class of django.http.HttpRequest. It is especially useful in unit tests or scenarios where the request object may not implement build_absolute_uri().

Parameters:

request (Optional[HttpRequest]) – The request object.

Returns:

The absolute request URL.

Return type:

Optional[str]

Raises:

SmarterValueError – If the URI cannot be built from the request.

sorted_dict(data)

Returns a new dictionary with keys sorted.

Parameters:

data (dict) – The dictionary to sort.

Returns:

A new dictionary with sorted keys.

Return type:

dict

tagged_items

Reverse GenericRelation from PluginMeta

All + of this tagged item (related name of tagged_items)

Type:

Type

tags = <taggit.managers._TaggableManager object>
property tags_list: list[str]

Return the tags as a list of strings. We assume that @cached_property is more efficient at fetch that @cache_results, all things considered equal, which provides a marginal boost to instances. Meanwhile, the @cache_results is persisted to the Django cache, and thus outlives this instance. Thus, best of both worlds.

Returns:

List of tag names.

Return type:

list[str]

to_json()

Serialize the model instance to a JSON-compatible dictionary.

This method uses the custom SmarterJSONEncoder to ensure that all fields, including timestamps and any complex data types, are properly serialized.

Returns:

A dictionary representation of the model instance suitable for JSON serialization.

Return type:

dict[str, Any]

property unformatted_class_name: str

Returns the raw class name without formatting.

Returns:

The unformatted class name as a string.

Return type:

str

This is useful for logging or serialization where the plain class name is needed.

unique_error_message(model_class, unique_check)
updated_at

DateTimeField

Updated at

Timestamp indicating when the model instance was last updated. This field is automatically updated to the current date and time whenever the instance is saved. It is indexed in the database for efficient querying.

Type:

Type

user_profile

ForeignKey to UserProfile

User profile (related name: pluginmetas)

Type:

Type

user_profile_id

Internal field, use user_profile instead.

validate()

Validate the model.

validate_constraints(exclude=None)
validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

version

CharField

Version. Semantic version in the format MAJOR.MINOR.PATCH, e.g., ‘1.0.0’.

Type:

Type