Projects¶
A Project is the main concept. No data can be shared across projects, only AI models can be shared.
Create a Project¶
Go to Home and click on the Add button next to Project to create and name a new project.
Project Details¶
Name¶
Verbose Name of the Project.
Decimal Separator¶
Change the decimal separator used to compile the CSV File. Have a look here to see how to change the decimal separator in MS Excel.
Enable Assignee¶
Will allow assigning users to Documents if enabled.
Notify Assignee¶
If project’s document has value for assignee
field and project notify_assignee
value is True,
then we send emails about processing of this document to assignee
person.
Default Assignee¶
We allow defining default assignee person on project level for this project documents.
Possible to set this value from both: api and admin panel (default_assignee
field).
Then, if the document will be created without some assignee person, we will assign it to default_assignee
value
from this document project.
Automatically Rotate Documents¶
If enabled, when Konfuzio detects a file that is not oriented correctly, it will rotate the relevant page(s) automatically to the nearest 90 degrees. This feature does not change existing documents, it only applies to newly uploaded ones.
This feature is not available on all projects.
Categorization AI¶
Active Categorization AI in the Project.
Categorization AI Parameters¶
There are advanced configurations for the training of a categorization AI that can be adjusted to achieve a better fitting for your case.
The categorization AI, by default, considers a combination of the text and image features of your documents. Therefore, the categorization of a document will be based on the text of the document and the images of its pages.
However, you can adapt the classifier and choose to only use a text module and, therefore, categorize only based on the text features, for example. The same is possible for only image features.
To do that, you need to pass the dictionary “document_classifier_config” in the “Categorization AI Parameters”. To use only text features, include only the text module. To use only image features, include only the image_module. To use both, include both modules and the multimodal module, that combines them.
{
"document_classifier_config": {
"text_module": {...},
"image_module": {...},
"multimodal_module": {...},
}
}
Furthermore, within each module it is possible to choose the AI architecture and configuration responsible to extract the features.
You change the AI architecture used in the text module by defining its name. The available architectures and respective possible arguments in the text module can be seen here.
For example:
{
"document_classifier_config": {
"text_module": {
"name": "nbow",
"dropout_rate": 0.2,
},
}
}
The same is possible for the image module. The available architectures and respective possible arguments in the image module can be seen here.
For example:
{
"document_classifier_config": {
"image_module": {
"name": "efficientnet_b0",
"freeze": true,
},
}
}
Project ID¶
ID of the Project used in the REST-API
Page Limit¶
Maximum Number of Pages per Document.
Auto-Deletion of Documents¶
Konfuzio allows the auto-deletion of documents with dataset status
equal to None
. To activate auto-deletion, you need to set
auto_delete_documents_after_days
to the number of days after which the documents of this project should be deleted.
You can set the value of this field using API and the user interface. The default value is 0, which turns auto-deletion off.
Once, auto_delete_documents_after_days
is set, the Konfuzio server will automatically delete documents each day according to this rule.
Delete a project¶
Go to the List of Projects and select the project you want to delete.
This will delete all data of your project.