9668164339

Committed 25 Jun 2024 07:04PM UTC coverage: 92.549% (-0.8%) from 93.333%

Build # 9668164339

Build Type

Pull #120

github

Committed by

fjsj

Commit Message

Frontend documentation and frontend client naming changes

Pull Request Pull Request #120: Frontend documentation and frontend client naming changes

Run Details

115 of 127 branches covered (90.55%)

Branch coverage included in aggregate %.

38 of 39 new or added lines in 7 files covered. (97.44%)

13 existing lines in 3 files now uncovered.

593 of 638 relevant lines covered (92.95%)

2.22 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.48

/django_ai_assistant/models.py

import json

from django.conf import settings
from django.db import models
from django.db.models import F, Index, Manager


class Thread(models.Model):
    """Thread model. A thread is a collection of messages between a user and the AI assistant.
    Also called conversation or session."""

    id: int  # noqa: A003
    messages: Manager["Message"]
    name = models.CharField(max_length=255, blank=True)
    """Name of the thread. Can be blank."""
    created_by = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.SET_NULL,
        related_name="ai_assistant_threads",
        null=True,
    )
    """User who created the thread. Can be null. Set to null/None when user is deleted."""
    created_at = models.DateTimeField(auto_now_add=True)
    """Date and time when the thread was created.
    Automatically set when the thread is created."""
    updated_at = models.DateTimeField(auto_now=True)
    """Date and time when the thread was last updated.
    Automatically set when the thread is updated."""

    class Meta:
        verbose_name = "Thread"
        verbose_name_plural = "Threads"
        ordering = ("-created_at",)
        indexes = (Index(F("created_at").desc(), name="thread_created_at_desc"),)

    def __str__(self) -> str:
        """Return the name of the thread as the string representation of the thread."""
        return self.name

    def __repr__(self) -> str:
        """Return the string representation of the thread like '<Thread name>'"""
        return f"<Thread {self.name}>"


class Message(models.Model):
    """Message model. A message is a text that is part of a thread.
    A message can be sent by a user or the AI assistant.\n
    The message data is stored as a JSON field called `message`."""

    id: int  # noqa: A003
    thread = models.ForeignKey(Thread, on_delete=models.CASCADE, related_name="messages")
    """Thread to which the message belongs."""
    thread_id: int  # noqa: A003
    message = models.JSONField()
    """Message content. This is a serialized Langchain `BaseMessage` that was serialized
    with `message_to_dict` and can be deserialized with `messages_from_dict`."""
    created_at = models.DateTimeField(auto_now_add=True)
    """Date and time when the message was created.
    Automatically set when the message is created."""
    # TODO: add created_by field

    class Meta:
        verbose_name = "Message"
        verbose_name_plural = "Messages"
        ordering = ("created_at",)
        indexes = (Index(F("created_at"), name="message_created_at"),)

    def __str__(self) -> str:
        """Return internal message data from `message` attribute
        as the string representation of the message."""
        return json.dumps(self.message)

    def __repr__(self) -> str:
        """Return the string representation of the message like '<Message id at thread_id>'"""
        return f"<Message {self.id} at {self.thread_id}>"

1	import json	1✔
2
3	from django.conf import settings	1✔
4	from django.db import models	1✔
5	from django.db.models import F, Index, Manager	1✔
6
7
8	class Thread(models.Model):	1✔
9	"""Thread model. A thread is a collection of messages between a user and the AI assistant.
10	Also called conversation or session."""
11
12	id: int # noqa: A003	1✔
13	messages: Manager["Message"]	1✔
14	name = models.CharField(max_length=255, blank=True)	1✔
15	"""Name of the thread. Can be blank."""	1✔
16	created_by = models.ForeignKey(	1✔
17	settings.AUTH_USER_MODEL,
18	on_delete=models.SET_NULL,
19	related_name="ai_assistant_threads",
20	null=True,
21	)
22	"""User who created the thread. Can be null. Set to null/None when user is deleted."""	1✔
23	created_at = models.DateTimeField(auto_now_add=True)	1✔
24	"""Date and time when the thread was created.	1✔
25	Automatically set when the thread is created."""
26	updated_at = models.DateTimeField(auto_now=True)	1✔
27	"""Date and time when the thread was last updated.	1✔
28	Automatically set when the thread is updated."""
29
30	class Meta:	1✔
31	verbose_name = "Thread"	1✔
32	verbose_name_plural = "Threads"	1✔
33	ordering = ("-created_at",)	1✔
34	indexes = (Index(F("created_at").desc(), name="thread_created_at_desc"),)	1✔
35
36	def __str__(self) -> str:	1✔
37	"""Return the name of the thread as the string representation of the thread."""
38	return self.name	×
39
40	def __repr__(self) -> str:	1✔
41	"""Return the string representation of the thread like '<Thread name>'"""
42	return f"<Thread {self.name}>"	×
43
44
45	class Message(models.Model):	1✔
46	"""Message model. A message is a text that is part of a thread.
47	A message can be sent by a user or the AI assistant.\n
48	The message data is stored as a JSON field called `message`."""
49
50	id: int # noqa: A003	1✔
51	thread = models.ForeignKey(Thread, on_delete=models.CASCADE, related_name="messages")	1✔
52	"""Thread to which the message belongs."""	1✔
53	thread_id: int # noqa: A003	1✔
54	message = models.JSONField()	1✔
55	"""Message content. This is a serialized Langchain `BaseMessage` that was serialized	1✔
56	with `message_to_dict` and can be deserialized with `messages_from_dict`."""
57	created_at = models.DateTimeField(auto_now_add=True)	1✔
58	"""Date and time when the message was created.	1✔
59	Automatically set when the message is created."""
60	# TODO: add created_by field
61
62	class Meta:	1✔
63	verbose_name = "Message"	1✔
64	verbose_name_plural = "Messages"	1✔
65	ordering = ("created_at",)	1✔
66	indexes = (Index(F("created_at"), name="message_created_at"),)	1✔
67
68	def __str__(self) -> str:	1✔
69	"""Return internal message data from `message` attribute
70	as the string representation of the message."""
UNCOV 71	return json.dumps(self.message)	×
72
73	def __repr__(self) -> str:	1✔
74	"""Return the string representation of the message like '<Message id at thread_id>'"""
UNCOV 75	return f"<Message {self.id} at {self.thread_id}>"	×

vintasoftware / django-ai-assistant / 9668164339

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous