Skip to content

fix: minor documentation #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 13, 2024
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
2 changes: 1 addition & 1 deletion samples/bedrock-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ s3_uri = <DocBucket>

### Test

Navigate to the [Bedrock Agents console](https://us-east-1.console.aws.amazon.com/bedrock/home?region=us-east-1#/agents) in your region and find your new agent.
Navigate to the [Bedrock Agents console](https://console.aws.amazon.com/bedrock/home#/agents) in your region and find your new agent.

Ask some questions. You may need to tell the agent what book you want to ask about or refresh the session when asking about different books.

Expand Down
2 changes: 1 addition & 1 deletion samples/bedrock-guardrails/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ This project is built using [Terraform](https://www.terraform.io/). See [Getting

## Test the agents

We will use input similiar to the `examples` in the `topics_config` variable listed within the `guardrails.auto.tfvars` file:
We will use input similar to the `examples` in the `topics_config` variable listed within the `guardrails.auto.tfvars` file:

- `What stocks should I invest in for my retirement?`
- `Is it a good idea to put my money in a mutual fund?`
Expand Down
14 changes: 4 additions & 10 deletions samples/document-explorer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ Here is the architecture diagram of the sample application:

## Folder Structure

This Document Explorer codebase is organized into folders containing the ```frontend``` and ```backend``` infrastructure code. The frontend client app is built with [Streamlit](https://streamlit.io/) and is located in the ```client_app``` folder. The backend code lives in ```bin/document_explorer.ts``` and uses the AWS CDK resources defined in the ```lib``` folder.
This Document Explorer codebase is organized into folders containing the ```frontend``` and ```backend``` infrastructure code. The frontend client app is built with [Streamlit](https://streamlit.io/) and is located in the ```client_app``` folder. The backend code lives in ```terraform-config-backend``` and uses the AWS Terraform module resources downloaded into the ```.terraform``` folder.

The key folders are:

```tree
samples/document_explorer
samples/document-explorer
├── client_app # Frontend using Python Streamlit
│ │
│ ├── Home.ts # Sample app entry point
Expand Down Expand Up @@ -77,21 +77,15 @@ Default output format [None]: json
- Clone this repository.

```shell
git clone <this>
git clone https://github.com/aws-samples/aws-generative-ai-terraform-samples.git
```

- Enter the code sample backend directory.
- Enter the code sample directory.

```shell
cd samples/document-explorer
```

- Install packages

```shell
npm install
```

- Enable Access to Amazon Bedrock Models

> You must explicitly enable access to models before they can be used with the Amazon Bedrock service. Please follow these steps in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/model-access.html) to enable access to the models (at minimum, ```Anthropic::Claude```):.
Expand Down
Loading