Skip to content

Commit

Permalink
GITBOOK-4: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
ShaunLarcAi authored and gitbook-bot committed Sep 26, 2024
1 parent 135def3 commit eedff91
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 5 deletions.
Binary file modified .gitbook/assets/image (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
* [➕ Document Attributes](documents/document-attributes.md)
* [❓ Document Categories](documents/document-categories.md)
* [🧠 Understanding the Documents page](documents/understanding-the-documents-page.md)
* [↗️ Processing documents](documents/processing-documents/README.md)
* [Processing Paramaters](documents/processing-documents/processing-paramaters.md)
* [👥 User Groups](service-users/README.md)
* [📓 Maintaining Groups](service-users/maintaining-groups.md)
* [📏 Managing Roles in Groups](service-users/managing-roles-in-groups.md)
Expand Down
39 changes: 39 additions & 0 deletions documents/processing-documents/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# ↗️ Processing documents

## Overview

Once a document is uploaded, one can start to think about processing to produce an output

Processing can be done in various ways:

* Desktop App (manual)
* Auto Batch Processing
* API/ SDK/ BOT

{% hint style="info" %}
Processing a document produces a result file, Processing it multiple times, produces multiple output files
{% endhint %}

## Processing documents in the Desktop app

1. Open the service **Inbox**
2. Select the documents to be processed
3. select "Process selected documents" 
4. Tune the [processing parameters](processing-paramaters.md)

## Auto processing

This is set up in the service settings. This will automatically process documents in the received state

1. Open the service wizard
2. Set **Processing Batch Size** Recommended 10 -30 documents
3. set **Execution Interval**
4. set **Auto Execuion** to True

{% hint style="info" %}
Documents older than 7 days will not be auto-processed
{% endhint %}

## API Processing

Refer to API/ SDK/ BOT documentation
16 changes: 16 additions & 0 deletions documents/processing-documents/processing-paramaters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Processing Paramaters

## Overview

When processing a document, one should consider all the possibilities and parameters of one's action.

## Processing parameters

<figure><img src="../../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>

* **Reset Previous Comments**: Clears the comment field in the document's metadata. If disabled, new process comments will be appended to existing ones.
* **Reset Previous Results**: Clears the result field in the document's metadata. If disabled, new process results will be appended to the existing ones.
* **Delete Output of Previous Processing**: Removes all outputs generated by previous processing.
* **Delete Linked Documents**: Deletes all linked (Outbox) documents associated with the Inbox document.
* **Delete Linked Documents Recursively**: Deletes the entire hierarchy of linked documents.
* **Force Re-Processing**: Forces the document to be processed again.
2 changes: 1 addition & 1 deletion services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Dependent AI services rely on additional functionalities, such as OCR or custom

If the Microsoft Forms recognizer is inadequate, custom code can be integrated into the process to achieve the desired outcome

<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Dependent AI Services are set up the same way as normal AI Services
Expand Down
8 changes: 4 additions & 4 deletions services/scrapers/email-scraper.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Once the email is scraped, an [attachment utility](../utilities/attachment-utili
* **Microsoft 365**

{% hint style="info" %}
Any email provider can be used if the correct settings are applied&#x20;
Any email provider can be used if the correct settings are applied
{% endhint %}

## Setup Guide

1. Create an **Email Scraping** service

<figure><img src="../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (1) (1).png" alt=""><figcaption></figcaption></figure>

<figure><img src="../../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>

Expand All @@ -47,7 +47,7 @@ Any email provider can be used if the correct settings are applied&#x20;

**Folder:** The folder to monitor

**Processed Folder:** The folder to move processed emails&#x20;
**Processed Folder:** The folder to move processed emails
{% endtab %}

{% tab title="Gmail" %}
Expand All @@ -65,7 +65,7 @@ Any email provider can be used if the correct settings are applied&#x20;

**Folder:** The folder to monitor

**Processed Folder:** The folder to move processed emails&#x20;
**Processed Folder:** The folder to move processed emails
{% endtab %}
{% endtabs %}

Expand Down

0 comments on commit eedff91

Please sign in to comment.