Skip to content

Commit

Permalink
GITBOOK-16: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
ShaunLarcAi authored and gitbook-bot committed Jun 21, 2024
1 parent 5a29ef5 commit 760ea44
Show file tree
Hide file tree
Showing 29 changed files with 93 additions and 82 deletions.
Binary file added .gitbook/assets/112 (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 added .gitbook/assets/112.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 (13).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 (14).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 (17).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 (19).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 (22).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 (26).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 (27).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 (29).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 added .gitbook/assets/master ID (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 added .gitbook/assets/master ID.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 12 additions & 10 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@
* [🔂 Multi-Factor Authentication](multi-factor-authentication.md)
* [🎛️ Projects](projects/README.md)
* [🧠 Understanding Projects](projects/understanding-projects.md)
* [documents](documents/README.md)
* [ℹ️ Documemt Types](documents/documemt-types.md)
* [⏩ Understanding Document Flows](documents/understanding-document-flows.md)
* [➕ Document Attributes](documents/document-attributes.md)
* [❓ Document Categories](documents/document-categories.md)
* [Understanding the Documents page](documents/understanding-the-documents-page.md)
* [Work Queue](workqueue.md)
* [Analyze Transaction details](analyze-transaction-details.md)
* [Contacts](contacts.md)
Expand All @@ -23,16 +29,6 @@
* [Use in Custom Code](custom-datasets/use-in-custom-code.md)
* [Use via SDK](custom-datasets/use-via-sdk.md)
* [Custom Datasets - What is it?](custom-datasets/what-is-it.md)
* [documents](documents/README.md)
* [Document Categories](documents/document-categories.md)
* [Documents Inbox](documents/documents-inbox.md)
* [Documents Outbox](documents/documents-outbox.md)
* [Document Verification](documents/doocument-verification.md)
* [Training Box](documents/training-box.md)
* [Understanding the Documents page](documents/understanding-the-documents-page.md)
* [Verification](documents/Verification/README.md)
* [Document Analytics](documents/Verification/document-analytics.md)
* [Document Analysis](documents/Verification/document-cost-analysis.md)
* [Human in the Loop](human-in-the-loop/README.md)
* [AIForged Workflow](human-in-the-loop/aiforged-workflow.md)
* [Amazon Mechanical Turk](human-in-the-loop/amazon-mechanical-turk.md)
Expand Down Expand Up @@ -234,3 +230,9 @@
* [Get Work Item Count](uipath-activities/workitem/get-work-item-count.md)
* [Get Work Items](uipath-activities/workitem/get-work-items.md)
* [Get Work Queue](uipath-activities/workitem/get-work-queue.md)
* [Depricated Info](depricated-info/README.md)
* [Training Box](depricated-info/training-box.md)
* [Document Verification](depricated-info/doocument-verification.md)
* [Verification](depricated-info/verification/README.md)
* [Document Analytics](depricated-info/verification/document-analytics.md)
* [Document Analysis](depricated-info/verification/document-cost-analysis.md)
2 changes: 2 additions & 0 deletions depricated-info/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Depricated Info

Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

![verification usage](../.gitbook/assets/verification-Usage.png)

1.Click on any of the tags 2.Click on the "Usage" command in the command bar 3.This will open up the usage page you can view the usage page [Here](Verification/document-analytics.md)
1.Click on any of the tags 2.Click on the "Usage" command in the command bar 3.This will open up the usage page you can view the usage page [Here](verification/document-analytics.md)

## Cost Analysis

![verification Cost Analysis](../.gitbook/assets/verification-CostAnalysis.png)

* The "Cost Analysis" Command takes you to the Analytics page [Here](Verification/document-analytics.md)
* The "Cost Analysis" Command takes you to the Analytics page [Here](verification/document-analytics.md)

## Definition

Expand Down
File renamed without changes.
File renamed without changes.
27 changes: 27 additions & 0 deletions documents/documemt-types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# ℹ️ Documemt Types

## Types of documents

you can identify 3 main categories: structured, semi-structured, and unstructured. Each type of document comes with its own set of challenges.

{% hint style="info" %}
It is important to identify the type of document first, and then choose an appropriate [AI service](../services/)
{% endhint %}

### Structured documents

![](<../.gitbook/assets/structured-document (1) (1).png>)

Structured documents generally focus on collecting information in a precise format, guiding the person who is filling them with precise areas where each piece of data needs to be entered.

### Semi-structured

![](<../.gitbook/assets/semi-structured (1).png>)

Semi-structured documents are documents that do not follow a strict format the way structured forms do and are not bound to specified data fields. These don't have a fixed form but follow a common format.

#### Unstructured

![](<../.gitbook/assets/un-structured (1) (1).png>)

Unstructured documents are documents in which the information isn't organized according to a clear, structured model.
19 changes: 19 additions & 0 deletions documents/document-attributes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# ➕ Document Attributes

### Document Attributes

Each document has attributes associated with it:

| Field Name | Description |
| ------------ | ------------------------------------------------------------------------------------------- |
| Id | A unique identifier is assigned to each document. |
| Master ID | An identifier is used to connect documents in a hierarchical flow from different locations. |
| Filename | The name of the file as stored in the system. |
| Category | The classification of the document. |
| Type | The Type of document |
| Usage | Indicates where the document is used. |
| Status | The current state or condition of the document. |
| Date Created | Displays the date the Document was uploaded to AiForged |
| Comment | Free text comment on the document |
| Actions | The Actions that are available in the document |

19 changes: 15 additions & 4 deletions documents/document-categories.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Document Categories
# Document Categories

Document categories defines the **Type** of document that has been uploaded. Projects Document categories is shared to all its services.
Document categories define the type of document that has been uploaded. Example: Bank-Statement, ID, or Invoice

{% hint style="info" %}
Document Categories are shared across all services in the project
{% endhint %}

## How to create Document Categories

Expand All @@ -10,8 +14,13 @@ Document categories defines the **Type** of document that has been uploaded. Pro
2. Click on “_Click here to add a new row_” to add a new **Document Category**.

<figure><img src="../.gitbook/assets/image (14) (4).png" alt=""><figcaption></figcaption></figure>
3. Fill in your new row and click on another row in your grid to allow you to add more rows (Note the Id Field is Inserted Automatically)
4. After adding All your **Document Categories** click on **Save Changes** in the App Bar.
3. Fill in your new row and click on another row in your grid to allow you to add more rows&#x20;

{% hint style="info" %}
Note the ID field is Inserted Automatically
{% endhint %}

1. After adding All your **Document Categories** click on **Save Changes** in the App Bar.

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

Expand All @@ -24,3 +33,5 @@ Document categories defines the **Type** of document that has been uploaded. Pro

<figure><img src="../.gitbook/assets/image (74) (1).png" alt=""><figcaption></figcaption></figure>
3. After removing the **Document Categories** click on **Save Changes** in the App Bar.

<figure><img src="../.gitbook/assets/image (29).png" alt=""><figcaption></figcaption></figure>
11 changes: 0 additions & 11 deletions documents/documents-inbox.md

This file was deleted.

11 changes: 0 additions & 11 deletions documents/documents-outbox.md

This file was deleted.

10 changes: 10 additions & 0 deletions documents/understanding-document-flows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ⏩ Understanding Document Flows

### Document flow in a service

Each service has an Inbox and an Outbox

The physical document is passed into the inbox, and a result is produced in the outbox. It is important to note that services might often produce different outputs, for example: an Extractor may produce document field results, whereas Classifiers might produce document groups

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

38 changes: 0 additions & 38 deletions documents/understanding-the-documents-page.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,5 @@
# Understanding the Documents page

## Types of documents

you can identify 3 main categories: structured, semi-structured and unstructured. Each type of document comes with its own set of challenges.

### Structured documents

![](<../.gitbook/assets/structured-document (1) (1).png>)

Structured documents generally focus on collecting information in a precise format, guiding the person who is filling them with precise areas where each piece of data needs to be entered.

### Semi-structured

![](<../.gitbook/assets/semi-structured (1).png>)

Semi-structured documents are documents that do not follow a strict format the way structured forms do and are not bound to specified data fields. These don't have a fixed form but follow a common format.

## Unstructured

![](<../.gitbook/assets/un-structured (1) (1).png>)

Unstructured documents are documents in which the information isn't organized according to a clear, structured model.

## Available Fields

| Field Name | Description |
| ------------ | ------------------------------------------------------- |
| Id | Displays the generated Id of the Document |
| Master | |
| Date Created | Displays the date the Document was uploaded to AiForged |
| Filename | Displays the Filename of the Document |
| Type | Displays the file type of the document |
| Usage | Displays the current Usage of the Document |
| Status | Displays the Status of the document |
| Actions | Displays Actions that is available to this document |
| Comment | Displays Comments left on this document |
| Result | Displays the Result of this document |
| Category | Displays the Category |

## Document Actions

* Opens a document for verification.
Expand Down
4 changes: 2 additions & 2 deletions practical-examples/bank-statement.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,5 @@ The purpose of this process is to extract the **Account Number**, **Full Name**,
23. Now that the documents have been labeled, we can request the train operation. In step 5, click on **Train Service**. Again the progress dialogue will show the progress of the training operation. Note that after training has been completed successfully, the status will change to **Trained**.

<figure><img src="../.gitbook/assets/image (211).png" alt=""><figcaption></figcaption></figure>
24. At this stage, the service is trained, and documents can be loaded into the [**Inbox** ](../documents/documents-inbox.md)of the service and can be processed.
25. The OCR results can be viewed in the [**Outbox**](../documents/documents-outbox.md) of the service.
24. At this stage, the service is trained, and documents can be loaded into the [**Inbox** ](broken-reference)of the service and can be processed.
25. The OCR results can be viewed in the [**Outbox**](broken-reference) of the service.
4 changes: 2 additions & 2 deletions practical-examples/credit-application-form.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,5 @@ The purpose of this process is to extract various fields on the form, including
23. Now that the documents have been labeled, we can request the train operation. In step 5, click on **Train Service**. Again the progress dialogue will show the progress of the training operation. Note that after training has been completed successfully, the status will change to **Trained**.

<figure><img src="../.gitbook/assets/image (16) (1) (1) (1) (2) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
24. At this stage, the service is trained, and documents can be loaded into the [**Inbox**](../documents/documents-inbox.md) of the service and can be processed.
25. The OCR results can be viewed in the [**Outbox**](../documents/documents-outbox.md) \*\*\*\* of the service.
24. At this stage, the service is trained, and documents can be loaded into the [**Inbox**](broken-reference) of the service and can be processed.
25. The OCR results can be viewed in the [**Outbox**](broken-reference) \*\*\*\* of the service.
4 changes: 2 additions & 2 deletions practical-examples/social-security-number-card.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,5 @@ The purpose of this process is to extract the **Social Security number**, the **
23. Now that the documents have been labeled, we can request the train operation. In step 5, click on **Train Service**. Again the progress dialogue will show the progress of the training operation. Note that after training has been completed successfully, the status will change to **Trained**.

<figure><img src="../.gitbook/assets/image (16) (1) (1) (1) (2) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
24. At this stage, the service is trained, and documents can be loaded into the [**Inbox**](../documents/documents-inbox.md) of the service and can be processed.
25. The OCR results can be viewed in the [**Outbox**](../documents/documents-outbox.md) of the service.
24. At this stage, the service is trained, and documents can be loaded into the [**Inbox**](broken-reference) of the service and can be processed.
25. The OCR results can be viewed in the [**Outbox**](broken-reference) of the service.

0 comments on commit 760ea44

Please sign in to comment.