mirror of
https://gitlab.rlp.net/proj-wise2526-video2document/video2document.git
synced 2026-06-15 18:01:52 +02:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 565caebdd8 | |||
| 9688cae537 | |||
| a953f3780b | |||
| b261019905 |
File diff suppressed because it is too large
Load Diff
Binary file not shown.
+19
-3
@@ -7,6 +7,7 @@
|
|||||||
4. [IPC](#ipc)
|
4. [IPC](#ipc)
|
||||||
5. [Authentication](#authentication)
|
5. [Authentication](#authentication)
|
||||||
6. [UI](#ui)
|
6. [UI](#ui)
|
||||||
|
7. [Storage](#storage)
|
||||||
|
|
||||||
## How to run the Software
|
## How to run the Software
|
||||||
If you read the readme file, you will see the basic setup command in order to run the program.
|
If you read the readme file, you will see the basic setup command in order to run the program.
|
||||||
@@ -37,7 +38,7 @@ The program iterates through all of the folders within `./services/modules`, and
|
|||||||
This map is available ANYWHERE in the backend code, even within a module, which means, you can call a module, from within a module, from within a module, from within yet another module.
|
This map is available ANYWHERE in the backend code, even within a module, which means, you can call a module, from within a module, from within a module, from within yet another module.
|
||||||
|
|
||||||
## Modules
|
## Modules
|
||||||
Building a new module is super easy, any idiot can get it done.
|
Building a new module is super easy, anyone can get it done.
|
||||||
All you need to do is follow the previously mentioned structure.
|
All you need to do is follow the previously mentioned structure.
|
||||||
When you have created your module file, the `.js` file, you simply copy paste this code snippet into it.
|
When you have created your module file, the `.js` file, you simply copy paste this code snippet into it.
|
||||||
```js
|
```js
|
||||||
@@ -52,7 +53,7 @@ module.exports = {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
If by this point, you cared enough to actually look at the code and the modules and so on, you might have spotted a file in `./services/modules/utility` called `example.js`.
|
If you had a look at the code and the modules and so on, you might have spotted a file in `./services/modules/utility` called `example.js`.
|
||||||
This is a template file that you can just copy paste and use as a base for your new module.
|
This is a template file that you can just copy paste and use as a base for your new module.
|
||||||
It has the same exact code as mentioned right above.
|
It has the same exact code as mentioned right above.
|
||||||
Now as for how the code works.
|
Now as for how the code works.
|
||||||
@@ -217,4 +218,19 @@ This directory contains the flags used for the language selection dropdown menu.
|
|||||||
Pictures for the document preview are stored here.
|
Pictures for the document preview are stored here.
|
||||||
|
|
||||||
**/node_modules:**
|
**/node_modules:**
|
||||||
Contains nodes used by electron.
|
Contains nodes used by electron.
|
||||||
|
|
||||||
|
## Storage
|
||||||
|
|
||||||
|
In the root directory of the project you will find the `storage` folder.
|
||||||
|
This directory is used to persist **all artifacts generated throughout the processing pipeline**, allowing each step to operate independently while still sharing results.
|
||||||
|
|
||||||
|
Each module is expected to **read from and write to this directory**, depending on its responsibility in the pipeline.
|
||||||
|
|
||||||
|
The storage folder contains the following sub folders:
|
||||||
|
- **audio** stores the extracted audio from the video
|
||||||
|
- **audio-snippets** store the individual speaker snippets for speaker identification
|
||||||
|
- **documents** store the HTML files generated by the AI / LLM modules
|
||||||
|
- **documentType** stores the premade prompt templates used for the AI calls
|
||||||
|
- **transcriptionSummaries** store the transcripts after they have been transformed from word-level to sentence-level
|
||||||
|
- **transcripts** store the raw transcripts returned by the transcription services
|
||||||
|
|||||||
Reference in New Issue
Block a user