django-spire 0.23.4__py3-none-any.whl

django_spire/ai/admin.py

@@ -0,0 +1,127 @@
+from __future__ import annotations
+
+from django import forms
+from django.contrib import admin
+from django.urls import reverse
+from django.utils.html import format_html
+from django.utils.http import urlencode
+
+from django_spire.ai import models
+from django_spire.ai.mixins import AiUsageAdminMixin
+from django_spire.core.forms.widgets import JsonTreeWidget
+
+
+@admin.register(models.AiUsage)
+class AiUsageAdmin(AiUsageAdminMixin):
+    list_display = (
+        'recorded_date',
+        'was_successful',
+        'event_count',
+        'token_usage',
+        'run_time_seconds_formatted',
+        'view_interactions_link',
+        'view_successful_interactions_link',
+        'view_failed_interactions_link'
+    )
+    search_fields = ('recorded_date',)
+    ordering = ('-recorded_date',)
+
+    def get_readonly_fields(self, request, obj=None) -> list[str]:
+        return [field.name for field in self.model._meta.fields]
+
+    def view_interactions_link(
+            self,
+            ai_usage: models.AiUsage,
+            was_successful: bool | None = None,
+    ) -> str:
+        was_successful_filter = '' if was_successful is None else f'&was_successful__exact={int(was_successful)}'
+
+        url = (
+                reverse("admin:django_spire_ai_aiinteraction_changelist")
+                + "?"
+                + urlencode({"ai_usage__id": f"{ai_usage.id}"})
+                + was_successful_filter
+        )
+
+        if was_successful is None:
+            interactions_count = ai_usage.interactions.count()
+        elif was_successful:
+            interactions_count = ai_usage.interactions.filter(was_successful=True).count()
+        else:
+            interactions_count = ai_usage.interactions.filter(was_successful=False).count()
+
+        return format_html(
+            f'<a href="{url}">{interactions_count} Interactions</a>'
+        )
+
+    view_interactions_link.short_description = "All"
+
+    def view_successful_interactions_link(
+            self,
+            ai_usage: models.AiUsage,
+    ) -> str:
+        return self.view_interactions_link(ai_usage, was_successful=True)
+
+    view_successful_interactions_link.short_description = "Successful"
+
+    def view_failed_interactions_link(
+            self,
+            ai_usage: models.AiUsage,
+    ) -> str:
+        return self.view_interactions_link(ai_usage, was_successful=False)
+
+    view_failed_interactions_link.short_description = "Failed"
+
+
+class AiInteractionModelForm(forms.ModelForm):
+    interaction = forms.JSONField(widget=JsonTreeWidget)
+
+    class Meta:
+        model = models.AiInteraction
+        fields = '__all__'
+
+
+@admin.register(models.AiInteraction)
+class AiInteractionAdmin(AiUsageAdminMixin):
+    form = AiInteractionModelForm
+
+    list_display = (
+        'actor',
+        'callable_name',
+        'was_successful',
+        'event_count',
+        'token_usage',
+        'run_time_seconds_formatted',
+        'created_datetime',
+    )
+    list_filter = ('module_name', 'callable_name', 'was_successful')
+    search_fields = ('actor', 'user_email', 'user_first_name', 'user_last_name', 'module_name', 'callable_name')
+    ordering = ('-created_datetime',)
+
+    readonly_fields = [
+        'actor',
+        'created_datetime',
+        'module_name',
+        'callable_name',
+        'was_successful',
+        'user',
+        'user_email',
+        'user_first_name',
+        'user_last_name',
+        'exception',
+        'stack_trace',
+    ]
+    fields = [
+        'actor',
+        'user',
+        'created_datetime',
+        'module_name',
+        'callable_name',
+        'was_successful',
+        'interaction',
+        'user_email',
+        'user_first_name',
+        'user_last_name',
+        'exception',
+        'stack_trace',
+    ]

django_spire/ai/apps.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from django.apps import AppConfig
+
+from django_spire.utils import check_required_apps
+
+
+class AiConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    label = 'django_spire_ai'
+    name = 'django_spire.ai'
+
+    REQUIRED_APPS = ('django_spire_core',)
+    URLPATTERNS_INCLUDE = 'django_spire.ai.urls'
+    URLPATTERNS_NAMESPACE = 'ai'
+
+    def ready(self) -> None:
+        check_required_apps(self.label)

django_spire/ai/chat/admin.py

@@ -0,0 +1,51 @@
+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
+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: ClassVar = ['-id']
+
+    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}"})
+        )
+
+        return format_html(f'<a href="{url}">{count} Messages</a>')
+
+    view_chat_messages_link.short_description = "Messages"
+
+    class Meta:
+        ordering = ('id', )
+
+
+@admin.register(models.ChatMessage)
+class ChatMessageAdmin(admin.ModelAdmin):
+    list_display = ('content_body', 'chat', 'chat__user','is_processed', 'is_viewed', 'created_datetime')
+    search_fields = ('id', 'content')
+    ordering: ClassVar = ['-id']
+
+    def content_body(self, obj) -> str:
+        return str(obj)
+
+    content_body.short_description = 'Body'
+
+    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

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from django.apps import AppConfig
+from django_spire.utils import check_required_apps
+
+
+class AiChatConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'django_spire.ai.chat'
+    label = 'django_spire_ai_chat'
+    MODEL_PERMISSIONS = (
+        {
+            'name': 'ai_chat',
+            'verbose_name': 'AI Chat',
+            'model_class_path': 'django_spire.ai.chat.models.Chat',
+            'is_proxy_model': False,
+        },
+    )
+
+    REQUIRED_APPS = ('django_spire_ai', 'django_spire_ai_context')
+
+    def ready(self) -> None:
+        check_required_apps(self.label)

django_spire/ai/chat/auth/controller.py

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

django_spire/ai/chat/choices.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from django.db.models import Choices
+
+
+class MessageResponseType(Choices):
+    REQUEST = 'request'
+    RESPONSE = 'response'
+    LOADING_RESPONSE = 'loading_response'

django_spire/ai/chat/intelligence/decoders/intent_decoder.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+from typing import Callable, TYPE_CHECKING
+
+from dandy import Decoder
+
+from django_spire.conf import settings
+from django_spire.core.utils import get_callable_from_module_string_and_validate_arguments
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+
+
+def generate_intent_decoder(
+    request: WSGIRequest,
+    default_callable: Callable | None = None
+) -> Decoder:
+    intent_dict = {}
+
+    if hasattr(settings, 'DJANGO_SPIRE_AI_INTENT_CHAT_ROUTERS'):
+        for intent_config in settings.DJANGO_SPIRE_AI_INTENT_CHAT_ROUTERS.values():
+            required_permission = intent_config.get('REQUIRED_PERMISSION')
+
+            if required_permission and not request.user.has_perm(required_permission):
+                continue
+
+            intent_description = intent_config.get('INTENT_DESCRIPTION', '')
+            chat_router_path = intent_config.get('CHAT_ROUTER')
+
+            if chat_router_path:
+                try:
+                    router_class = get_callable_from_module_string_and_validate_arguments(
+                        chat_router_path,
+                        []
+                    )
+
+                    router_instance = router_class()
+
+                    intent_dict[intent_description] = router_instance.workflow
+                except ImportError:
+                    pass
+
+    if default_callable is not None:
+        intent_dict['None of the above choices match the user\'s intent'] = default_callable
+
+    return Decoder(
+        mapping_keys_description='Intent of the User\'s Request',
+        mapping=intent_dict
+    )

django_spire/ai/chat/intelligence/prompts.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from dandy import Prompt
+
+from django_spire.ai.context.intelligence.prompts.organization_prompts import (
+    organization_info_prompt
+)
+
+
+def chat_system_prompt() -> Prompt:
+    return (
+        Prompt()
+        .text(
+            'You are a chat assistant, please use the organization information below for answering questions.'
+        )
+        .line_break()
+        .prompt(organization_info_prompt())
+        .line_break()
+        .text('Make sure to follow the rules below')
+        .list(
+            [
+                'Do not talk about being an AI at all to maintain the illusion of being a human assistant.',
+            ]
+        )
+    )

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

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django_spire.conf import settings
+from django_spire.core.utils import get_callable_from_module_string_and_validate_arguments
+
+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
+
+
+def chat_workflow(
+    request: WSGIRequest,
+    user_input: str,
+    message_history: MessageHistory | None = None
+) -> BaseMessageIntel:
+    router_key = getattr(settings, 'DJANGO_SPIRE_AI_DEFAULT_CHAT_ROUTER', 'SPIRE')
+
+    chat_routers = getattr(settings, 'DJANGO_SPIRE_AI_CHAT_ROUTERS', {
+        'SPIRE': 'django_spire.ai.chat.router.SpireChatRouter'
+    })
+
+    router_path = chat_routers.get(router_key)
+
+    if not router_path:
+        router_path = 'django_spire.ai.chat.router.SpireChatRouter'
+
+    router_class = get_callable_from_module_string_and_validate_arguments(
+        router_path,
+        []
+    )
+
+    router_instance = router_class()
+
+    return router_instance.process(
+        request=request,
+        user_input=user_input,
+        message_history=message_history,
+    )

django_spire/ai/chat/message_intel.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+
+from dandy import BaseIntel
+from django.template.loader import render_to_string
+
+
+class BaseMessageIntel(BaseIntel, ABC):
+    _template: str
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+
+        template = cls.__dict__.get('_template')
+
+        if template is None and hasattr(cls, '__private_attributes__'):
+            private_attr = cls.__private_attributes__.get('_template')
+
+            if private_attr and hasattr(private_attr, 'default'):
+                template = private_attr.default
+
+        if not template:
+            message = f'{cls.__module__}.{cls.__qualname__}._template must be set'
+            raise ValueError(message)
+
+    @abstractmethod
+    def render_to_str(self) -> str:
+        raise NotImplementedError
+
+    def render_template_to_str(self, context_data: dict | None = None):
+        return render_to_string(
+            template_name=self._template,
+            context={**self.model_dump(), **(context_data or {})},
+        )
+
+    @property
+    def template(self) -> str:
+        return self._template
+
+
+class DefaultMessageIntel(BaseMessageIntel):
+    _template: str = 'django_spire/ai/chat/message/default_message.html'
+    text: str
+
+    def render_to_str(self) -> str:
+        return self.text

django_spire/ai/chat/migrations/0001_initial.py

@@ -0,0 +1,55 @@
+# Generated by Django 5.2 on 2025-04-23 17:23
+
+import django.db.models.deletion
+import django.utils.timezone
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Chat',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_active', models.BooleanField(default=True, editable=False)),
+                ('is_deleted', models.BooleanField(default=False, editable=False)),
+                ('created_datetime', models.DateTimeField(default=django.utils.timezone.localtime, editable=False)),
+                ('name', models.CharField(max_length=128)),
+                ('last_message_datetime', models.DateTimeField(default=django.utils.timezone.now, editable=False)),
+                ('has_unread_messages', models.BooleanField(default=False)),
+                ('user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='chats', related_query_name='chat', to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Chat',
+                'verbose_name_plural': 'Chats',
+                'db_table': 'django_spire_ai_chat',
+                'ordering': ('-last_message_datetime', 'name'),
+            },
+        ),
+        migrations.CreateModel(
+            name='ChatMessage',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_active', models.BooleanField(default=True, editable=False)),
+                ('is_deleted', models.BooleanField(default=False, editable=False)),
+                ('created_datetime', models.DateTimeField(default=django.utils.timezone.localtime, editable=False)),
+                ('content', models.JSONField()),
+                ('is_processed', models.BooleanField(default=False)),
+                ('is_viewed', models.BooleanField(default=False)),
+                ('chat', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='messages', related_query_name='message', to='django_spire_ai_chat.chat')),
+            ],
+            options={
+                'verbose_name': 'Chat Message',
+                'verbose_name_plural': 'Chat Messages',
+                'db_table': 'django_spire_ai_chat_message',
+            },
+        ),
+    ]

django_spire/ai/chat/migrations/0002_remove_chatmessage_content_chatmessage__content_and_more.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.2 on 2025-05-06 21:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_ai_chat', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='chatmessage',
+            name='content',
+        ),
+        migrations.AddField(
+            model_name='chatmessage',
+            name='_content',
+            field=models.JSONField(default=''),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='chatmessage',
+            name='_content_intel_class',
+            field=models.CharField(default=' ', max_length=64),
+            preserve_default=False,
+        ),
+    ]

django_spire/ai/chat/migrations/0003_rename__content_chatmessage__intel_data_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.2 on 2025-05-17 23:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_ai_chat', '0002_remove_chatmessage_content_chatmessage__content_and_more'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='chatmessage',
+            old_name='_content',
+            new_name='_intel_data',
+        ),
+        migrations.RemoveField(
+            model_name='chatmessage',
+            name='_content_intel_class',
+        ),
+        migrations.AddField(
+            model_name='chatmessage',
+            name='_intel_class_name',
+            field=models.TextField(default=''),
+            preserve_default=False,
+        ),
+    ]

django_spire/ai/chat/migrations/0004_chatmessage_response_type_chatmessage_sender.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.2 on 2025-05-17 23:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_spire_ai_chat', '0003_rename__content_chatmessage__intel_data_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='chatmessage',
+            name='response_type',
+            field=models.CharField(choices=[('request', 'Request'), ('response', 'Response'), ('loading_response', 'Loading Response')], default='request', max_length=32),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='chatmessage',
+            name='sender',
+            field=models.CharField(default='', max_length=128),
+            preserve_default=False,
+        ),
+    ]