Threads per assistant (optional)

CONTRIBUTING.md

@@ -42,7 +42,6 @@ If you encounter an error regarding the Python version required for the project,
 pyenv install
 ```
 
-
 #### Frontend
 
 Go to the frontend directory and install the Node dependencies:
@@ -60,6 +59,15 @@ pre-commit install
 
 It's critical to run the pre-commit hooks before pushing your code to follow the project's code style, and avoid linting errors.
 
+### Updating the OpenAPI schema
+
+It's critical to update the OpenAPI schema when you make changes to the `django_ai_assistant/api/views.py` or related files:
+
+```bash
+poetry run python manage.py generate_openapi_schema --output frontend/openapi_schema.json
+sh -c 'cd frontend && pnpm run generate-client'
+```
+
 ### Developing with the example project
 
 Run the frontend project in `build:watch` mode:
@@ -105,6 +113,13 @@ Then, you will run the tests in record mode:
 poetry run pytest --record-mode=once
 ```
 
+To run frontend tests:
+
+```bash
+cd frontend
+pnpm run test
+```
+
 ## Documentation
 
 We use [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) to generate the documentation from markdown files.
@@ -123,7 +138,7 @@ poetry run mkdocs serve
 
 To release and publish a new version, follow these steps:
 
-1. Update the version in `pyproject.toml` and `frontend/package.json`.
+1. Update the version in `pyproject.toml`, `frontend/package.json` and `example/package.json`.
 2. Re-install the local version of the Python project: `poetry install`
 3. In the project root, run `poetry run python manage.py generate_openapi_schema --output frontend/openapi_schema.json` to update the OpenAPI schema.
 4. Re-install the local version of the frontend project:

django_ai_assistant/api/schemas.py

@@ -18,13 +18,15 @@ class Meta:
         fields = (
             "id",
             "name",
+            "assistant_id",
             "created_at",
             "updated_at",
         )
 
 
 class ThreadIn(Schema):
     name: str = Field(default_factory=lambda: timezone.now().strftime("%Y-%m-%d %H:%M"))
+    assistant_id: str | None = None
 
 
 class ThreadMessageIn(Schema):

django_ai_assistant/api/views.py

@@ -76,14 +76,17 @@ def get_assistant(request, assistant_id: str):
 
 
 @api.get("threads/", response=List[Thread], url_name="threads_list_create")
-def list_threads(request):
-    return list(use_cases.get_threads(user=request.user))
+def list_threads(request, assistant_id: str | None = None):
+    return list(use_cases.get_threads(user=request.user, assistant_id=assistant_id))
 
 
 @api.post("threads/", response=Thread, url_name="threads_list_create")
 def create_thread(request, payload: ThreadIn):
     name = payload.name
-    return use_cases.create_thread(name=name, user=request.user, request=request)
+    assistant_id = payload.assistant_id
+    return use_cases.create_thread(
+        name=name, assistant_id=assistant_id, user=request.user, request=request
+    )
 
 
 @api.get("threads/{thread_id}/", response=Thread, url_name="thread_detail_update_delete")

django_ai_assistant/helpers/use_cases.py

@@ -142,13 +142,16 @@ def create_message(
 def create_thread(
     name: str,
     user: Any,
+    assistant_id: str | None = None,
     request: HttpRequest | None = None,
 ) -> Thread:
     """Create a thread.\n
     Uses `AI_ASSISTANT_CAN_CREATE_THREAD_FN` permission to check if user can create a thread.
 
     Args:
         name (str): Thread name
+        assistant_id (str | None): Assistant ID to associate the thread with.
+            If empty or None, the thread is not associated with any assistant.
         user (Any): Current user
         request (HttpRequest | None): Current request, if any
     Returns:
@@ -159,7 +162,7 @@ def create_thread(
     if not can_create_thread(user=user, request=request):
         raise AIUserNotAllowedError("User is not allowed to create threads")
 
-    thread = Thread.objects.create(name=name, created_by=user)
+    thread = Thread.objects.create(name=name, created_by=user, assistant_id=assistant_id or "")
     return thread
 
 
@@ -188,15 +191,37 @@ def get_single_thread(
     return thread
 
 
-def get_threads(user: Any) -> list[Thread]:
-    """Get all user owned threads.\n
+def get_threads(
+    user: Any,
+    assistant_id: str | None = None,
+    request: HttpRequest | None = None,
+) -> list[Thread]:
+    """Get all threads for the user.\n
+    Uses `AI_ASSISTANT_CAN_VIEW_THREAD_FN` permission to check the threads the user can see,
+    and returns only the ones the user can see.
 
     Args:
         user (Any): Current user
+        assistant_id (str | None): Assistant ID to filter threads by.
+            If empty or None, all threads for the user are returned.
+        request (HttpRequest | None): Current request, if any
     Returns:
         list[Thread]: List of thread model instances
     """
-    return list(Thread.objects.filter(created_by=user))
+    threads = Thread.objects.filter(created_by=user)
+
+    if assistant_id:
+        threads = threads.filter(assistant_id=assistant_id)
+
+    return list(
+        threads.filter(
+            id__in=[
+                thread.id
+                for thread in threads
+                if can_view_thread(thread=thread, user=user, request=request)
+            ]
+        )
+    )
 
 
 def update_thread(

django_ai_assistant/migrations/0006_thread_assistant_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.1 on 2024-10-03 13:22
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_ai_assistant', '0005_alter_message_options'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='thread',
+            name='assistant_id',
+            field=models.CharField(blank=True, max_length=255),
+        ),
+    ]

django_ai_assistant/models.py

@@ -20,6 +20,8 @@ class Thread(models.Model):
         null=True,
     )
     """User who created the thread. Can be null. Set to null/None when user is deleted."""
+    assistant_id = models.CharField(max_length=255, blank=True)
+    """Associated assistant ID. Can be empty."""
     created_at = models.DateTimeField(auto_now_add=True)
     """Date and time when the thread was created.
     Automatically set when the thread is created."""

docs/frontend.md

@@ -106,7 +106,7 @@ Get a thread by ID.
 
 ### `aiUpdateThread`  
 Update a thread by ID.  
-**Param:** `{ threadId: string, requestBody: { name: string } }`  
+**Param:** `{ threadId: string, requestBody: { name: string, assistant_id: string } }`  
 **Return:** a `Promise` that resolves to a `Thread`.
 
 ### `aiDeleteThread`  
@@ -198,9 +198,11 @@ export function MyComponent() {
         threads,
         fetchThreads,
         createThread,
+        updateThread,
         deleteThread,
         loadingFetchThreads,
         loadingCreateThread,
+        loadingUpdateThread,
         loadingDeleteThread
     } = useThreadList();
     // ...

example/assets/js/components/Chat/Chat.tsx

@@ -120,7 +120,7 @@ export function Chat({ assistantId }: { assistantId: string }) {
   const [activeThread, setActiveThread] = useState<Thread | null>(null);
   const [inputValue, setInputValue] = useState<string>("");
 
-  const { fetchThreads, threads, createThread, deleteThread } = useThreadList();
+  const { fetchThreads, threads, createThread, deleteThread } = useThreadList({ assistantId });
   const {
     fetchMessages,
     messages,

example/demo/templates/demo/chat_thread.html

@@ -20,7 +20,6 @@
               {% if message.type == "ai" %}AI{% else %}User{% endif %}
             </strong>
           </span>
-
           <span>{{ message.content|markdown }}</span>
         </div>
       {% endfor %}

example/package.json

@@ -44,9 +44,9 @@
     "@mantine/notifications": "^7.11.0",
     "@tabler/icons-react": "^3.7.0",
     "cookie": "^0.6.0",
-    "django-ai-assistant-client": "0.0.1",
+    "django-ai-assistant-client": "0.0.4",
     "modern-normalize": "^2.0.0",
     "react-markdown": "^9.0.1",
     "react-router-dom": "^6.24.0"
   }
-}
+}