django-spire 0.16.12__py3-none-any.whl → 0.17.0__py3-none-any.whl

django_spire/ai/admin.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django import forms
 from django.contrib import admin
 from django.urls import reverse
@@ -24,7 +26,7 @@ class AiUsageAdmin(AiUsageAdminMixin):
     search_fields = ('recorded_date',)
     ordering = ('-recorded_date',)
 
-    def get_readonly_fields(self, request, obj=None):
+    def get_readonly_fields(self, request, obj=None) -> list[str]:
         return [field.name for field in self.model._meta.fields]
 
     def view_interactions_link(

django_spire/ai/apps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.apps import AppConfig
 
 from django_spire.utils import check_required_apps

django_spire/ai/chat/admin.py

@@ -1,3 +1,7 @@
+from __future__ import annotations
+
+from typing import ClassVar
+
 from django.contrib import admin
 from django.shortcuts import reverse
 from django.utils.html import format_html
@@ -5,23 +9,25 @@ from django.utils.http import urlencode
 
 from django_spire.ai.chat import models
 
+
 @admin.register(models.Chat)
 class ChatAdmin(admin.ModelAdmin):
     list_display = ('name', 'user', 'view_chat_messages_link', 'created_datetime')
     search_fields = ('id', 'name')
-    ordering = ['-id']
+    ordering: ClassVar = ['-id']
 
-    def get_readonly_fields(self, request, obj=None):
+    def get_readonly_fields(self, request, obj=None) -> list[str]:
         return [field.name for field in self.model._meta.fields]
 
     def view_chat_messages_link(self, obj):
         count = obj.messages.count()
         url = (
-                reverse("admin:django_spire_ai_chat_chatmessage_changelist")
-                + "?"
-                + urlencode({"chat__id": f"{obj.id}"})
+            reverse("admin:django_spire_ai_chat_chatmessage_changelist")
+            + "?"
+            + urlencode({"chat__id": f"{obj.id}"})
         )
-        return format_html('<a href="%s">%s Messages</a>' % (url, count))
+
+        return format_html(f'<a href="{url}">{count} Messages</a>')
 
     view_chat_messages_link.short_description = "Messages"
 
@@ -33,13 +39,13 @@ class ChatAdmin(admin.ModelAdmin):
 class ChatMessageAdmin(admin.ModelAdmin):
     list_display = ('content_body', 'chat', 'chat__user','is_processed', 'is_viewed', 'created_datetime')
     search_fields = ('id', 'content')
-    ordering = ['-id']
+    ordering: ClassVar = ['-id']
 
-    def content_body(self, obj):
+    def content_body(self, obj) -> str:
         return str(obj)
 
     content_body.short_description = 'Body'
 
-    def get_readonly_fields(self, request, obj=None):
+    def get_readonly_fields(self, request, obj=None) -> list[str]:
         return [field.name for field in self.model._meta.fields]
 

django_spire/ai/chat/apps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.apps import AppConfig
 from django.conf import settings
 
@@ -22,6 +24,7 @@ class AiChatConfig(AppConfig):
 
     def ready(self) -> None:
         if not isinstance(getattr(settings, AI_CHAT_WORKFLOW_CLASS_SETTINGS_NAME), str):
-            raise ValueError(f'"{AI_CHAT_WORKFLOW_CLASS_SETTINGS_NAME}" must be set in the django settings when using "{self.label}".')
+            message = f'"{AI_CHAT_WORKFLOW_CLASS_SETTINGS_NAME}" must be set in the django settings when using "{self.label}".'
+            raise TypeError(message)
 
         check_required_apps(self.label)

django_spire/ai/chat/auth/controller.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 from django_spire.auth.controller.controller import BaseAuthController
 
 
 class BaseAiChatAuthController(BaseAuthController):
-    def can_delete(self):
+    def can_delete(self) -> bool:
         return self.request.user.has_perm('django_spire_ai_chat.delete_chat')

django_spire/ai/chat/choices.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.db.models import Choices
 
 

django_spire/ai/chat/intelligence/maps/intent_llm_map.py

@@ -1,7 +1,10 @@
-from dandy.llm import BaseLlmMap
-from dandy.map import Map
+from __future__ import annotations
 
+from typing import ClassVar
 
-class IntentLlmMap(BaseLlmMap):
-    map_keys_description = 'The user\'s chat intent'
-    map = Map({})
+from dandy import Decoder
+
+
+class IntentDecoder(Decoder):
+    mapping_keys_description = 'The user\'s chat intent'
+    mapping: ClassVar = {}

django_spire/ai/chat/intelligence/prompts.py

@@ -1,9 +1,11 @@
-from dandy.llm import Prompt
+from __future__ import annotations
+
+from dandy import Prompt
 
 from django_spire.conf import settings
 
 
-def organization_prompt():
+def organization_prompt() -> Prompt:
     return (
         Prompt()
         .text(f'You are a chat assistant for a company called "{settings.ORGANIZATION_NAME}".')

django_spire/ai/chat/intelligence/workflows/chat_workflow.py

@@ -1,63 +1,63 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Type
+from typing import TYPE_CHECKING
 
-from dandy.map import Map
+from dandy import Prompt, Bot
 from dandy.recorder import recorder_to_html_file
-from dandy.workflow import BaseWorkflow
-from dandy.llm import LlmBot, MessageHistory, Prompt
-from django.core.handlers.wsgi import WSGIRequest
 
-from django_spire.ai.chat.intelligence.maps.intent_llm_map import IntentLlmMap
+from django_spire.ai.chat.intelligence.maps.intent_llm_map import IntentDecoder
 from django_spire.ai.chat.intelligence.prompts import organization_prompt
 from django_spire.ai.chat.message_intel import DefaultMessageIntel
 from django_spire.auth.controller.controller import AppAuthController
-from django_spire.knowledge.intelligence.workflows.knowledge_workflow import \
-    KnowledgeWorkflow
-
 
 if TYPE_CHECKING:
+    from dandy.llm.request.message import MessageHistory
+    from django.core.handlers.wsgi import WSGIRequest
+
     from django_spire.ai.chat.message_intel import BaseMessageIntel
 
 
-class SpireChatWorkflow(BaseWorkflow):
-    @classmethod
-    def _generate_intent_map(cls, request: WSGIRequest) -> Type[IntentLlmMap]:
+class SpireChatWorkflow:
+    @staticmethod
+    def _generate_intent_decoder(request: WSGIRequest) -> IntentDecoder:
+        from django_spire.knowledge.intelligence.workflows.knowledge_workflow import KnowledgeWorkflow
+
         intent_dict = {}
 
         if AppAuthController(app_name='knowledge', request=request).can_view():
             intent_message = (
                 'The user is looking for information or knowledge on something.'
             )
+
             intent_dict[intent_message] = KnowledgeWorkflow
 
         intent_dict['None of the above choices match the user\'s intent'] = None
 
-        IntentLlmMap.map = Map(intent_dict)
-        IntentLlmMap._map_enum = IntentLlmMap.map.as_enum()
-        return IntentLlmMap
+        decoder = IntentDecoder()
+        decoder.mapping = intent_dict
+        return decoder
 
-    @classmethod
+    @staticmethod
     @recorder_to_html_file('spire_chat_workflow')
     def process(
-            cls,
-            request: WSGIRequest,
-            user_input: str,
-            message_history: MessageHistory | None = None
+        request: WSGIRequest,
+        user_input: str,
+        message_history: MessageHistory | None = None
     ) -> BaseMessageIntel:
-        intent_map = cls._generate_intent_map(request)
-        intents = intent_map.process(user_input, max_return_values=1)
+        intent_decoder = SpireChatWorkflow._generate_intent_decoder(request)
+        intents = intent_decoder.process(user_input, max_return_values=1)
+
+        bot = Bot()
 
         if intents[0] is None:
-            response = LlmBot.process(
+            return bot.llm.prompt_to_intel(
                 prompt=user_input,
+                intel_class=DefaultMessageIntel,
                 message_history=message_history,
                 postfix_system_prompt=organization_prompt()
             )
 
-            return DefaultMessageIntel(text=response.text)
-
-        response = LlmBot.process(
+        return bot.llm.prompt_to_intel(
             prompt=(
                 Prompt()
                 .text(f'User Input: {user_input}')
@@ -69,8 +69,7 @@ class SpireChatWorkflow(BaseWorkflow):
                 .line_break()
                 .text(intents[0].process(user_input))
             ),
+            intel_class=DefaultMessageIntel,
             message_history=message_history,
             postfix_system_prompt=organization_prompt()
         )
-
-        return DefaultMessageIntel(text=response.text)

django_spire/ai/chat/message_intel.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 from abc import abstractmethod, ABC
 
-from dandy.intel import BaseIntel
+from dandy import BaseIntel
 from django.template.loader import render_to_string
 
 
@@ -11,7 +13,8 @@ class BaseMessageIntel(BaseIntel, ABC):
         super().__init_subclass__()
 
         if cls._template is None or cls._template == '':
-            raise ValueError(f'{cls.__module__}.{cls.__qualname____}._template must be set')
+            message = f'{cls.__module__}.{cls.__qualname__}._template must be set'
+            raise ValueError(message)
 
     @abstractmethod
     def content_to_str(self) -> str:
@@ -32,5 +35,5 @@ class DefaultMessageIntel(BaseMessageIntel):
     _template: str = 'django_spire/ai/chat/message/default_message.html'
     text: str
 
-    def content_to_str(self):
-        return self.text
+    def content_to_str(self) -> str:
+        return self.text

django_spire/ai/chat/models.py

@@ -1,8 +1,6 @@
-import json
-from typing import Type
+from __future__ import annotations
 
-from dandy.llm import MessageHistory
-from dandy.llm.service.request.message import RoleLiteralStr
+from dandy.llm.request.message import MessageHistory, RoleLiteralStr
 from django.contrib.auth.models import User
 from django.db import models
 from django.utils.timezone import now
@@ -117,11 +115,11 @@ class ChatMessage(HistoryModelMixin):
     @property
     def intel(self):
         try:
-            intel_class: Type[BaseMessageIntel] = get_class_from_string(self._intel_class_name)
+            intel_class: type[BaseMessageIntel] = get_class_from_string(self._intel_class_name)
             return intel_class.model_validate(self._intel_data)
 
         except ImportError:
-            intel_class: Type[BaseMessageIntel] = DefaultMessageIntel
+            intel_class: type[BaseMessageIntel] = DefaultMessageIntel
             return intel_class.model_validate(
                 {'text': str(self._intel_data)}
             )
@@ -135,10 +133,11 @@ class ChatMessage(HistoryModelMixin):
     def role(self) -> RoleLiteralStr:
         if self.response_type == 'request':
             return 'user'
-        elif self.response_type == 'response':
+
+        if self.response_type == 'response':
             return 'assistant'
-        else:
-            return 'system'
+
+        return 'system'
 
     def to_message_response(self) -> MessageResponse:
         return MessageResponse(

django_spire/ai/chat/querysets.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.db.models import Q, Count
 
 from django_spire.history.querysets import HistoryQuerySet
@@ -31,4 +33,4 @@ class ChatMessageQuerySet(HistoryQuerySet):
         return self.order_by('-created_datetime')[:count]
 
     def newest_by_count_reversed(self, count: int = 20):
-        return self.order_by('-created_datetime')[:count][::-1]
+        return self.order_by('-created_datetime')[:count][::-1]

django_spire/ai/chat/responses.py

@@ -1,10 +1,16 @@
+from __future__ import annotations
+
 from dataclasses import dataclass, field
-from typing import List
+from typing import TYPE_CHECKING
 
 from django.template.loader import render_to_string
 
 from django_spire.ai.chat.choices import MessageResponseType
-from django_spire.ai.chat.message_intel import BaseMessageIntel
+
+if TYPE_CHECKING:
+    from typing import Any
+
+    from django_spire.ai.chat.message_intel import BaseMessageIntel
 
 
 @dataclass
@@ -14,7 +20,7 @@ class MessageResponse:
     message_intel: BaseMessageIntel
     synthesis_speech: bool = False
 
-    def _render_template_to_html_string(self, template: str, context_data: dict = None) -> str:
+    def _render_template_to_html_string(self, template: str, context_data: dict[str, Any] | None = None) -> str:
         return render_to_string(
             template_name=template,
             context={
@@ -25,35 +31,38 @@ class MessageResponse:
             },
         )
 
-    def render_to_html_string(self, context_data: dict = None) -> str:
+    def render_to_html_string(self, context_data: dict[str, Any] | None = None) -> str:
         if self.type == MessageResponseType.REQUEST:
             return self._render_template_to_html_string(
                 'django_spire/ai/chat/message/request_message.html',
                 context_data
             )
-        elif self.type == MessageResponseType.RESPONSE:
+
+        if self.type == MessageResponseType.RESPONSE:
             return self._render_template_to_html_string(
                 'django_spire/ai/chat/message/response_message.html',
                 context_data
             )
-        elif self.type == MessageResponseType.LOADING_RESPONSE:
+
+        if self.type == MessageResponseType.LOADING_RESPONSE:
             return self._render_template_to_html_string(
                 'django_spire/ai/chat/message/loading_response_message.html',
                 context_data
             )
-        else:
-            return ''
+
+        return ''
 
 
 @dataclass
 class MessageResponseGroup:
-    message_responses: List[MessageResponse] = field(default_factory=list)
+    message_responses: list[MessageResponse] = field(default_factory=list)
 
     def add_message_response(self, message_response: MessageResponse) -> None:
         self.message_responses.append(message_response)
 
-    def render_to_html_string(self, context_data: dict = None) -> str:
+    def render_to_html_string(self, context_data: dict[str, Any] | None = None) -> str:
         html_string = ''
+
         for message_response in self.message_responses:
             html_string += message_response.render_to_html_string(context_data)
 

django_spire/ai/chat/tools.py

@@ -1,28 +1,33 @@
+from __future__ import annotations
+
 from importlib import import_module
+from typing import TYPE_CHECKING
 
-from dandy.llm import MessageHistory
-from dandy.workflow import BaseWorkflow
 from django.conf import settings
-from django.core.handlers.wsgi import WSGIRequest
 
 from django_spire.ai.chat.message_intel import BaseMessageIntel
 from django_spire.ai.decorators import log_ai_interaction_from_recorder
 from django_spire.consts import AI_CHAT_WORKFLOW_CLASS_SETTINGS_NAME
 
+if TYPE_CHECKING:
+    from dandy.llm.request.message import MessageHistory
+    from django.core.handlers.wsgi import WSGIRequest
+
 
 def chat_workflow_process(
-        request: WSGIRequest,
-        user_input: str | None = None,
-        message_history: MessageHistory | None = None,
+    request: WSGIRequest,
+    user_input: str | None = None,
+    message_history: MessageHistory | None = None
 ) -> BaseMessageIntel:
-
     if user_input is None:
-        raise ValueError('user_input is required')
+        message = 'user_input is required'
+        raise ValueError(message)
 
     chat_workflow_class = getattr(settings, AI_CHAT_WORKFLOW_CLASS_SETTINGS_NAME)
-    
+
     if chat_workflow_class is None:
-        raise ValueError(f'"{AI_CHAT_WORKFLOW_CLASS_SETTINGS_NAME}" must be set in the django settings.')
+        message = f'"{AI_CHAT_WORKFLOW_CLASS_SETTINGS_NAME}" must be set in the django settings.'
+        raise ValueError(message)
 
     module_name = '.'.join(chat_workflow_class.split('.')[:-1])
     object_name = chat_workflow_class.split('.')[-1]
@@ -30,9 +35,10 @@ def chat_workflow_process(
     try:
         workflow_module = import_module(module_name)
     except ImportError:
-        raise ImportError(f'Could not import workflow module: {module_name}')
+        message = f'Could not import workflow module: {module_name}'
+        raise ImportError(message) from None
 
-    ChatWorkFlow: BaseWorkflow = getattr(workflow_module, object_name)
+    ChatWorkFlow = getattr(workflow_module, object_name)
 
     @log_ai_interaction_from_recorder(request.user)
     def run_workflow_process() -> BaseMessageIntel:
@@ -45,8 +51,7 @@ def chat_workflow_process(
     output_intel = run_workflow_process()
 
     if not issubclass(output_intel.__class__, BaseMessageIntel):
-        raise ValueError(
-            f'{ChatWorkFlow.__class__.__module__}.{ChatWorkFlow.__class__.__qualname__}.process must return an instance of a {BaseMessageIntel.__name__} sub class.'
-        )
+        message = f'{ChatWorkFlow.__class__.__module__}.{ChatWorkFlow.__class__.__qualname__}.process must return an instance of a {BaseMessageIntel.__name__} sub class.'
+        raise TypeError(message)
 
     return output_intel

django_spire/ai/chat/urls/message_urls.py

@@ -1,7 +1,8 @@
-from django.urls import path, include
+from django.urls import include, path
 
 from django_spire.ai.chat.views import message_views
 
+
 app_name = 'message'
 
 urlpatterns = [

django_spire/ai/chat/urls/page_urls.py

@@ -2,6 +2,7 @@ from django.urls import path
 
 from django_spire.ai.chat.views import page_views
 
+
 app_name = 'page'
 
 urlpatterns = [

django_spire/ai/chat/views/message_request_views.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from django.conf import settings

django_spire/ai/chat/views/message_response_views.py

@@ -1,9 +1,10 @@
+from __future__ import annotations
+
 import json
 
 from django.conf import settings
 from django.http import HttpResponse
 
-from django_spire.ai.chat.message_intel import DefaultMessageIntel
 from django_spire.ai.chat.models import Chat
 from django_spire.ai.chat.responses import MessageResponse
 from django_spire.ai.chat.choices import MessageResponseType
@@ -17,9 +18,8 @@ def response_message_render_view(request):
     chat_workflow_name = getattr(settings, AI_CHAT_WORKFLOW_SENDER_SETTINGS_NAME)
 
     if chat_workflow_name is None:
-        raise ValueError(
-            f'"{AI_CHAT_WORKFLOW_SENDER_SETTINGS_NAME}" must be set in the django settings.'
-        )
+        message = f'"{AI_CHAT_WORKFLOW_SENDER_SETTINGS_NAME}" must be set in the django settings.'
+        raise ValueError(message)
 
     chat = Chat.objects.by_user(request.user).get(id=body_data['chat_id'])
 

django_spire/ai/chat/views/message_views.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.http import HttpResponse
 
 from django_spire.ai.chat.models import Chat

django_spire/ai/chat/views/page_views.py

@@ -1,10 +1,15 @@
-from django.core.handlers.wsgi import WSGIRequest
-from django.template.response import TemplateResponse
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 
 from django_spire.auth.controller.controller import AppAuthController
 from django_spire.contrib import Breadcrumbs
 from django_spire.contrib.generic_views import portal_views
 
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.template.response import TemplateResponse
+
 
 @AppAuthController('ai_chat').permission_required('can_delete')
 def home_view(request: WSGIRequest) -> TemplateResponse:

django_spire/ai/chat/views/template_views.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from django.template.response import TemplateResponse

django_spire/ai/decorators.py

@@ -1,21 +1,27 @@
+from __future__ import annotations
+
 import json
 import traceback
 import uuid
 
-from dandy.recorder import Recorder
-from django.contrib.auth.models import AbstractBaseUser
+from typing import TYPE_CHECKING
+
+from dandy import Recorder
 from django.utils.timezone import now
-from typing_extensions import Any
 
 from django_spire.ai.models import AiInteraction, AiUsage
 
+if TYPE_CHECKING:
+    from django.contrib.auth.models import AbstractBaseUser
+
 
 def log_ai_interaction_from_recorder(
-        user: AbstractBaseUser | None = None,
-        actor: str | None = None,
+    user: AbstractBaseUser | None = None,
+    actor: str | None = None
 ):
     if user is None and actor is None:
-        raise ValueError('user or actor must be provided')
+        message = 'user or actor must be provided'
+        raise ValueError(message)
 
     def decorator(func):
         def wrapper(*args, **kwargs):
@@ -48,7 +54,7 @@ def log_ai_interaction_from_recorder(
 
                 ai_interaction.stack_trace = stack_trace
 
-                raise e
+                raise
 
             finally:
                 Recorder.stop_recording(recording_uuid)

django_spire/ai/mixins.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.db import models
 
 from django.contrib import admin
@@ -14,7 +16,7 @@ class AiUsageMixin(models.Model):
 
 
 class AiUsageAdminMixin(admin.ModelAdmin):
-    def run_time_seconds_formatted(self, obj):
+    def run_time_seconds_formatted(self, obj) -> str:
         return f"{obj.run_time_seconds:.3f}s"
 
-    run_time_seconds_formatted.short_description = 'Run Time'
+    run_time_seconds_formatted.short_description = 'Run Time'

django_spire/ai/models.py

@@ -1,4 +1,6 @@
-from django.contrib.auth.models import Group, User
+from __future__ import annotations
+
+from django.contrib.auth.models import User
 from django.db import models
 from django.utils.formats import localize
 from django.utils.timezone import now
@@ -53,14 +55,17 @@ class AiInteraction(AiUsageMixin):
     def __str__(self):
         return f'"{self.actor}" interaction on "{localize(self.created_datetime)}"'
 
-    def save(self, *args, **kwargs):
+    def save(self, *args, **kwargs) -> None:
         if self.user:
             if self.actor is None:
                 self.actor = self.user.get_full_name()
+
             if self.user_email is None:
                 self.user_email = self.user.email
+
             if self.user_first_name is None:
                 self.user_first_name = self.user.first_name
+
             if self.user_last_name is None:
                 self.user_last_name = self.user.last_name