Skip to content

Commit 95b32c3

Browse files
committed
Update with instructions related to KB and destroying resources
1 parent 7ba7c41 commit 95b32c3

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
This project demonstrates how to chat with your architecture using Amazon Bedrock's Converse API, tool use, and a knowledge base. Implemented in Python, the demo allows users to analyze architecture diagrams, evaluate effectiveness, get recommendations, and make informed decisions about their system architecture.
44

5+
This project accompanies the following resources:
6+
- Blog post: [A conversation with your architecture](https://community.aws/content/2qM2qCmPCaAByW0bDVR7OdBo1dF/a-conversation-with-your-architecture)
7+
- Video series:
8+
- [Episode 1: Build a Python App to Chat with Architecture Diagrams](https://www.youtube.com/watch?v=34OV3JDvveg)
9+
- Episode 2: Incorporate real-time data in your architecture diagram analysis with tool use (coming soon)
10+
- Episode 3: Incorporate custom data in your architecture diagram analysis with a knowledge base (coming soon)
11+
- Workshop: [Harnessing generative AI to create and understand architecture diagrams ](https://catalog.workshops.aws/generative-ai-architecture-diagrams)
12+
13+
## Overview
14+
515
The application interacts with a foundation model on Amazon Bedrock to provide information based on an architecture diagram and user input. It utilizes three custom tools to gather information:
616

717
1. Audit Info Tool: Provides audit information about a system based on the system name inferred from the architecture diagram file name.
@@ -43,7 +53,13 @@ To run this demo, you'll need a few bits set up first:
4353

4454
### Setup
4555

46-
Set up your custom environmeng variables by creating a `.env` file in the project root directory with the following content:
56+
#### Amazon Bedrock Knowledge Base
57+
58+
You can set up a knowledge base using [these instructions](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create.html). Note that this can result in charges to your AWS account.
59+
60+
#### Environment Variables
61+
62+
Set up your custom environment variables by creating a `.env` file in the project root directory with the following content:
4763

4864
```
4965
AWS_REGION=<your-aws-region>
@@ -64,6 +80,13 @@ python architecture_chat_demo.py
6480

6581
4. To exit the demo, type `x` and press Enter.
6682

83+
### Tear down
84+
85+
Be sure to tear down any AWS resources you're not using after working through this demo as they may result in charges to your AWS account. The resources to destroy are:
86+
87+
- S3 bucket for your knowledge base data source
88+
- Amazon Bedrock Knowledge Base
89+
6790
### Bring your own diagram
6891

6992
Want to chat with your own diagram? Drop an image file (jpg, jpeg, or png) into the `demo` folder and rerun the app. When prompted, enter the full name (excluding the path) of that diagram to chat with.
@@ -78,6 +101,8 @@ Below are some sample queries you could use to chat with an architecture diagram
78101
- What improvements should be made to the resiliency of this architecture?
79102
- Convert the data flow from this architecture into a Mermaid formatted sequence diagram.
80103
- What are the quotas or limits in this architecture?
104+
- What is the current joy count of the system?
105+
- Is the current joy count good or bad?
81106

82107
### Bonus: Generate the infrastructure code
83108

0 commit comments

Comments
 (0)