API V1 Base Views

ChatBot api/v1/chatbots base view, for invoking a ChatBot.

class smarter.apps.chatbot.api.v1.views.base.ChatBotApiBaseViewSet(*args, **kwargs)

Bases: SmarterAuthenticatedNeverCachedWebView

Base viewset for all ChatBot API endpoints.

This class serves as the foundational viewset for all chatbot-related APIs in the Smarter platform, including prompt completions that leverage the Smarter LLM Tool Call Plugin architecture.

Key Responsibilities:

• API Key Authentication and Request Validation: Enforces authentication for all API requests, rejecting those without a valid API key.

• Lifecycle Management: Handles initialization of Account, ChatBot, ChatBotHelper, and ChatHelper objects, and manages request dispatching and routing to the appropriate handler methods.

• Plugin Discovery and Extensibility: Discovers and initializes plugins for chatbot extensibility, supporting the Smarter LLM Tool Call Plugin architecture.

• Logging and Observability: Provides robust logging and observability for all major lifecycle events, including error handling.

Django Integration:

• Subclasses Django’s view-template system (not DRF), participating in the standard request/response lifecycle.

• Overrides and extends methods such as setup(), dispatch(), get(), and post() to provide chatbot-specific logic.

• CSRF-exempt to support API clients.

Prompt Completion & LLM Tool Call Plugins:

• This base view is designed to support prompt completion endpoints that utilize Smarter’s LLM Tool Call Plugin architecture.

• Plugins can be discovered and invoked as part of the chatbot’s response generation, enabling extensible and dynamic tool use.

Examples:

• https://customer-support.3141-5926-5359.api.example.com/

• https://platform.smarter/workbench/example/

• https://platform.smarter/api/v1/workbench/1/chat/

Notes:

• Intended to be subclassed by concrete chatbot API views.

• Provides robust error handling and logging for all major operations.

• Authentication is enforced by default.

• CSRF-exempt for API compatibility.

See Also:

• Django REST Framework View lifecycle: https://www.django-rest-framework.org/api-guide/views/#view-initialization

• SmarterRequestMixin for request context management.

• ChatBotHelper and ChatHelper for chatbot and chat session logic.

• Smarter LLM Tool Call Plugin architecture documentation.

__init__(*args, **kwargs)

Initialize the SmarterView with request and other arguments. This method initializes the SmarterRequestMixin with the request.

Parameters:

• args – Positional arguments, where the first argument is expected to be the HttpRequest.

• kwargs – Keyword arguments, which may include the HttpRequest under the ‘request’ key.

Returns:

None

Return type:

None

property chat_helper: ChatHelper

Returns the ChatHelper instance. Lazily initializes the ChatHelper if it hasn’t been created yet.

Returns:

The ChatHelper instance.

Return type:

ChatHelper

property chatbot

Returns the ChatBot instance. :return: The ChatBot instance. :rtype: Optional[ChatBot]

property chatbot_helper: ChatBotHelper | None

Returns the ChatBotHelper instance. Lazily initializes the ChatBotHelper if it hasn’t been created yet.

Returns:

The ChatBotHelper instance.

Return type:

Optional[ChatBotHelper]

property chatbot_id

Returns the chatbot ID.

Returns:

The chatbot ID.

Return type:

Optional[int]

dispatch(request, *args, name=None, **kwargs)

Dispatch method for the ChatBot API base viewset.

This method is invoked as part of the Django REST Framework (DRF) view lifecycle. It is responsible for preparing the viewset for request processing, including initializing the ChatBotHelper and ChatHelper instances, setting up the request context, and logging relevant information for observability and debugging.

The dispatch method performs the following key actions:

• Extracts and sets the chatbot ID from the URL parameters, if present.

• Initializes the ChatBot and Account context for the request.

• Validates the existence and readiness of the ChatBotHelper and ChatBot instances.

• Handles error conditions such as missing or invalid chatbot configuration, returning appropriate HTTP error responses.

• Loads and attaches plugins for the chatbot, if available.

• Emits signals and logs key request metadata for auditing and debugging.

• Calls the parent class’s dispatch method to continue the DRF request/response lifecycle.

Parameters:

• request (WSGIRequest) – The HTTP request object provided by Django, containing all request data, headers, and user context.

• *args – Additional positional arguments passed to the view.

• name (Optional[str]) – The name of the chatbot, if provided as a URL parameter.

• **kwargs – Additional keyword arguments passed to the view, often including URL parameters.

Returns:

A Django JsonResponse or HttpResponse object representing the result of the request, or an error response if initialization fails.

Return type:

JsonResponse or HttpResponse

Notes

• This method is a critical integration point with DRF’s request/response lifecycle.

• It ensures that all necessary context, helpers, and plugins are available before the main handler methods are called.

• Subclasses may override this method to provide additional dispatch logic, but should always call super().dispatch() to preserve base functionality.

See also

-, -

property formatted_class_name: str

Returns the class name in a formatted string along with the name of this mixin.

Returns:

Formatted class name string.

Return type:

str

functions: Optional[list[str]] = None

get(request, *args, name=None, **kwargs)

GET request handler for the Smarter Chat API. Currently, GET requests are not supported and will return a message indicating that POST should be used instead.

Parameters:

request (WSGIRequest) – The HTTP request object.

Returns:

A JsonResponse indicating that GET is not supported.

Return type:

JsonResponse

helper_logger(message)

Create a log entry

Parameters:

message (str) – The message to log.

http_method_names: list[str] = ['get', 'post', 'options']

property is_web_platform

Determine if the request is from the web platform domain.

Returns:

True if the request is from the web platform domain, False otherwise.

Return type:

bool

property name

Returns the name of the chatbot.

Returns:

The name of the chatbot.

Return type:

Optional[str]

options(request, *args, **kwargs)

OPTIONS request handler for the Smarter Chat API. Sets CORS headers to allow cross-origin requests from the Smarter environment URL.

Parameters:

request (WSGIRequest) – The HTTP request object.

plugins: Optional[List[PluginBase]] = None

post(request, *args, name=None, **kwargs)

POST request handler for the Smarter Chat API.

This method processes POST requests to the chatbot API endpoint. It determines which ChatBot instance to use based on the request’s host, supporting both default API domains and custom domains. The logic ensures that the correct ChatBot is selected for each request, and that all necessary context and helpers are available for downstream processing.

Hostname Resolution

The ChatBot instance is determined by parsing the request host. There are two supported formats:

1. URL with default API domain

   Example: https://customer-support.3141-5926-5359.api.example.com/chatbot/ - customer-support: The chatbot’s name. - 3141-5926-5359: The chatbot’s account number. - api.example.com: The default API domain.

2. URL with custom domain

   Example: https://api.example.com/chatbot/ - api.example.com: The chatbot’s custom domain. - The custom domain must be verified (ChatBotCustomDomain.is_verified == True).

The ChatBot instance hostname is determined by: chatbot.hostname == chatbot.custom_domain or chatbot.default_host

Processing Steps

• Logs key request and context information for observability.

• Validates that a ChatBot instance is available; returns an error response if not found.

• Retrieves the appropriate chat provider handler for the ChatBot.

• Ensures a valid ChatHelper instance is available; returns an error response if not found.

• Invokes the chat provider handler with the chat session, request data, plugins, and user context.

• Wraps the response in a SmarterJournaledJsonResponse for consistent API output.

param request:

The HTTP request object provided by Django, containing all request data, headers, and user context.

type request:

WSGIRequest

param *args:

Additional positional arguments passed to the view.

param name:

The name of the chatbot, if provided as a URL parameter.

type name:

Optional[str]

param **kwargs:

Additional keyword arguments passed to the view, often including URL parameters.

returns:

A structured JSON response containing the result of the chat operation, or an error response if the ChatBot or ChatHelper could not be initialized.

rtype:

SmarterJournaledJsonResponse

Notes

• This method is a critical integration point for chatbot conversations in the Smarter platform.

• It enforces domain-based routing and robust error handling for missing or invalid chatbot context.

• The response format is standardized for journaling and auditing purposes.

See also

-, -, -

setup(request, *args, **kwargs)

Set up the ChatBot API base viewset for request processing.

This method is called as part of the Django REST Framework (DRF) view lifecycle, immediately after the view instance is created and before the request is dispatched to the appropriate handler method (such as get() or post()).

The primary responsibilities of this method are to:

• Initialize the SmarterRequestMixin with the current request and any additional arguments.

• Prepare and set up the ChatBotHelper and ChatHelper instances, which are used throughout the request lifecycle for chatbot-specific logic and chat session management.

• Log key setup events for observability and debugging.

Parameters:

• request (WSGIRequest) – The HTTP request object provided by Django, containing all request data, headers, and user context.

• *args – Additional positional arguments passed to the view.

• **kwargs – Additional keyword arguments passed to the view, often including URL parameters.

Notes

• This method is a critical integration point with DRF’s request/response lifecycle.

• It ensures that all necessary context and helper objects are available before the main handler methods are called.

• Subclasses may override this method to provide additional setup logic, but should always call super().setup() to preserve base functionality.

See also

-, -, -

property url: ParseResult | None

Returns the URL of the chatbot.

Returns:

The URL of the chatbot.

Return type:

Optional[ParseResult]

smarter.apps.chatbot.api.v1.views.base.should_log(level)

Check if logging should be done based on the waffle switch.