Skip to content

Models

DataAudio

Bases: Model

Link to home and hardware device, and the audio data will be stored in the database It will be created by the endpoint from client side when audio data is acquired

Source code in API/hardware/models.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
class DataAudio(models.Model):
    """
    Link to home and hardware device, and the audio data will be stored in the database
    It will be created by the endpoint from client side when audio data is acquired
    """

    home = models.ForeignKey(
        Home, on_delete=models.CASCADE, related_name="audio", null=True, blank=True
    )
    hardware_device_mac_address = models.CharField(
        max_length=100,
        help_text="The mac address of the hardware device",
        null=True,
        blank=True,
    )
    uid = models.CharField(
        max_length=100,
        help_text="the uid of the audio acquire session, can be treated as scenario id",
    )
    sequence_index = models.IntegerField(help_text="The sequence index of the audio")
    audio_file = models.CharField(max_length=100, help_text="The audio file")
    start_time = models.DateTimeField(help_text="The start time of the audio")
    end_time = models.DateTimeField(help_text="The end time of the audio")

    created_at = models.DateTimeField(
        auto_now_add=True, help_text="The created time of the audio"
    )
    updated_at = models.DateTimeField(
        auto_now=True, help_text="The updated time of the audio"
    )
    track_id = models.CharField(
        max_length=100,
        help_text="The track id of the multimodal conversation",
        null=True,
        blank=True,
    )

    @classmethod
    def create_obj(
        cls,
        home: Home,
        uid: str,
        hardware_device_mac_address: str,
        sequence_index: int,
        audio_file: str,
        start_time: datetime,
        end_time: datetime,
        track_id: str = None,
    ):
        """
        Create an audio data object
        """
        return cls.objects.create(
            home=home,
            hardware_device_mac_address=hardware_device_mac_address,
            uid=uid,
            sequence_index=sequence_index,
            audio_file=audio_file,
            start_time=start_time,
            end_time=end_time,
            track_id=track_id,
        )

    def __str__(self):
        return f"{self.uid} - {self.audio_file}"

    def url(self):
        """
        get the file, and create media url
        Returns:

        """
        return f"/hardware/client_audio/{self.id}"

    class Meta:
        verbose_name = "Data Audio"
        verbose_name_plural = "Data Audios"

create_obj(home, uid, hardware_device_mac_address, sequence_index, audio_file, start_time, end_time, track_id=None) classmethod

Create an audio data object

Source code in API/hardware/models.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
@classmethod
def create_obj(
    cls,
    home: Home,
    uid: str,
    hardware_device_mac_address: str,
    sequence_index: int,
    audio_file: str,
    start_time: datetime,
    end_time: datetime,
    track_id: str = None,
):
    """
    Create an audio data object
    """
    return cls.objects.create(
        home=home,
        hardware_device_mac_address=hardware_device_mac_address,
        uid=uid,
        sequence_index=sequence_index,
        audio_file=audio_file,
        start_time=start_time,
        end_time=end_time,
        track_id=track_id,
    )

url()

get the file, and create media url Returns:

Source code in API/hardware/models.py 
137
138
139
140
141
142
143
def url(self):
    """
    get the file, and create media url
    Returns:

    """
    return f"/hardware/client_audio/{self.id}"

DataMultiModalConversation

Bases: Model

It will be created when a audio is created Then video will be added when emotion detection is triggered, or other task require video Text will be added when speech2text is done ResText will be added when the text is processed by the language model ResSpeech will be added when the text is processed by the text2speech

Source code in API/hardware/models.py 
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
class DataMultiModalConversation(models.Model):
    """
    It will be created when a audio is created
    Then video will be added when emotion detection is triggered, or other task require video
    Text will be added when speech2text is done
    ResText will be added when the text is processed by the language model
    ResSpeech will be added when the text is processed by the text2speech
    """

    audio = models.OneToOneField(
        DataAudio,
        on_delete=models.SET_NULL,
        related_name="multi_modal_conversation",
        null=True,
        blank=True,
    )
    # video should be an array field
    video = models.ManyToManyField(
        DataVideo, related_name="multi_modal_conversation", blank=True
    )
    text = models.OneToOneField(
        DataText,
        on_delete=models.SET_NULL,
        related_name="multi_modal_conversation",
        null=True,
        blank=True,
    )

    res_text = models.OneToOneField(
        ResText,
        on_delete=models.SET_NULL,
        related_name="multi_modal_conversation",
        null=True,
        blank=True,
    )
    res_speech = models.OneToOneField(
        ResSpeech,
        on_delete=models.SET_NULL,
        related_name="multi_modal_conversation",
        null=True,
        blank=True,
    )
    created_at = models.DateTimeField(
        auto_now_add=True, help_text="The created time of the multi-modal conversation"
    )
    updated_at = models.DateTimeField(
        auto_now=True, help_text="The updated time of the multi-modal conversation"
    )

    track_id = models.CharField(
        max_length=100,
        help_text="The track id of the multimodal conversation",
        null=True,
        blank=True,
    )
    annotations = models.JSONField(
        help_text="The annotations of the emotion detection",
        null=True,
        blank=True,
        default=dict,
    )

    multi_turns_annotations = models.JSONField(
        help_text="The annotations of the multi-turns",
        null=True,
        blank=True,
        default=dict,
    )
    tags = TaggableManager(blank=True)

    def __str__(self):
        return f"{self.id}"

    def video_url(self):
        if len(self.video.all()) == 0:
            return "No Video"
        return f"/hardware/client_video/{self.id}"

    class Meta:
        verbose_name = "Conversation"
        verbose_name_plural = "Conversations"

DataText

Bases: Model

The text data will be stored in the database It will be created after speech2text is done

Source code in API/hardware/models.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
class DataText(models.Model):
    """
    The text data will be stored in the database
    It will be created after speech2text is done
    """

    # foreign key to the audio
    audio = models.ForeignKey(
        DataAudio,
        on_delete=models.CASCADE,
        related_name="text",
        help_text="The audio data",
    )
    text = models.TextField(help_text="The text of the audio")

    created_at = models.DateTimeField(
        auto_now_add=True, help_text="The created time of the text"
    )
    updated_at = models.DateTimeField(
        auto_now=True, help_text="The updated time of the text"
    )
    model_name = models.CharField(
        max_length=100,
        help_text="The name of the model",
        null=True,
        blank=True,
        default="whisper",
    )

    def __str__(self):
        return self.text

    class Meta:
        verbose_name = "Data Text"
        verbose_name_plural = "Data Texts"

DataVideo

Bases: Model

Link to home and hardware device, and the video data will be stored in the database It will be created by the endpoint from client side when video data is acquired Same as the audio data, the video data will be stored in the database It will not be directly connected to the audio data Audio data and video data will be connected by the time range softly

Source code in API/hardware/models.py 
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
class DataVideo(models.Model):
    """
    Link to home and hardware device, and the video data will be stored in the database
    It will be created by the endpoint from client side when video data is acquired
    Same as the audio data, the video data will be stored in the database
    It will not be directly connected to the audio data
    Audio data and video data will be connected by the time range softly
    """

    home = models.ForeignKey(
        Home, on_delete=models.CASCADE, related_name="video", null=True, blank=True
    )
    uid = models.CharField(
        max_length=100,
        help_text="the uid of the video acquire session, link back to client logs",
    )
    hardware_device_mac_address = models.CharField(
        max_length=100,
        help_text="The mac address of the hardware device",
        null=True,
        blank=True,
    )
    # TODO: add start and end time?
    video_file = models.CharField(max_length=100, help_text="The video file")
    start_time = models.DateTimeField(help_text="The start time of the video")
    end_time = models.DateTimeField(help_text="The end time of the video")

    created_at = models.DateTimeField(
        auto_now_add=True, help_text="The created time of the video"
    )
    updated_at = models.DateTimeField(
        auto_now=True, help_text="The updated time of the video"
    )

    def __str__(self):
        return f"{self.uid} - {self.video_file}"

    class Meta:
        verbose_name = "Data Video"
        verbose_name_plural = "Data Videos"

HardWareDevice

Bases: Model

One home can have multiple hardware devices, and the hardware device can be used to acquire the audio and video data

Source code in API/hardware/models.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
class HardWareDevice(models.Model):
    """
    One home can have multiple hardware devices, and the hardware device can be used to acquire the audio and video data

    """

    home = models.ForeignKey(
        Home,
        on_delete=models.CASCADE,
        related_name="hardware_devices",
        null=True,
        blank=True,
    )
    mac_address = models.CharField(
        max_length=100, help_text="The mac address of the hardware device", unique=True
    )
    device_name = models.CharField(
        max_length=100,
        help_text="The name of the hardware device",
        null=True,
        blank=True,
    )
    device_type = models.CharField(
        max_length=100,
        help_text="The type of the hardware device",
        null=True,
        blank=True,
    )
    description = models.TextField(
        help_text="The description of the hardware device", null=True, blank=True
    )
    created_at = models.DateTimeField(
        auto_now_add=True, help_text="The created time of the hardware device"
    )
    updated_at = models.DateTimeField(
        auto_now=True, help_text="The updated time of the hardware device"
    )

    class Meta:
        verbose_name = "Hardware Device"
        verbose_name_plural = "Hardware Devices"

Home

Bases: Model

Created by setup manually, and the client side can specify the home, so all data will be connected to this.

Source code in API/hardware/models.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class Home(models.Model):
    """
    Created by setup manually, and the client side can specify the home, so all data will be connected to this.
    """

    user = models.ForeignKey(User, on_delete=models.CASCADE)
    name = models.CharField(
        max_length=100, help_text="The name of the home", default="Blue Boat House"
    )
    address = models.CharField(
        max_length=100,
        help_text="The address of the home",
        default="1 Kings Park Ave, Crawley WA 6009",
    )

    def __str__(self):
        return f"{self.name}"