Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/broken-links-checker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
uses: lycheeverse/lychee-action@v2.6.1
with:
args: >
--verbose --exclude-mail --no-progress --exclude ^https?://
--verbose --no-progress --exclude ^https?://
${{ steps.changed-markdown-files.outputs.all_changed_files }}
failIfEmpty: false
env:
Expand All @@ -50,7 +50,7 @@ jobs:
uses: lycheeverse/lychee-action@v2.6.1
with:
args: >
--verbose --exclude-mail --no-progress --exclude ^https?://
--verbose --no-progress --exclude ^https?://
'**/*.md'
failIfEmpty: false
env:
Expand Down
4 changes: 4 additions & 0 deletions docs/DeploymentGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,10 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
4. **Deleting Resources After a Failed Deployment**

- Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources.

## Running the application

To help you get started, here's the [Sample Workflow](./SampleWorkflow.md) you can follow to try it out.

## Environment configuration for local development & debugging
**Creatign env file**
Expand Down
43 changes: 43 additions & 0 deletions docs/SampleWorkflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@

# Sample Workflow

To help you get started, here’s a **sample process** you can follow in the app.

## **Process**

> Note: Download sample data files for **Invoices** and **Property Claims** from [here](../src/ContentProcessorAPI/samples).

### **API Documentation**

- Click on **API Documentation** to view and explore the available API endpoints and their details.

### **Upload**

> Note: Average response time is 01 minute.

_Sample Operations:_

- Select the **Schema** under the Processing Queue pane.
- Click on the **Import Content** button.
- Choose a file from the downloaded list for data extraction corresponding to the **Schema** selected.
- Click the **Upload** button.

### **Review and Process**

_Sample Operation:_

- Once the file status is marked as completed, click on the file.
- Once the batch processing is done, the file is ready to review and the extracted data is displayed in the **Output Review** pane and corresponding file is visible in the **Source Document** pane.
- Edit any incorrect data in the JSON which is shown in the **Output Review** pane under **Extracted Results** tab.
- Add notes under the **Comments** and save the changes by clicking on the **Save** button.
- You can view the process steps in the **Output Review** pane under the **Process Steps** tab and expand the extract, Map, and evaluate sections to see the outputs from each process step.

![Application](images/sampleworkflow1.png)

### **Delete**

_Sample operation:_

- Click the **three-dot menu** at the end of the row to expand options, then select **Delete** to remove the item.

This structured approach ensures that users can efficiently extract key information, and organize structured outputs for easy search and analysis.
Binary file added docs/images/sampleworkflow1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.