Workbench View

PromptWorkbenchView is a Django class-based view responsible for serving the main prompt application page within the Smarter dashboard web app.

It hosts Smarter Chat, the React app of the LLMClient prompt workbench, as the web console hosts all of its React apps: the template includes the app’s Vite build assets from Django’s static files, and renders the app’s root element, whose attributes configure it. The React app then takes over the UI from there.

class smarter.apps.prompt.views.detailviews.prompt_workbench_view.PromptWorkbenchView(**kwargs)[source]

Bases: SmarterAuthenticatedNeverCachedWebView

Prompt app view for the Smarter web application.

This view is responsible for serving the main prompt application page within the Smarter dashboard web app. It hosts Smarter Chat, a React app that is built with Vite into Django’s static files, like every other React app of the web console. The React app then takes over the UI from there.

Key Features:

Django Template Integration: The view renders react/smarter-chat.html, whose react_smarter_chat template tag includes the React app’s hashed JavaScript and CSS files, from its Vite manifest.json, and whose root div passes the app its configuration as attributes.
ReactJS UI Bootstrapping: The React app (https://github.com/smarter-sh/smarter-chat, cloned into smarter/react/packages/smarter-chat) renders the interactive prompt UI after the initial page load.
Flexible URL Patterns: The view supports both sandbox and production URL formats, allowing it to work with deployed and not-yet-deployed LLMClients.
Authentication Protected: This view requires the user to be authenticated. If the user is not authenticated, access is denied.
Cache Control: The view uses Django’s never_cache decorator to ensure that the browser does not cache the prompt page itself. This prevents issues where a user logs out and then logs back in without a full page refresh.

Example Usage:

Sandbox mode:

http://smarter.sh/workbench/hr/

http://127.0.0.1:9357/workbench/<str:name>/

Production mode:

https://hr.3141-5926-5359.alpha.api.example.com/workbench/

Returns:

Renders the Django template for the prompt app, with the React app’s assets and configuration context.

See Also:

PromptConfigView — for the endpoint that provides configuration data to the React app.

dispatch(request, *args, **kwargs)[source]

Dispatch method to handle the request for the main prompt application page.

This method is responsible for preparing and serving the Django template that bootstraps the ReactJS prompt UI within the Smarter dashboard web app. It passes the React app’s configuration to the template, which renders it as the attributes of the app’s root element.

Key Features:

Django Template Integration: Uses Django’s template system to render the main prompt page, with the React app’s build assets and root div.
ReactJS UI Bootstrapping: The template includes the React build (JavaScript and CSS) from Django’s static files. The React app then takes over rendering the interactive prompt UI after the initial page load.
Flexible URL Patterns: Supports both sandbox and production URL formats, allowing the view to work with both deployed and not-yet-deployed LLMClients.
Authentication Protected: Requires the user to be authenticated. If the user is not authenticated, access is denied.
Cache Control: Uses Django’s never_cache decorator to prevent the browser from caching the prompt page, ensuring session security.

Parameters:

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

Returns:

Renders the Django template for the prompt app, with the React app’s assets and configuration context.

Return type:

HttpResponse