Skip to content

Commit 1166414

Browse files
rstrahanrstrahan
committed
Merge branch 'added/ui-info-docs' into 'develop'
feat(ui): add comprehensive help content to Information panels See merge request genaiic-reusable-assets/engagement-artifacts/genaiic-idp-accelerator!620
2 parents f0f0035 + d7f9ab1 commit 1166414

18 files changed

Lines changed: 645 additions & 68 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ SPDX-License-Identifier: MIT-0
1111

1212
- **Private Network Deployment** — Deploy the IDP Accelerator in fully private / air-gapped environments. New `AppSyncVisibility` parameter (`GLOBAL` | `PRIVATE`) makes the AppSync API accessible only from inside the VPC. All processing Lambda functions (21 across 3 templates) are conditionally placed in customer VPC subnets with an HTTPS-only security group. Includes a separate VPC endpoint CloudFormation template (`scripts/vpc-endpoints.yaml`) with 16 interface endpoints (AppSync, Bedrock, SQS, DynamoDB, S3, Lambda, SSM, KMS, STS, Textract, and more) and per-endpoint creation flags to skip pre-existing endpoints. All features are off by default — existing deployments are completely unaffected. See `docs/deployment-private-network.md`.
1313

14+
- **Enhanced Information Panels** — Added comprehensive help content to the Information (ⓘ) panel on every page in the Web UI. Each panel now includes a feature summary, list of key capabilities, and "Learn more" links to relevant docs-site documentation pages. Created new panels for 8 pages that previously had none (Pricing, Capacity Planning, Custom Models, Discovery, User Management, Test Studio), and enriched the existing 7 panels with fuller descriptions and documentation links.
1415

1516
### Changed
1617

‎src/ui/src/components/agent-chat/tools-panel.tsx‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,11 +150,29 @@ const ToolsPanel = (): React.JSX.Element => {
150150
<ul>
151151
<li>
152152
<a
153-
href="https://github.com/aws-solutions-library-samples/accelerated-intelligent-document-processing-on-aws/blob/main/README.md"
153+
href="https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws/agent-companion-chat/"
154154
target="_blank"
155155
rel="noopener noreferrer"
156156
>
157-
GenAI IDP Accelerator Documentation
157+
Agent Companion Chat
158+
</a>
159+
</li>
160+
<li>
161+
<a
162+
href="https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws/custom-MCP-agent/"
163+
target="_blank"
164+
rel="noopener noreferrer"
165+
>
166+
Custom MCP Agents
167+
</a>
168+
</li>
169+
<li>
170+
<a
171+
href="https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws/mcp-server/"
172+
target="_blank"
173+
rel="noopener noreferrer"
174+
>
175+
MCP Server
158176
</a>
159177
</li>
160178
</ul>

‎src/ui/src/components/capacity-planning/tools-panel.tsx‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
import React from 'react';
4+
import { HelpPanel, Icon } from '@cloudscape-design/components';
5+
6+
const DOCS_BASE_URL = 'https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws';
7+
8+
const ToolsPanel = (): React.JSX.Element => (
9+
<HelpPanel
10+
header={<h2>Capacity Planning</h2>}
11+
footer={
12+
<div>
13+
<h3>
14+
Learn more <Icon name="external" />
15+
</h3>
16+
<ul>
17+
<li>
18+
<a href={`${DOCS_BASE_URL}/capacity-planning/`} target="_blank" rel="noopener noreferrer">
19+
Capacity Planning
20+
</a>
21+
</li>
22+
<li>
23+
<a href={`${DOCS_BASE_URL}/monitoring/`} target="_blank" rel="noopener noreferrer">
24+
Monitoring
25+
</a>
26+
</li>
27+
<li>
28+
<a href={`${DOCS_BASE_URL}/service-tiers/`} target="_blank" rel="noopener noreferrer">
29+
Service Tiers
30+
</a>
31+
</li>
32+
</ul>
33+
</div>
34+
}
35+
>
36+
<div>
37+
<p>Monitor and plan document processing capacity to ensure your system can handle current and projected workloads.</p>
38+
<h3>Features</h3>
39+
<ul>
40+
<li>View current processing throughput and utilization metrics</li>
41+
<li>Monitor AWS service quotas and usage against limits</li>
42+
<li>Set alerts for capacity thresholds to proactively manage scaling</li>
43+
<li>Plan capacity for anticipated workload increases</li>
44+
<li>Review service tier configurations and their impact on throughput</li>
45+
</ul>
46+
</div>
47+
</HelpPanel>
48+
);
49+
50+
export default ToolsPanel;

‎src/ui/src/components/configuration-layout/tools-panel.tsx‎

Lines changed: 52 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,59 @@
22
// SPDX-License-Identifier: MIT-0
33

44
import React from 'react';
5-
import { HelpPanel } from '@cloudscape-design/components';
5+
import { HelpPanel, Icon } from '@cloudscape-design/components';
66

7-
const header = <h2>Configuration</h2>;
8-
const content = (
9-
<>
10-
<p>Manage application configuration settings.</p>
11-
<p>Default values are set by the system during deployment. Any customized values will override the defaults.</p>
12-
<p>To restore a customized value back to its default, click the &quot;Reset to default&quot; link next to the field.</p>
13-
</>
14-
);
7+
const DOCS_BASE_URL = 'https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws';
158

16-
const ToolsPanel = (): React.JSX.Element => <HelpPanel header={header}>{content}</HelpPanel>;
9+
const ToolsPanel = (): React.JSX.Element => (
10+
<HelpPanel
11+
header={<h2>Configuration</h2>}
12+
footer={
13+
<div>
14+
<h3>
15+
Learn more <Icon name="external" />
16+
</h3>
17+
<ul>
18+
<li>
19+
<a href={`${DOCS_BASE_URL}/configuration/`} target="_blank" rel="noopener noreferrer">
20+
Configuration
21+
</a>
22+
</li>
23+
<li>
24+
<a href={`${DOCS_BASE_URL}/configuration-versions/`} target="_blank" rel="noopener noreferrer">
25+
Configuration Versions
26+
</a>
27+
</li>
28+
<li>
29+
<a href={`${DOCS_BASE_URL}/idp-configuration-best-practices/`} target="_blank" rel="noopener noreferrer">
30+
Configuration Best Practices
31+
</a>
32+
</li>
33+
<li>
34+
<a href={`${DOCS_BASE_URL}/json-schema-migration/`} target="_blank" rel="noopener noreferrer">
35+
JSON Schema Migration
36+
</a>
37+
</li>
38+
</ul>
39+
</div>
40+
}
41+
>
42+
<div>
43+
<p>
44+
Edit and manage the IDP processing configuration. Default values are set by the system during deployment. Any customized values will
45+
override the defaults.
46+
</p>
47+
<h3>Features</h3>
48+
<ul>
49+
<li>Edit configuration in YAML or JSON using the built-in code editor</li>
50+
<li>Use the visual Config Builder to construct configurations without writing code</li>
51+
<li>Manage configuration versions — compare, restore, or roll back changes</li>
52+
<li>Import pre-built configurations from the Configuration Library</li>
53+
<li>Sync configuration with BDA (Business Document Automation) projects</li>
54+
<li>Reset customized values back to system defaults</li>
55+
</ul>
56+
</div>
57+
</HelpPanel>
58+
);
1759

1860
export default ToolsPanel;

‎src/ui/src/components/custom-models/job-tools-panel.tsx‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
import React from 'react';
4+
import { HelpPanel, Icon } from '@cloudscape-design/components';
5+
6+
const DOCS_BASE_URL = 'https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws';
7+
8+
const JobToolsPanel = (): React.JSX.Element => (
9+
<HelpPanel
10+
header={<h2>Fine-Tuning Job Details</h2>}
11+
footer={
12+
<div>
13+
<h3>
14+
Learn more <Icon name="external" />
15+
</h3>
16+
<ul>
17+
<li>
18+
<a href={`${DOCS_BASE_URL}/custom-model-finetuning/`} target="_blank" rel="noopener noreferrer">
19+
Custom Model Fine-Tuning
20+
</a>
21+
</li>
22+
</ul>
23+
</div>
24+
}
25+
>
26+
<div>
27+
<p>View detailed information about a specific fine-tuning job.</p>
28+
<h3>Details</h3>
29+
<ul>
30+
<li>View training job status, progress, and configuration</li>
31+
<li>Monitor training metrics such as loss and accuracy</li>
32+
<li>Review training data details and hyperparameters used</li>
33+
<li>Access the fine-tuned model output for deployment</li>
34+
</ul>
35+
</div>
36+
</HelpPanel>
37+
);
38+
39+
export default JobToolsPanel;

‎src/ui/src/components/custom-models/tools-panel.tsx‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
import React from 'react';
4+
import { HelpPanel, Icon } from '@cloudscape-design/components';
5+
6+
const DOCS_BASE_URL = 'https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws';
7+
8+
const ToolsPanel = (): React.JSX.Element => (
9+
<HelpPanel
10+
header={<h2>Custom Models</h2>}
11+
footer={
12+
<div>
13+
<h3>
14+
Learn more <Icon name="external" />
15+
</h3>
16+
<ul>
17+
<li>
18+
<a href={`${DOCS_BASE_URL}/custom-model-finetuning/`} target="_blank" rel="noopener noreferrer">
19+
Custom Model Fine-Tuning
20+
</a>
21+
</li>
22+
<li>
23+
<a href={`${DOCS_BASE_URL}/nova-finetuning/`} target="_blank" rel="noopener noreferrer">
24+
Nova Fine-Tuning
25+
</a>
26+
</li>
27+
</ul>
28+
</div>
29+
}
30+
>
31+
<div>
32+
<p>Fine-tune custom models to improve document processing accuracy for your specific document types.</p>
33+
<h3>Features</h3>
34+
<ul>
35+
<li>Launch fine-tuning jobs using your document processing results as training data</li>
36+
<li>Track training job progress, status, and metrics</li>
37+
<li>Compare model performance before and after fine-tuning</li>
38+
<li>Manage fine-tuned model deployments and versions</li>
39+
<li>Supports Amazon Nova and other Bedrock model fine-tuning</li>
40+
</ul>
41+
</div>
42+
</HelpPanel>
43+
);
44+
45+
export default ToolsPanel;

‎src/ui/src/components/discovery/job-tools-panel.tsx‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
import React from 'react';
4+
import { HelpPanel, Icon } from '@cloudscape-design/components';
5+
6+
const DOCS_BASE_URL = 'https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws';
7+
8+
const JobToolsPanel = (): React.JSX.Element => (
9+
<HelpPanel
10+
header={<h2>Discovery Job Details</h2>}
11+
footer={
12+
<div>
13+
<h3>
14+
Learn more <Icon name="external" />
15+
</h3>
16+
<ul>
17+
<li>
18+
<a href={`${DOCS_BASE_URL}/discovery/`} target="_blank" rel="noopener noreferrer">
19+
Discovery
20+
</a>
21+
</li>
22+
</ul>
23+
</div>
24+
}
25+
>
26+
<div>
27+
<p>View detailed results from a discovery job run.</p>
28+
<h3>Details</h3>
29+
<ul>
30+
<li>View detected document types and their characteristics</li>
31+
<li>Inspect discovered fields, layouts, and structural patterns</li>
32+
<li>Review generated classification and extraction configuration suggestions</li>
33+
<li>Apply discovery results to your IDP configuration</li>
34+
</ul>
35+
</div>
36+
</HelpPanel>
37+
);
38+
39+
export default JobToolsPanel;

‎src/ui/src/components/discovery/tools-panel.tsx‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
import React from 'react';
4+
import { HelpPanel, Icon } from '@cloudscape-design/components';
5+
6+
const DOCS_BASE_URL = 'https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws';
7+
8+
const ToolsPanel = (): React.JSX.Element => (
9+
<HelpPanel
10+
header={<h2>Discovery</h2>}
11+
footer={
12+
<div>
13+
<h3>
14+
Learn more <Icon name="external" />
15+
</h3>
16+
<ul>
17+
<li>
18+
<a href={`${DOCS_BASE_URL}/discovery/`} target="_blank" rel="noopener noreferrer">
19+
Discovery
20+
</a>
21+
</li>
22+
<li>
23+
<a href={`${DOCS_BASE_URL}/classification/`} target="_blank" rel="noopener noreferrer">
24+
Classification
25+
</a>
26+
</li>
27+
<li>
28+
<a href={`${DOCS_BASE_URL}/extraction/`} target="_blank" rel="noopener noreferrer">
29+
Extraction
30+
</a>
31+
</li>
32+
</ul>
33+
</div>
34+
}
35+
>
36+
<div>
37+
<p>
38+
Run document discovery jobs to analyze document structure and content before configuring processing pipelines. Discovery helps you
39+
understand your documents and auto-generate initial configurations.
40+
</p>
41+
<h3>Features</h3>
42+
<ul>
43+
<li>Upload sample documents and run discovery analysis</li>
44+
<li>Automatically detect document types, layouts, and key fields</li>
45+
<li>Generate initial classification and extraction configurations</li>
46+
<li>Review discovery results to refine processing settings</li>
47+
<li>Track discovery job history and compare results across runs</li>
48+
</ul>
49+
</div>
50+
</HelpPanel>
51+
);
52+
53+
export default ToolsPanel;

‎src/ui/src/components/document-agents-layout/tools-panel.tsx‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,21 @@ const ToolsPanel = (): React.JSX.Element => {
1414
</h3>
1515
<ul>
1616
<li>
17-
<a href="https://github.com/aws-solutions-library-samples/accelerated-intelligent-document-processing-on-aws/blob/main/README.md">
18-
GenAI IDP Accelerator Documentation
17+
<a
18+
href="https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws/agent-analysis/"
19+
target="_blank"
20+
rel="noopener noreferrer"
21+
>
22+
Agent Analysis
23+
</a>
24+
</li>
25+
<li>
26+
<a
27+
href="https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws/reporting-database/"
28+
target="_blank"
29+
rel="noopener noreferrer"
30+
>
31+
Reporting Database
1932
</a>
2033
</li>
2134
</ul>

0 commit comments

Comments
 (0)