API Connection Broker

class smarter.apps.plugin.manifest.brokers.api_connection.SAMApiConnectionBroker(*args, **kwargs)[source]

Smarter API ApiConnection Manifest Broker.

This class is responsible for loading, validating, and parsing Smarter API YAML ApiConnection manifests, and initializing the corresponding Pydantic model. It provides generic services for ApiConnection objects, including instantiation, creation, update, and deletion.

Parameters:

loader (Optional[ManifestLoader]) – Manifest loader providing manifest data.
account (Account) – The account context for the connection.
user_profile (UserProfile) – The user profile associated with the connection.

See also

smarter.apps.plugin.manifest.models.api_connection.model.SAMApiConnection smarter.apps.plugin.models.ApiConnection smarter.apps.plugin.serializers.ApiConnectionSerializer smarter.apps.plugin.manifest.brokers.SAMConnectionBrokerError

Example usage:

broker = SAMApiConnectionBroker(loader=my_loader, account=my_account, user_profile=my_profile)
manifest = broker.manifest
orm_data = broker.manifest_to_django_orm()

property ORMMetaModelClass: Type[ApiConnection]

Return the Django ORM meta model class for the broker.

Returns:: The Django ORM meta model class definition for the broker.
Return type:: Type[ApiConnection]

property ORMModelClass: Type[ApiConnection]

Return the Django ORM model class for ApiConnection.

This property provides the class object used for persistent storage and manipulation of API connection data in the database. It is useful for type checking, introspection, and for creating or querying ApiConnection instances.

Returns:: The Django ORM model class for API connections.
Return type:: Type[smarter.apps.plugin.models.ApiConnection]

Example usage:

model_cls = broker.ORMModelClass
all_connections = model_cls.objects.all()

property SAMModelClass: Type[SAMApiConnection]

Return the Pydantic model class for the broker.

Returns:: The Pydantic model class definition for the broker.
Return type:: Type[SAMApiConnection]

property SerializerClass: Type[ApiConnectionSerializer]

Return the SerializerClass class for the broker.

This property provides the SerializerClass used to convert ApiConnection model instances to and from native Python datatypes, enabling validation and serialization for API responses and internal processing.

Returns:: The SerializerClass class for ApiConnection objects.
Return type:: Type[ApiConnectionSerializer]

See also

ApiConnectionSerializer ApiConnection SAMApiConnectionBroker.manifest() SAMApiConnectionBroker.manifest_to_django_orm()

Example usage:

serializer_cls = broker.SerializerClass
SerializerClass = serializer_cls(api_connection_instance)
data = SerializerClass.data

__init__(*args, **kwargs)[source]

property abstract_broker_logger_cache_invalidation_prefix: str

Return the logger prefix for the AbstractBroker cache invalidation.

Returns:: The logger prefix for the AbstractBroker.
Return type:: str

property abstract_broker_logger_prefix: str

Return the logger prefix for the AbstractBroker.

Returns:: The logger prefix for the AbstractBroker.
Return type:: str

property abstract_broker_ready_state: str

Return a string representation of the AbstractBroker’s ready state.

Returns:: “READY” if the AbstractBroker is ready, otherwise “NOT_READY”.
Return type:: str

property account: Account | None

Returns the account for the current user. Handle lazy instantiation from user or user_profile.

Returns:: The account for the current user.
Return type:: Account or None

property account_mixin_logger_prefix: str: Returns the logger prefix for the class.

property account_number: str | None

A helper function to get the account number from the account.

Returns:: The account number for the current account.
Return type:: str or None

property accountmixin_ready_state: str

Returns a string representation of the AccountMixin ready state.

Returns:: String representation of the AccountMixin ready state.
Return type:: str

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]

property api_key_secret: Secret | None

Return the api_key secret for the ApiConnection.

This property retrieves the Django ORM Secret instance associated with the API key for the current connection. It resolves the secret either from the manifest or from the existing database record, depending on initialization context.

Returns:: The Secret object representing the API key, or None if not found.
Return type:: Optional[Secret]

Attention

If the secret cannot be found, a warning is logged and None is returned.

Example usage:

api_key_secret = broker.api_key_secret
if api_key_secret:
    print(api_key_secret.value)

property api_subdomain: str | None

Extracts the API subdomain from the URL.

Returns:: The API subdomain or None if not found.

example:

- https://hr.3141-5926-5359.alpha.api.example.com/chatbot/
returns 'hr'

property api_token: bytes | None

Get the API token from the request.

Returns:: The API token as bytes if present in the Authorization header, otherwise None.

Example:

request_mixin = SmarterRequestMixin(request)
token = request_mixin.api_token

Returns:: The API token as bytes, or None if not present.

property api_version: str

The API version of the manifest.

Returns:: The API version of the manifest.
Return type:: Optional[str]

apply(request, *args, **kwargs)[source]

Apply the manifest. Copy the manifest data to the Django ORM model and save the model to the database.

This method calls super().apply() to ensure that the manifest is loaded and validated before applying the manifest to the Django ORM model.

Note that there are fields included in the manifest that are not editable and are therefore removed from the Django ORM model dict prior to attempting the save() command. These fields are defined in the readonly_fields list.

Note

tags are handled separately because they are of type TaggableManager and require a different method to set them.

Example manifest structure:

{
    "apiVersion": "smarter.sh/v1",          # read only
    "kind": "ApiConnection",                # read only
    "metadata": {                           # updated in super().apply()
        "name": "testf232a0619cb19da0",
        "description": "new description",
        "version": "1.0.0"
    },
    "spec": {                               # updated here.
        "connection": {
            "kind": "ApiConnection",
            "version": "1.0.0",
            "account": "2194-1233-0815",
            "baseUrl": "http://localhost:9357/api/v1/cli/example_manifest/plugin/",
            "apiKey": "testf232a0619cb19da0",
            "authMethod": "basic",
            "timeout": 30,
            "proxyProtocol": "http",
            "proxyHost": null,
            "proxyPort": null,
            "proxyUsername": null,
            "proxyPassword": null
        }
    },
    "status": {                             # read only
        "connection_string": "http://localhost:9357/api/v1/cli/example_manifest/plugin/ (Auth: ******)",
        "is_valid": false
    }
}

Parameters:

request ("HttpRequest") – Django HTTP request object.
args – Additional positional arguments.
kwargs – Additional keyword arguments.

Returns:

JSON response indicating success and the updated manifest data.

Return type:

SmarterJournaledJsonResponse

Raises:

SAMConnectionBrokerError – If an error occurs during update or save.

property auth_header: str | None

Get the Authorization header from the request.

Example:

request_mixin = SmarterRequestMixin(request)
print(request_mixin.auth_header)

This property checks for the “Authorization” header in the request headers or in the Django META dictionary.

Returns:: The value of the “Authorization” header as a string, or None if not present.

authenticate()

Authenticates the request using the provided API token.

Return type:: bool

cache_invalidations()[source]

Invalidate any relevant caches when the manifest or connection data changes.

Return type:: None

property cache_key: str | None

Returns a cache key for the request.

This is used to cache the chat request thread. The key is a combination of: - the class name, - authenticated username, - the chat name, - and the client UID.

Currently used by the ApiV1CliChatConfigApiView and ApiV1CliChatApiView as a means of sharing the session_key.

Parameters:

name – A generic object or resource name.
uid – UID of the client, assumed to have been created from the machine MAC address and the hostname of the client.

Returns:

A unique cache key string.

Example:

request_mixin = SmarterRequestMixin(request)
key = request_mixin.cache_key
print(key)  # e.g., 'a1b2c3d4e5f6...'

camel_to_snake(data)

Converts camelCase strings, dictionary keys, or lists of such, to snake_case format.

Parameters:: data (str, dict, or list) – The input to convert. Can be a string, a dictionary (with camelCase keys), or a list containing strings or dictionaries.
Returns:: The converted data in snake_case format. Returns a string, dictionary, or list, matching the input type.
Return type:: Optional[Union[str, dict, list]]

Note

For dictionaries, only keys are converted. Values are preserved as-is, except for nested dictionaries, which are also converted.
Spaces in keys are replaced with underscores.
Multiple consecutive underscores are collapsed into a single underscore.
Nested dictionaries and lists are processed recursively.

Warning

If the input is not a string, dictionary, or list, a SmarterValueError is raised.

Example usage:

from smarter.common.utils import camel_to_snake

# Convert a string
print(camel_to_snake("userName"))  # Output: user_name

# Convert a dictionary
data = {
    "userName": "alice",
    "userProfile": {
        "firstName": "Alice",
        "lastName": "Smith"
    }
}
print(camel_to_snake(data))
# Output: {'user_name': 'alice', 'user_profile': {'first_name': 'Alice', 'last_name': 'Smith'}}

# Convert a list of strings
print(camel_to_snake(["firstName", "lastName"]))
# Output: ['first_name', 'last_name']

chat(request, *args, **kwargs)[source]

Handle chat operations for the API connection broker.

This method is intended to process chat requests using the manifest broker. Currently, it is not implemented and will always raise a SAMBrokerErrorNotImplemented exception. This method is not implemented. Any invocation will result in an error.

Parameters:

request ("HttpRequest") – Django HTTP request object.
args – Additional positional arguments.
kwargs – Additional keyword arguments.

Returns:

SAMBrokerErrorNotImplemented. This method always raises an exception.

Return type:

SmarterJournaledJsonResponse

See also

SAMApiConnectionBroker SmarterJournalCliCommands SAMBrokerErrorNotImplemented

Example usage:

try:
    response = broker.chat(request)
except SAMBrokerErrorNotImplemented as e:
    print("Chat not implemented:", e)

clean_cli_param(param, param_name='unknown', url=None)

Remove any leading or trailing whitespace from the param.
Ensure that the param is a string.
Return the cleaned param.

Parameters:

param (Any) – The param to clean.
param_name (str) – The name of the param, for logging purposes.
url (Optional[str]) – The url from which the param was extracted, for logging purposes.

Returns:

The cleaned param.

Return type:

Optional[str]

clear_cached_properties(): Clears all cached properties in this mixin.

property connection: ApiConnection | None

Return the Django ORM ApiConnection instance for this broker.

This property retrieves the current ApiConnection object from the database using the account and name. If the connection does not exist, it attempts to create one from the manifest data. The returned object represents the persistent state of the API connection.

Returns:: The ApiConnection ORM instance, or None if not found or not created.
Return type:: Optional[smarter.apps.plugin.models.ApiConnection]

Attention

If the connection cannot be found or created, an error is logged and None is returned.

Example usage:

connection = broker.connection
if connection:
    print(connection.base_url)
    connection.timeout = 60
    connection.save()

connection_init()[source]

Initialize the connection-related properties of the broker.

This method resets the internal state of the broker related to the ApiConnection instance and its associated secrets. It is useful when reloading or refreshing the connection data to ensure that stale references are cleared.

Returns:: None
Return type:: None

Example usage:

broker.connection_init()
connection = broker.connection

property created: bool

Return True if the broker was created successfully.

Returns:: True if the broker was created successfully.
Return type:: bool

property data: str | dict | list | None

Get the request body data as a dictionary, list or str.

Used for setting the session_key.

Returns:: The request body data as a dict, list, or str, or None if not available.

Example:

request_mixin = SmarterRequestMixin(request)
data = request_mixin.data
print(data)  # e.g., {'session_key': 'abc123', ...}

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.

delete(request, *args, **kwargs)[source]

Delete the current API connection and return a JSON response indicating the result.

This method attempts to delete the associated ApiConnection object from the database. If successful, it returns an empty JSON response. If no connection exists, or if an error occurs during deletion, an appropriate exception is raised.

Parameters:

request ("HttpRequest") – Django HTTP request object.
args – Additional positional arguments.
kwargs – Additional keyword arguments.

Returns:

JSON response indicating deletion success.

Return type:

SmarterJournaledJsonResponse

Raises:

SAMBrokerErrorNotReady – If no connection is found to delete.
SAMConnectionBrokerError – If an error occurs during deletion.

Error

Any exception during deletion is wrapped and raised as SAMConnectionBrokerError.

See also

ApiConnection SmarterJournaledJsonResponse SAMApiConnectionBroker.connection()

Example usage:

response = broker.delete(request)
print(response.data)

deploy(request, *args, **kwargs)[source]

Handle deploy operations for the API connection broker. This is not implemented and will always raise a SAMBrokerErrorNotImplemented exception.

Parameters:

request ("HttpRequest") – Django HTTP request object.
args – Additional positional arguments.
kwargs – Additional keyword arguments.

Returns:

SAMBrokerErrorNotImplemented. This method always raises an exception.

Return type:

SmarterJournaledJsonResponse

describe(request, *args, **kwargs)[source]

Return a JSON response containing the manifest data for the current API connection.

This method serializes the manifest and connection details, including metadata, specification, and status, into a structured JSON response. It validates the connection and includes relevant fields such as connection string and validity status.

Parameters:

request ("HttpRequest") – Django HTTP request object.
args – Additional positional arguments.
kwargs – Additional keyword arguments.

Returns:

JSON response with manifest data.

Return type:

SmarterJournaledJsonResponse

Raises:

SAMBrokerErrorNotReady – If no connection is found
SAMConnectionBrokerError – if serialization or validation fails.

See also

SAMApiConnection ApiConnection SmarterJournaledJsonResponse SAMApiConnectionBroker.connection()

Example usage:

response = broker.describe(request)
print(response.data)

property domain: str | None

Extracts the domain from the URL.

Returns:: The domain or None if not found.

examples:

- https://hr.3141-5926-5359.alpha.api.example.com/chatbot/
  returns 'hr.3141-5926-5359.alpha.api.example.com'

eval_chatbot_url()

If we are a chatbot, based on analysis of the URL format then we need to make a follow up check of the user and account.

Examples

1.) For named urls, we extract the account number from the url,: then we load the account and admin user for that account.
2.) For smarter api urls, we would extract the chatbot id from the url,: then we would load the chatbot, account, and admin user for that account.
3.) For cli api urls, we would extract the chatbot name from the url,: then we would load the chatbot, account, and admin user for that account.

example_manifest(request, *args, **kwargs)[source]

Return an example ApiConnection manifest.

This method generates and returns a sample manifest for an ApiConnection, including all required fields and example values for authentication, connection, and metadata. The manifest is validated using the Pydantic model and returned as a JSON response.

Parameters:

request ("HttpRequest") – Django HTTP request object.
args – Additional positional arguments.
kwargs – Additional keyword arguments.

Returns:

JSON response containing the example manifest.

Return type:

SmarterJournaledJsonResponse

See also

SAMApiConnection ApiConnection ApiConnectionSerializer AuthMethods SAMKeys SAMMetadataKeys SAMApiConnectionSpecConnectionKeys SmarterJournalCliCommands

Example usage:

response = broker.example_manifest(request)
print(response.data)

find_session_key()

Returns the unique chat session key value for this request.

The session_key is managed by the /config/ endpoint for the chatbot. The React app calls this endpoint at app initialization to get a JSON dict that includes, among other info, this session_key, which uniquely identifies the device and the individual chatbot session for the device.

For subsequent chat prompt requests, the session_key is intended to be sent in the body of the request as a key-value pair, e.g. {“session_key”: “1234567890”}.

This method will also check the request headers and cookies for the session_key. The session key can be found in one of the following:

URL parameter: http://localhost:9357/workbench/example/config/?session_key=1aeee4c1f183354247f43f80261573da921b0167c7c843b28afd3cb5ebba0d9a

Request JSON body: {‘session_key’: ‘1aeee4c1f183354247f43f80261573da921b0167c7c843b28afd3cb5ebba0d9a’}

Request header: {‘session_key’: ‘1aeee4c1f183354247f43f80261573da921b0167c7c843b28afd3cb5ebba0d9a’}

Cookie

A session_key generator

Return type:: Optional[str]
Returns:: The session key as a string, or None if not found.

property formatted_class_name: str

Returns the formatted class name for logging purposes.

This property generates a human-readable class name string for use in log messages, making it easier to identify the source of log entries. It appends the specific broker class to the parent class name for clarity.

Returns:: Formatted class name string for logging.
Return type:: str

Important

Use this property in log statements to improve traceability and debugging.

Example usage:

logger.info("%s: operation started", broker.formatted_class_name)

property formatted_class_name_cache_invalidations: str

Return the logger prefix for the AbstractBroker cache invalidations.

Returns:: The logger prefix for the AbstractBroker cache invalidations.
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

generate_session_key()

Generate a session_key based on a unique string and the current datetime.

Return type:: str
Returns:: A unique session key string.

get(request, *args, **kwargs)[source]

Retrieve a list of ApiConnection objects as a journaled JSON response.

This method queries the database for ApiConnection instances matching the current account and optional name filter, serializes each result, and returns a structured JSON response including metadata, item count, and model titles.

Parameters:

request ("HttpRequest") – Django HTTP request object.
args – Additional positional arguments.
kwargs (dict) – Optional keyword arguments, such as name to filter connections.

Returns:

Journaled JSON response containing serialized ApiConnection data.

Return type:

SmarterJournaledJsonResponse

See also

ApiConnection ApiConnectionSerializer SmarterJournaledJsonResponse SAMApiConnectionBroker.SerializerClass()

Example usage:

response = broker.get(request)
print(response.data)

# Filter by name
response = broker.get(request, name="my_connection")
print(response.data)

get_cookie_value(cookie_name)

Retrieve the value of a cookie from the request object.

Parameters:

request – Django HttpRequest object
cookie_name – Name of the cookie to retrieve

Returns:

Value of the cookie or None if the cookie does not exist

get_model_titles(serializer)

For tabular output from get() implementations. Returns a list of field names and types from the Django model serializer.

Parameters:: serializer (ModelSerializer) – The Django model serializer instance.
Returns:: A list of field names and types.
Return type:: Optional[list[dict[str, str]]]

get_or_create_secret(user_profile, name, value=None, description=None, expiration=None)

Get or create a Smarter Secret in the database. This is used to store secrets that are passed in the manifest.

Parameters:

user_profile (UserProfile) – The UserProfile to associate the secret with.
name (str) – The name of the secret.
value (Optional[str]) – The value of the secret.
description (Optional[str]) – A description of the secret.
expiration (Optional[datetime]) – The expiration date of the secret.

Returns:

The created or retrieved Secret object.

Return type:

Secret

invalidate_cached_properties()

Invalidates all cached properties on the instance to force re-evaluation.

This method removes all attributes cached by @cached_property decorators from the instance’s __dict__. It is useful for testing or when the request object changes and you need to ensure that all dependent properties are recalculated.

Example:

from smarter.lib.django.request import SmarterRequestMixin

class Foo(SmarterRequestMixin):
    pass

foo = Foo(request)
foo.invalidate_cached_properties(request)

Raises:: None –

property ip_address: str | None

Get the client’s IP address from the request object.

This property attempts to extract the IP address from the request’s META dictionary, using the “REMOTE_ADDR” key. If the IP address is not available, it returns None.

Returns:: The client’s IP address as a string, or None if not found.
Return type:: Optional[str]

Example:

request_mixin = SmarterRequestMixin(request)
ip = request_mixin.ip_address
print(ip)  # e.g., '192.168.1.100'

property is_accountmixin_ready: bool

Returns True if the AccountMixin is ready to be used. This is a convenience property that checks if the account and user are initialized. AccountMixin is considered ready if: - self.user is an instance of User - self.user_profile is an instance of UserProfile - self.account is an instance of Account

Returns:: True if the AccountMixin is ready to be used.
Return type:: bool

property is_authenticated: bool: Returns True if the request is authenticated, False otherwise.

property is_chatbot: bool

Returns True if the URL resolves to a chatbot endpoint.

Conditions are checked in a lazy sequence to avoid unnecessary processing.

Examples

http://localhost:9357/api/v1/prompt/1/chat/
http://localhost:9357/api/v1/cli/chat/example/
http://example.3141-5926-5359.api.localhost:9357/
http://localhost:9357/api/v1/chatbots/1556/chat/
http://localhost:9357/workbench/chatbots/<str:hashed_id>/chat/
http://localhost:9357/workbench/chatbots/<str:hashed_id>/config/
http://localhost:9357/workbench/chatbots/<str:hashed_id>/manifest/

Returns:: True if the URL is a chatbot endpoint, otherwise False.
Return type:: bool

property is_chatbot_cli_api_url: bool

9357/api/v1/cli/chat/example/.

The expected path parts are:: [‘api’, ‘v1’, ‘cli’, ‘chat’, ‘example’]

Returns:: True if the URL matches the CLI chatbot API pattern, otherwise False.
Return type:: bool
Type:: Returns True if the URL is of the form http
Type:: //localhost

property is_chatbot_named_url: bool

Returns True if the url is of the form:

https://example-username.3141-5926-5359.api.example.com/

http://example-username.3141-5926-5359.api.localhost:9357/

http://example-username.3141-5926-5359.api.localhost:9357/config/

Returns:: True if the URL matches the named chatbot pattern, otherwise False.
Return type:: bool

property is_chatbot_sandbox_url: bool

Example URLs for chatbot sandbox endpoints.

Examples

Web console urls: - http://localhost:9357/workbench/chatbots/<str:hashed_id>/chat/ - http://localhost:9357/workbench/chatbots/<str:hashed_id>/config/ - http://localhost:9357/workbench/chatbots/<str:hashed_id>/manifest/

Api urls: - http://localhost:9357/api/v1/prompt/1/chat/ - http://localhost:9357/api/v1/prompt/1/config/

Manifest view urls: https://alpha.platform.smarter.sh/workbench/chatbots/hashed_id/ https://<environment_domain>/workbench/chatbots/<str:hashed_id>/ path_parts: [‘workbench’, ‘chatbots’, ‘rxy123hashedx’]

Returns:: True if the URL matches a chatbot sandbox endpoint, otherwise False.
Return type:: bool

property is_chatbot_smarter_api_url: bool

Returns True if the URL is of the form:

http://localhost:9357/api/v1/chatbots/32/config/
http://localhost:9357/api/v1/workbench/1/chat/ path_parts: [‘api’, ‘v1’, ‘workbench’, ‘<int:pk>’, ‘chat’]
http://localhost:9357/api/v1/chatbots/1556/chat/ path_parts: [‘api’, ‘v1’, ‘chatbots’, ‘<int:pk>’, ‘chat’]

Returns:: True if the URL matches a smarter API chatbot endpoint, otherwise False.
Return type:: bool

property is_config: bool

Returns True if the URL resolves to a config endpoint.

Examples

http://testserver/api/v1/cli/chat/config/testc7098865f39202d5/ http://localhost:9357/workbench/example/config/?session_key=1aeee4c1f183354247f43f80261573da921b0167c7c843b28afd3cb5ebba0d9a http://localhost:9357/api/v1/workbench/<int:chatbot_id>/chat/config/ http://example.api.localhost:9357/config

Returns:: True if the URL is a config endpoint, otherwise False.
Return type:: bool

property is_dashboard: bool

Returns True if the URL resolves to a dashboard endpoint.

Returns:: True if the URL is a dashboard endpoint, otherwise False.
Return type:: bool

property is_default_domain: bool

Returns True if the URL is the default domain for the environment.

Example

api.alpha.platform.smarter.sh

Returns:: bool: True if the URL is the default environment domain, otherwise False.

property is_environment_root_domain: bool

Returns True if the URL resolves to the environment root domain.

Returns:: True if the URL is the environment root domain, otherwise False.
Return type:: bool

is_internal_api_request(request)

Check if the request is an internal API request.

This method checks for a custom attribute on the request object that indicates whether the request is an internal API request. This can be used to bypass certain authentication or permission checks for internal requests.

Parameters:: request (HttpRequest) – The Django request object.
Returns:: True if it’s an internal API request, False otherwise.
Return type:: bool

property is_ready_abstract_broker: bool

Return True if the AbstractBroker is ready for operations.

An AbstractBroker is considered ready if: - The AccountMixin is ready. - The RequestMixin is ready. - either a valid manifest is loaded or a ready SAMLoader is present.

Returns:: True if the AbstractBroker is ready for operations.
Return type:: bool

property is_requestmixin_ready: bool

Returns True if the request mixin is ready for processing. This is a convenience property to check if the request is ready.

Returns:: True if the request mixin is ready, False otherwise.

property is_smarter_api: bool

9357/api/v1/.

Examples

path_parts: [‘api’, ‘v1’, ‘chatbots’, ‘1’, ‘chat’]
http://api.localhost:9357/

Returns:: True if the URL matches the smarter API pattern, otherwise False.
Return type:: bool
Type:: Returns True if the URL is of the form http
Type:: //localhost

property is_valid: bool

property is_workbench: bool

Returns True if the URL resolves to a workbench endpoint.

Returns:: True if the URL is a workbench endpoint, otherwise False.
Return type:: bool

json_response_err(command, e)

Return a structured error response that can be unpacked and rendered by the cli in a variety of formats.

Parameters:

command (SmarterJournalCliCommands) – The command that was executed.
e (Exception) – The exception that was raised.

Returns:

A SmarterJournaledJsonResponse containing the error response.

Return type:

SmarterJournaledJsonResponse

json_response_err_notfound(command, message=None)

Return a common not found response.

Parameters:

command (SmarterJournalCliCommands) – The command that was executed.
message (Optional[str]) – An optional custom message to include in the response.

Returns:

A SmarterJournaledJsonResponse containing the not found response.

Return type:

SmarterJournaledJsonResponse

json_response_err_notimplemented(command)

Return a common not implemented response.

Parameters:: command (SmarterJournalCliCommands) – The command that was executed.
Returns:: A SmarterJournaledJsonResponse containing the not implemented response.
Return type:: SmarterJournaledJsonResponse

json_response_err_notready(command)

Return a common not ready response.

Parameters:: command (SmarterJournalCliCommands) – The command that was executed.
Returns:: A SmarterJournaledJsonResponse containing the not ready response.
Return type:: SmarterJournaledJsonResponse

json_response_err_readonly(command)

Return a common read-only response.

Parameters:: command (SmarterJournalCliCommands) – The command that was executed.
Returns:: A SmarterJournaledJsonResponse containing the read-only response.
Return type:: SmarterJournaledJsonResponse

json_response_ok(command, data=None, message=None)

Return a common success response.

Parameters:

command (SmarterJournalCliCommands) – The command that was executed.
data (Optional[dict]) – The data to return in the response.
message (Optional[str]) – An optional message to include in the response.

Returns:

A SmarterJournaledJsonResponse containing the success response.

Return type:

SmarterJournaledJsonResponse

property kind: str

The kind of manifest.

Returns:: The kind of manifest.
Return type:: Optional[str]

kind_setter(value)

Set the kind of manifest. Validates that the kind is a valid SmarterJournalThings value.

Raises:: SmarterValueError – If the kind is not valid.
Parameters:: value (str) – The kind of manifest to set.

property loader: SAMLoader | None

The SAMLoader instance for this broker.

Returns:: The SAMLoader instance for this broker.
Return type:: Optional[SAMLoader]

log_abstract_broker_state()

Log the current state of the AbstractBroker instance for debugging purposes.

Returns:: None

log_account_mixin_ready_status(): Logs the ready status of the AccountMixin.

log_request_mixin_ready_status(): Logs the ready status of the SmarterRequestMixin.

logs(request, *args, **kwargs)[source]

Handle logs operations for the API connection broker. This is not implemented and will always raise a SAMBrokerErrorNotImplemented exception.

Parameters:

request ("HttpRequest") – Django HTTP request object.
args – Additional positional arguments.
kwargs – Additional keyword arguments.

Returns:

SAMBrokerErrorNotImplemented. This method always raises an exception.

Return type:

SmarterJournaledJsonResponse

property manifest: SAMApiConnection | None

Returns the manifest as a Pydantic model representing the Smarter API ApiConnection manifest.

This property initializes and returns a SAMApiConnection Pydantic model using data loaded from the manifest loader. The manifest loader provides the manifest’s API version, kind, metadata, spec, and status, which are passed to the model constructor.

The top-level manifest model must be explicitly initialized, while child models (such as metadata, spec, and status) are automatically cascade-initialized by Pydantic, passing the relevant data to each child’s constructor.

If the loader’s manifest kind does not match the expected kind, a warning is logged and the manifest is not initialized.

Returns:: The manifest as a SAMApiConnection Pydantic model, or None if not initialized.
Return type:: Optional[SAMApiConnection]

manifest_setter(value)

Set the manifest for the broker and override all AbstractBroker model properties based on the manifest data.

Parameters:: value (Optional[Union[AbstractSAMBase, dict]]) – The manifest to set, either as a Pydantic model or a dictionary.

manifest_to_django_orm()[source]

Transform the Smarter API User manifest into a Django ORM model.

This method converts the validated manifest data into a dictionary suitable for creating or updating a Django ORM ApiConnection instance. It handles field mapping, type conversion, and secret resolution for sensitive fields such as API keys and proxy passwords.

Returns:: Dictionary of ORM-compatible fields for an ApiConnection model.
Return type:: dict

Note

The returned dictionary includes all required fields for ORM persistence, with secrets resolved to their database IDs.
The method automatically converts camelCase keys to snake_case for Django compatibility.

Raises:: SAMConnectionBrokerError – If the manifest or its spec is missing or malformed

Example usage:

orm_data = broker.manifest_to_django_orm()
connection = ApiConnection(**orm_data)
connection.save()

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

property name: str | None

Retrieve the unique name identifier for the ChatBot instance managed by this broker.

This property accesses the name used to distinguish the ChatBot within the database and across the Smarter platform. The name is first returned from an internal cache if available. If not cached, and if a manifest is present, the name is extracted from the manifest’s metadata and stored for subsequent access.

The name is essential for database queries, model lookups, and for associating related resources such as API keys, plugins, and functions with the correct ChatBot instance.

Returns:: The name of the ChatBot as a string, or None if the name is not set or cannot be determined.
Return type:: Optional[str]

Note

The name property is a critical identifier used throughout the broker to ensure correct mapping between manifest data and persistent application state.

name_cached_property_setter(value)

A workaround to the limitation that you cannot use both @cached_property and a setter for the same attribute name (name). In Python, you cannot have a property (or cached_property) and a setter with the same name unless you use the @property decorator (not @cached_property).

We need the cached_property so that the lazy evaluation of the name only happens once, and subsequent accesses return the cached value for performance. However, we also need to be able to set the name explicitly in some cases,

Parameters:: value (str) – The name to set for the manifest.

property orm_instance: MetaDataWithOwnershipModel | None

Return the Django ORM model instance for the broker. There are multiple strategies to retrieve the ORM instance:

If the instance is already cached in self._orm_instance, return it.
If the broker is not ready or the name is not set, log a warning and return None.
Attempt to retrieve the ORM instance using the user_profile and name. If not found, attempt to retrieve using the admin user_profile for the account. If still not found, attempt to retrieve using the Smarter platform admin user_profile.
Cache the retrieved instance for future access.

Returns:: The Django ORM model instance for the broker.
Return type:: Optional[MetaDataWithOwnershipModel]

property orm_meta_instance: MetaDataWithOwnershipModel | None

Return the Django ORM meta model instance for the broker. This is a cached property that retrieves the ORM meta instance based on the user_profile and kind. For simple relational models, the ORM meta class is the same as the ORM class, and the meta instance is the same as the ORM instance.

This property is used for resolving more complex ORM relationships where the name and user_profile fields are stored in a parent Django model.

orm_meta_instance_setter()

Initialize the ORM metadata for the broker instance.

This method attempts to initialize the ORM metadata by querying the ORMMetaModelClass using the broker’s name and user_profile. If the ORM metadata is successfully retrieved, it is stored in the orm_meta_instance attribute. If the ORM metadata does not exist or an error occurs, the _orm_instance attribute is set to None.

Return type:: None
Returns:: None

property params: QueryDict | None

Return the query parameters from the url of the request. there are two scenarios to consider: 1. the request is a Django HttpRequest object (the expected case) 2. the request is a Python PreparedRequest object (the edge case)

Returns:: The query parameters from the url of the request.
Return type:: Optional[QueryDict]

property parsed_url: ParseResult | None

Expose the private ParseResult URL object as a public property.

Returns:: The parsed URL as a ParseResult object.

Example:

request_mixin = SmarterRequestMixin(request)
parsed = request_mixin.parsed_url
print(parsed.netloc)  # e.g., 'example.com'

pascal_to_snake(name)

Converts a PascalCase string to pascal_case snake_case format.

Parameters:: name (str) – The PascalCase string to convert.
Returns:: The converted string in snake_case format.
Return type:: str

Note

Spaces in the input string are replaced with underscores.
Multiple consecutive underscores are collapsed into a single underscore.

Example usage:

from smarter.common.utils import pascal_to_snake

print(pascal_to_snake("UserProfile"))  # Output: user_profile
print(pascal_to_snake("FirstName LastName"))  # Output: first_name_last_name

property path: str | None

Extracts the path from the URL.

Returns:: Optional[str]: The path as a string, or None if not found.

Examples

https://hr.3141-5926-5359.alpha.api.example.com/chatbot/ returns ‘/chatbot/’

property proxy_password_secret: Secret | None

Return the proxy password secret for the ApiConnection.

This property retrieves the Django ORM Secret instance associated with the proxy password for the current connection. It resolves the secret either from the manifest or from the existing database record, depending on initialization context.

Returns:: The Secret object representing the proxy password, or None if not found.
Return type:: Optional[Secret]

Attention

If the secret cannot be found, a warning is logged and None is returned.

Example usage:

proxy_secret = broker.proxy_password_secret
if proxy_secret:
    print(proxy_secret.value)

property qualified_request: bool

A cursory screening of the WSGI request object to look for any disqualifying conditions that confirm this is not a request that we are interested in.

The request is considered “qualified” if all of the following are true:

The request object (self._smarter_request) is present.
The URL path is present and non-empty.
The request does not originate from an internal AWS Kubernetes subnet (netloc starts with 192.168).
The path is not in the list of amnesty_urls.
The path does not start with /admin/.
The path does not start with /docs/.
The path does not end with a static file extension (e.g., .css, .js, .png, .jpg, .jpeg, .gif, .svg, .woff, .woff2, .ttf, .eot, .ico).

Returns:: True if the request passes all checks and is of interest, otherwise False.

Example:

# True case: a valid chatbot request
request_mixin = SmarterRequestMixin(request)
if request_mixin.qualified_request:
    print("This is a qualified chatbot request.")

# False case: a static asset or admin/docs request
static_request = SmarterRequestMixin(static_asset_request)
if not static_request.qualified_request:
    print("This request is not of interest.")

property ready: bool

Check if the broker is ready for operations.

This property determines whether the broker has been properly initialized and is ready to perform its functions. A broker is considered ready if it has a valid manifest loaded, either from raw data, a loader, or existing Django ORM models.

Returns:: True if the broker is ready, False otherwise.
Return type:: bool

property ready_state: str

Return a string representation of the broker’s ready state.

Returns:: “READY” if the broker is ready, otherwise “NOT_READY”.
Return type:: str

property request: HttpRequest | None

Return the request object.

Returns:: The request object.
Return type:: Optional[HttpRequest]

property request_mixin_logger_prefix: str: Returns the logger prefix for the class.

property request_mixin_ready_state: str

Returns a string representation of the request mixin’s ready state.

Returns:: A string indicating whether the request mixin is ready or not.

rfc1034_compliant_str(val)

Generates a RFC 1034-compliant name string suitable for use as a DNS label or resource identifier.

Parameters:: val (str) – The input string to convert to RFC 1034-compliant format.
Returns:: A string that is: - lower case - contains only alphanumeric characters and hyphens - starts and ends with an alphanumeric character - has a maximum length of 63 characters
Return type:: str
Raises:: SmarterValueError – If the input is not a string or is empty after conversion.

Note

Underscores in the input are replaced with hyphens.
Invalid characters (anything other than a-z, 0-9, or ‘-’) are removed.
Leading and trailing hyphens are stripped.
The result is truncated to 63 characters if necessary.

Warning

This function is intended for generating DNS-safe names. It does not guarantee uniqueness or suitability for all RFC 1034 use cases.

Example usage:

from smarter.common.utils import rfc1034_compliant_str

# Basic usage
print(rfc1034_compliant_str("My_ChatBot_2025"))  # Output: my-chatbot-2025

# With special characters
print(rfc1034_compliant_str("My@Bot!_Name"))  # Output: my-bot-name

# With long input
long_name = "ThisIsAReallyLongChatBotNameThatShouldBeTruncatedToSixtyThreeCharacters_Extra"
print(rfc1034_compliant_str(long_name))  # Output: thisisareallylongchatbotnamethatshouldbetruncatedtosixtythreecharacters

rfc1034_compliant_to_snake(val)

Converts a RFC 1034-compliant name (typically used for DNS labels or resource identifiers) to a more human-readable snake_case name.

This function is useful for translating machine-friendly names (which use hyphens as word separators) into Pythonic identifiers (which use underscores).

Parameters:: val (str) – The RFC 1034-compliant name to convert. This should be a string containing only lowercase letters, numbers, and hyphens.
Returns:: The converted name in snake_case format, with hyphens replaced by underscores.
Return type:: str
Raises:: SmarterValueError – If the input is not a string.

Note

Only hyphens are replaced; other characters are preserved.
The function does not validate that the input is strictly RFC 1034-compliant. It assumes the input is already sanitized.

Warning

This function does not handle conversion of other non-alphanumeric characters. If the input contains characters other than hyphens, underscores, letters, or numbers, they will remain unchanged.

Example usage:

from smarter.common.utils import rfc1034_compliant_to_snake

# Basic conversion
print(rfc1034_compliant_to_snake("my-chatbot-2025"))
# Output: my_chatbot_2025

# Input with no hyphens
print(rfc1034_compliant_to_snake("simplelabel"))
# Output: simplelabel

# Input with multiple hyphens
print(rfc1034_compliant_to_snake("this-is-a-test-label"))
# Output: this_is_a_test_label

# Input with invalid type
try:
    rfc1034_compliant_to_snake(12345)
except SmarterValueError as e:
    print(e)
# Output: Could not convert RFC 1034 compliant name from <class 'int'>

property root_domain: str | None

Extracts the root domain from the URL.

Returns:: The root domain or None if not found.

Example:

request_mixin = SmarterRequestMixin(request)
print(request_mixin.root_domain)
# For 'https://hr.3141-5926-5359.alpha.api.example.com/chatbot/' → 'smarter.sh'
# For 'http://localhost:9357/' → 'localhost'

sam_connection_metadata()

Return the common connection metadata from the manifest.

Returns:: The connection metadata.
Return type:: SAMConnectionCommonMetadata
Raises:: NotImplementedError – If the manifest does not have connection metadata.

See also

SAMConnectionCommonMetadata

Example usage:

metadata = broker.sam_connection_metadata()

sam_connection_status()

Return the common connection status from the manifest.

Return type:: Optional[SAMConnectionCommonStatus]

schema(request, *args, **kwargs)

Return the published JSON schema for the Pydantic model.

Parameters:

request (HttpRequest) – The HTTP request object.
args – Additional positional arguments.
kwargs – Additional keyword arguments.

Returns:

A SmarterJournaledJsonResponse containing the JSON schema.

Return type:

SmarterJournaledJsonResponse

property session_key: str

Getter for the session_key property.

The session_key is a unique identifier for a chat session. It is used to identify the chat session across multiple requests. If the session_key is not already set, it attempts to find it in the URL parameters. Barring that, it generates a new one.

Returns:: The session key as a string.

Example:

request_mixin = SmarterRequestMixin(request)
session_key = request_mixin.session_key
print(session_key)  # e.g., '38486326c21ef4bcb7e7bc305bdb062f16ee97ed8d2462dedb4565c860cd8ecc'

set_and_verify_name_param(*args, command=None, **kwargs)

Set self.name from the ‘name’ query string param and then verify that it was actually passed.

Parameters:: command (Optional[SmarterJournalCliCommands]) – The command being executed, for error reporting purposes.
Raises:: SAMBrokerErrorNotReady – If neither a manifest nor a name param is provided.
Returns:: None

set_is_internal_api_request(request, value=True)

Set the internal API request attribute on the request object.

This method allows you to mark a request as an internal API request by setting a custom attribute on the request object. This can be used in middleware or views to indicate that the request should be treated as internal.

Parameters:

request (HttpRequest) – The Django request object.
value (bool) – The value to set for the internal API request attribute (default is True).

Returns:

The modified Django request object.

Return type:

HttpRequest

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.

property smarter_request: Request | HttpRequest | WSGIRequest | MagicMock | None

Returns the current request object.

This property is named to avoid potential name collisions in child classes. This property is preferred over standard Django request types in that it more elegantly resolves idiosyncratic usage like Unit tests, Sphinx docs, and other non-standard request objects.

Example:

request_mixin = SmarterRequestMixin(request)
req = request_mixin.smarter_request

Returns:: The current request object.

property smarter_request_chatbot_id: int | None

Extract the chatbot id from the URL.

Example

http://localhost:9357/workbench/chatbots/rMTAwMDAyNwx/chat/

returns the pk id that when decoded from the hashed ID format corresponds to the chatbot id.

Returns:: The chatbot id as an integer, or None if not found.

property smarter_request_chatbot_name: str | None

Extract the chatbot name from the URL.

Example

http://example.3141-5926-5359.api.localhost:9357/config

returns “example”

Returns:: The chatbot name as a string, or None if not found.

property smarter_request_user: AnonymousUser | User | None

Returns the user associated with the request

This property is named to avoid potential name collisions in child classes. It retrieves the user from the request object if available.

Example:

request_mixin = SmarterRequestMixin(request)
user = request_mixin.smarter_request_user

Returns:: The user associated with the request, or None if not available.

snake_to_camel(data, convert_values=False)

Converts snake_case strings, dictionary keys, or lists of such, to camelCase format.

Parameters:

data (str, dict, or list) – The input to convert. Can be a string, a dictionary (with snake_case keys), or a list containing strings or dictionaries.
convert_values (bool, optional) – If True, string values within dictionaries are also converted to camelCase. Default is False.

Returns:

The converted data in camelCase format. Returns a string, dictionary, or list, matching the input type.

Return type:

Optional[Union[str, dict, list]]

Note

For dictionaries, only keys are converted by default. If convert_values is set, string values are also converted.
Nested dictionaries and lists are processed recursively.

Warning

If the input is not a string, dictionary, or list, a SmarterValueError is raised.

Example usage:

from smarter.common.utils import snake_to_camel

# Convert a string
print(snake_to_camel("user_name"))  # Output: userName

# Convert a dictionary
data = {
    "user_name": "alice",
    "user_profile": {
        "first_name": "Alice",
        "last_name": "Smith"
    }
}
print(snake_to_camel(data))
# Output: {'userName': 'alice', 'userProfile': {'firstName': 'Alice', 'lastName': 'Smith'}}

# Convert a list of strings
print(snake_to_camel(["first_name", "last_name"]))
# Output: ['firstName', 'lastName']

# Convert values as well
data = {"user_name": "first_name"}
print(snake_to_camel(data, convert_values=True))
# Output: {'userName': 'firstName'}

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

property subdomain: str | None

Extracts the subdomain from the URL.

Returns:: The subdomain or None if not found.

Example:

request_mixin = SmarterRequestMixin(request)
sub = request_mixin.subdomain
print(sub)  # e.g., 'hr.3141-5926-5359.alpha' for
            # 'https://hr.3141-5926-5359.alpha.api.example.com/chatbot/'

property thing: SmarterJournalThings

The Smarter Journal Thing for this broker.

Returns:: The Smarter Journal Thing for this broker.
Return type:: SmarterJournalThings, an enumeration of all Smarter AI resource types.

property timestamp

Create a consistent timestamp based on the time that this object was instantiated.

Returns:: The timestamp as a datetime object.

Example:

request_mixin = SmarterRequestMixin(request)
ts = request_mixin.timestamp
print(ts)  # e.g., 2025-12-01 12:34:56.789012

to_json()

Serialize the broker instance to a JSON string.

Returns:: A JSON string representation of the broker instance.
Return type:: str

property uid: str | None

Unique identifier for the client.

This is assumed to be a combination of the machine MAC address and the hostname.

Returns:: The client UID as a string, or None if not available.

Example:

request_mixin = SmarterRequestMixin(request)
uid = request_mixin.uid
print(uid)  # e.g., '00:1A:2B:3C:4D:5E-myhost'

undeploy(request, *args, **kwargs)[source]

Handle undeploy operations for the API connection broker. This is not implemented and will always raise a SAMBrokerErrorNotImplemented exception.

Parameters:

request ("HttpRequest") – Django HTTP request object.
args – Additional positional arguments.
kwargs – Additional keyword arguments.

Returns:

SAMBrokerErrorNotImplemented. This method always raises an exception.

Return type:

SmarterJournaledJsonResponse

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.

property unique_client_string: str

Generate a unique string based on several request attributes.

This string is used for generating session_key and client_key.

The unique string is composed of:

Account number
URL
User agent
IP address
Timestamp

Returns:: A unique string representing the client and request context.
Return type:: str

Example:

request_mixin = SmarterRequestMixin(request)
unique_str = request_mixin.unique_client_string
print(unique_str)

property uri: str | None

Return the full uri of the request.

Returns:: The full uri of the request.
Return type:: Optional[str]

property url: str | None

The string representation of the ParseResult object stored in _parsed_url.

Returns:: The URL as a string.

Example:

request_mixin = SmarterRequestMixin(request)
url_str = request_mixin.url
print(url_str)  # e.g., 'https://example.com/path/'

property url_account_number: str | None

Extract the account number from the URL using the pattern defined in SmarterValidator.VALID_ACCOUNT_NUMBER_PATTERN.

Example

http://example.3141-5926-5359.api.localhost:9357/config

returns “3141-5926-5359”

Returns:: The account number as a string, or None if not found.

property url_path_parts: list[str]

Extract the path parts from the URL.

Returns:: A list of strings representing each part of the URL path.

Example:

request_mixin = SmarterRequestMixin(request)
parts = request_mixin.url_path_parts
print(parts)  # e.g., ['api', 'v1', 'workbench', '1', 'chat']

property user: AnonymousUser | User | None

Returns the user for the current user. Handle lazy instantiation from user_profile or account.

Returns:: The user for the current user.
Return type:: User or None

property user_agent: str | None

Get the client’s user agent string from the request object.

This property attempts to extract the user agent from the request’s META dictionary, using the “HTTP_USER_AGENT” key. If the user agent is not available, it returns a default value.

Returns:: The client’s user agent string, or None if not found.
Return type:: Optional[str]

Example:

request_mixin = SmarterRequestMixin(request)
ua = request_mixin.user_agent
print(ua)  # e.g., 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)...'

property user_profile: UserProfile | None

Returns the user_profile for the current user. Handle lazy instantiation from user or account.

Returns:: The user_profile for the current user.
Return type:: UserProfile or None