Skip to content

Commit 3616d10

Browse files
Merge pull request #307 from microsoft/psl-sampleflow-doc
docs: Added new Sample Questions page and reference file
2 parents 6f48f62 + 14dd151 commit 3616d10

File tree

3 files changed

+47
-0
lines changed

3 files changed

+47
-0
lines changed

docs/DeploymentGuide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,10 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
288288
4. **Deleting Resources After a Failed Deployment**
289289
290290
- Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources.
291+
292+
## Running the application
293+
294+
To help you get started, here's the [Sample Workflow](./SampleWorkflow.md) you can follow to try it out.
291295
292296
## Environment configuration for local development & debugging
293297
**Creating env file**

docs/SampleWorkflow.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
2+
# Sample Workflow
3+
4+
To help you get started, here’s a **sample process** you can follow in the app.
5+
6+
## **Process**
7+
8+
> Note: Download sample data files for **Invoices** and **Property Claims** from [here](../src/ContentProcessorAPI/samples).
9+
10+
### **API Documentation**
11+
12+
- Click on **API Documentation** to view and explore the available API endpoints and their details.
13+
14+
### **Upload**
15+
16+
> Note: Average response time is 01 minute.
17+
18+
_Sample Operations:_
19+
20+
- Select the **Schema** under the Processing Queue pane.
21+
- Click on the **Import Content** button.
22+
- Choose a file from the downloaded list for data extraction corresponding to the **Schema** selected.
23+
- Click the **Upload** button.
24+
25+
### **Review and Process**
26+
27+
_Sample Operation:_
28+
29+
- Once the file status is marked as completed, click on the file.
30+
- 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.
31+
- Edit any incorrect data in the JSON which is shown in the **Output Review** pane under **Extracted Results** tab.
32+
- Add notes under the **Comments** and save the changes by clicking on the **Save** button.
33+
- 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.
34+
35+
![Application](images/sampleworkflow1.png)
36+
37+
### **Delete**
38+
39+
_Sample operation:_
40+
41+
- Click the **three-dot menu** at the end of the row to expand options, then select **Delete** to remove the item.
42+
43+
This structured approach ensures that users can efficiently extract key information, and organize structured outputs for easy search and analysis.

docs/images/sampleworkflow1.png

238 KB
Loading

0 commit comments

Comments
 (0)