Skip to content

Commit

Permalink
Merge pull request #482 from aws-samples/wording
Browse files Browse the repository at this point in the history
update wordings
  • Loading branch information
tbrand authored May 2, 2024
2 parents eac6e5a + 682f2fe commit 6f17789
Show file tree
Hide file tree
Showing 13 changed files with 48 additions and 46 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
# Generative AI Use Cases JP (略称:GenU)

Generative AI(生成 AI)は、ビジネスの変革に革新的な可能性をもたらします。このリポジトリでは、Generative AI を活用したビジネスユースケースをデモンストレーションしています
Generative AI(生成 AI)は、ビジネスの変革に革新的な可能性をもたらします。GenU は、生成 AI を安全に業務活用するための、ビジネスユースケース集を備えたアプリケーション実装です

![sc_lp.png](/imgs/sc_lp.png)

このリポジトリではブラウザ拡張機能も提供しており、より便利に Generative AI を活用することができます。詳しくは[こちらのページ](/browser-extension/README.md)をご覧ください。
このリポジトリではブラウザ拡張機能も提供しており、より便利に 生成 AI を活用することができます。詳しくは[こちらのページ](/browser-extension/README.md)をご覧ください。

![拡張機能](/imgs/extension/extension_demo.png)

Expand All @@ -21,7 +21,7 @@ Generative AI(生成 AI)は、ビジネスの変革に革新的な可能性
<details>
<summary>チャット</summary>

LLM とチャット形式で対話することができます。LLM と直接対話するプラットフォームが存在するおかげで、細かいユースケースや新しいユースケースに迅速に対応することができます。また、プロンプトエンジニアリングの検証用環境としても有効です。
大規模言語モデル (LLM) とチャット形式で対話することができます。LLM と直接対話するプラットフォームが存在するおかげで、細かいユースケースや新しいユースケースに迅速に対応することができます。また、プロンプトエンジニアリングの検証用環境としても有効です。

<img src="/imgs/usecase_chat.gif"/>
</details>
Expand Down Expand Up @@ -103,16 +103,16 @@ Generative AI(生成 AI)は、ビジネスの変革に革新的な可能性

## アーキテクチャ

このサンプルでは、フロントエンドは React を用いて実装し、静的ファイルは Amazon CloudFront + Amazon S3 によって配信されています。バックエンドには Amazon API Gateway + AWS Lambda、認証には Amazon Congito を使用しています。また、LLM は Amazon Bedrock を使用します。RAG のデータソースには Amazon Kendra を利用しています。
この実装では、フロントエンドに React を採用し、静的ファイルは Amazon CloudFront + Amazon S3 によって配信されています。バックエンドには Amazon API Gateway + AWS Lambda、認証には Amazon Congito を使用しています。また、LLM は Amazon Bedrock を使用します。RAG のデータソースには Amazon Kendra を利用しています。

![arch.drawio.png](/imgs/arch.drawio.png)

## デプロイ

> [!IMPORTANT]
> このリポジトリでは、デフォルトでバージニア北部リージョン (us-east-1) の Anthropic Claude 3 Sonnet モデルを利用する設定になっています。[Model access 画面 (us-east-1)](https://us-east-1.console.aws.amazon.com/bedrock/home?region=us-east-1#/modelaccess)を開き、Anthropic Claude 3 Sonnet にチェックして Save changes してください。Claude Instant を利用する場合など、設定を変更する方法については [Amazon Bedrock のモデルを変更する](/docs/DEPLOY_OPTION.md#amazon-bedrock-のモデルを変更する) を参照してください。
> このリポジトリでは、デフォルトでバージニア北部リージョン (us-east-1) の Anthropic Claude 3 Sonnet モデルを利用する設定になっています。[Model access 画面 (us-east-1)](https://us-east-1.console.aws.amazon.com/bedrock/home?region=us-east-1#/modelaccess)を開き、Anthropic Claude 3 Sonnet にチェックして Save changes してください。その他のモデル (Anthropic Claude 3 Haiku, Meta Llama3, Cohere Command-R など) を利用するために設定を変更する方法については [Amazon Bedrock のモデルを変更する](/docs/DEPLOY_OPTION.md#amazon-bedrock-のモデルを変更する) を参照してください。
アプリケーションは [AWS Cloud Development Kit](https://aws.amazon.com/jp/cdk/)(以降 CDK)を利用してデプロイします。Step-by-Step の解説、あるいは、別のデプロイ手段を利用する場合は以下を参照してください。
GenU のデプロイには [AWS Cloud Development Kit](https://aws.amazon.com/jp/cdk/)(以降 CDK)を利用します。Step-by-Step の解説、あるいは、別のデプロイ手段を利用する場合は以下を参照してください。
- [Workshop](https://catalog.workshops.aws/generative-ai-use-cases-jp)
- [動画によるデプロイ手順の紹介](https://www.youtube.com/watch?v=9sMA17OKP1k)

Expand Down Expand Up @@ -170,14 +170,15 @@ npm run cdk:deploy
- [ブラウザ拡張機能を利用する](/browser-extension/README.md)

## 料金試算
[本アプリケーションをご利用いただく際の、構成と料金試算例](https://aws.amazon.com/jp/cdp/ai-chatapp/)を公開しております。
[GenU をご利用いただく際の、構成と料金試算例](https://aws.amazon.com/jp/cdp/ai-chatapp/)を公開しております。
この料金試算例は、Amazon Kendra を活用した RAG チャット機能を有効化する前提となっています。
セキュリティ強化のための AWS WAF や、ファイルのアップロード機能、Knowledge Base を活用したオプション機能などは含まれていない点にご注意ください。
従量課金制となっており、実際の料金はご利用内容により変動いたします。

## 参照
- [ブログ: Generative AI Use Cases JP をカスタマイズする方法](https://aws.amazon.com/jp/blogs/news/how-to-generative-ai-use-cases-jp/)
- [ブログ: Amazon Bedrock で Interpreter を開発!](https://aws.amazon.com/jp/builders-flash/202311/bedrock-interpreter/)
- [ブログ: 無茶振りは生成 AI に断ってもらおう ~ ブラウザに生成 AI を組み込んでみた ~](https://aws.amazon.com/jp/builders-flash/202405/genai-sorry-message/)

## Security

Expand Down
19 changes: 10 additions & 9 deletions browser-extension/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# ブラウザ拡張機能

こちらは、Generative AI Use Cases JP をより便利に利用するためのブラウザ拡張機能です。
こちらは、Generative AI Use Cases JP (略称:GenU) をより便利に利用するためのブラウザ拡張機能です。

> [!IMPORTANT]
> このブラウザ拡張機能を利用するためには、Generative AI Use Cases JP を事前にデプロイする必要があります。まずは、[こちら](https://github.com/aws-samples/generative-ai-use-cases-jp#%E3%83%87%E3%83%97%E3%83%AD%E3%82%A4)を参考にデプロイをしてください。
> このブラウザ拡張機能を利用するためには、GenU を事前にデプロイする必要があります。まずは、[こちら](https://github.com/aws-samples/generative-ai-use-cases-jp#%E3%83%87%E3%83%97%E3%83%AD%E3%82%A4)を参考にデプロイをしてください。
![拡張機能イメージ](../imgs/extension/extension_demo.png)

## Why Use ブラウザ拡張機能 ?

標準の Generative AI Use Cases JP の Web ページは便利に生成 AI を利用できますが、利用するたびに Web ページを開いてコピペするという使い方は、時には煩わしく感じることもあるでしょう。
このブラウザ拡張機能を利用すると、ブラウジング中に生成 AI を利用したくなったらページ変えずにそのまま生成 AI を利用できるため、さらに便利に生成 AI を活用することができます。
標準の GenU の Web アプリは便利に生成 AI を利用できますが、利用するたびに Web アプリを開いてコピペするという使い方は、時には煩わしく感じることもあるでしょう。
このブラウザ拡張機能を利用すると、ブラウジング中に生成 AI を利用したくなったら画面を切り替えずにそのまま生成 AI を利用できるため、さらに便利に生成 AI を活用することができます。
[拡張機能紹介記事](https://aws.amazon.com/jp/builders-flash/202405/genai-sorry-message/)もあわせてご参照ください。

### 利用シチュエーション

Expand All @@ -37,8 +38,8 @@
## FAQ

- 拡張機能をインストールすると誰でも利用できますか?
- Generative AI Use Cases JP でユーザ登録している方は、ログインすることで全員利用可能です。
- 各種認証の設定は、Generative AI Use Cases JP に従います。
- GenU でユーザ登録している方は、ログインすることで全員利用可能です。
- 各種認証の設定は、GenU に従います。
- **ユーザ登録していない方は、一切利用できません。**
- 社内情報を入れても安全ですか?
- Amazon Bedrock は入力データを学習データとして利用しませんので、安心してご利用いただけます([参考](https://aws.amazon.com/jp/bedrock/faqs/))。
Expand All @@ -52,13 +53,13 @@
- [こちらの方法](../docs/EXTENSION_BUILD.md#配布方法)を参照ください。
- プリセットのプロンプトを追加したい
- `browser-extension/src/app/features/prompt-settings/presetPrompts.ts` にプロンプトを設定して、再度「ビルド + インストール」をしてください。
- Generative AI Use Cases JP の Web 画面で使っているプロンプトを利用したい
- Web 画面から保存したシステムコンテキストを利用できます
- GenU の Web アプリで使っているプロンプトを利用したい
- Web アプリから保存したシステムコンテキストを利用できます
- 拡張機能の「プロンプト設定」画面から、利用設定を行なってください。
- ログインに失敗します
- 以下のいずれかの原因が考えられます。
- ユーザが登録されていない。
- Web ページからログインできるか確認してください
- Web アプリからログインできるか確認してください
- 設定が間違っている
- 拡張機能の「設定」画面を開き、各設定項目が正しいかご確認ください。
- 設定値は、[こちらの方法](../docs/EXTENSION_BUILD.md#その他のユーザー-windows-等)で確認できます。
14 changes: 7 additions & 7 deletions docs/DEPLOY_OPTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 設定方法

このアプリケーションは、AWS CDK の context で設定を変更します。
GenU は、AWS CDK の context で設定を変更します。

**CDK の context は '-c' でも指定できますが、その場合コードベースに変更が入らずフロントエンドのビルドが実施されないため、このアセットに関しては全ての設定は cdk.json の設定を変更することを推奨します。**

Expand Down Expand Up @@ -303,7 +303,7 @@ context の allowedSignUpEmailDomains に 許可するドメインのリスト

値はstringのlist形式で指定し、各stringには"@"を含めないでください。メールアドレスのドメインが、許可ドメインのいずれか同じであればサインアップできます。`null` を指定すると何も制限されず、すべてのドメインを許可します。`[]` を指定するとすべて禁止し、どのドメインのメールアドレスでも登録できません。

設定すると、許可ドメインでないユーザは、Webのサインアップ画面で「アカウントを作る」を実行したときにエラーになり、サービスに進むことができなくなります。また、AWSマネジメントコンソールで、Cognitoのページで「ユーザを作成」を実行したときにエラーになります。
設定すると、許可ドメインでないユーザは、Webのサインアップ画面で「アカウントを作る」を実行したときにエラーになり、GenU へのサインアップができなくなります。また、AWSマネジメントコンソールで、Cognitoのサービス画面から「ユーザを作成」を実行したときにエラーになります。

既にCognitoに作成されているユーザには影響ありません。新規にサインアップ・作成しようとしているユーザのみに適用されます。

Expand Down Expand Up @@ -336,7 +336,7 @@ context の allowedSignUpEmailDomains に 許可するドメインのリスト

#### IP アドレスによる制限

Web ページへのアクセスを IP で制限したい場合、AWS WAF による IP 制限を有効化することができます。[packages/cdk/cdk.json](/packages/cdk/cdk.json)`allowedIpV4AddressRanges` では許可する IPv4 の CIDR を配列で指定することができ、`allowedIpV6AddressRanges` では許可する IPv6 の CIDR を配列で指定することができます。
Web アプリへのアクセスを IP で制限したい場合、AWS WAF による IP 制限を有効化することができます。[packages/cdk/cdk.json](/packages/cdk/cdk.json)`allowedIpV4AddressRanges` では許可する IPv4 の CIDR を配列で指定することができ、`allowedIpV6AddressRanges` では許可する IPv6 の CIDR を配列で指定することができます。

```json
"context": {
Expand All @@ -347,7 +347,7 @@ Web ページへのアクセスを IP で制限したい場合、AWS WAF によ

#### 地理的制限

Web ページへのアクセスをアクセス元の国で制限したい場合、AWS WAF による地理的制限を有効化することができます。[packages/cdk/cdk.json](/packages/cdk/cdk.json) の `allowedCountryCodes` で許可する国を Country Code の配列で指定することができます。
Web アプリへのアクセスをアクセス元の国で制限したい場合、AWS WAF による地理的制限を有効化することができます。[packages/cdk/cdk.json](/packages/cdk/cdk.json) の `allowedCountryCodes` で許可する国を Country Code の配列で指定することができます。
指定する国の Country Code は[ISO 3166-2 from wikipedia](https://en.wikipedia.org/wiki/ISO_3166-2)をご参照ください。
```json
"context": {
Expand Down Expand Up @@ -380,7 +380,7 @@ Google Workspace や Microsoft Entra ID (旧 Azure Active Directory) などの I
## モニタリング用のダッシュボードの有効化

入力/出力 Token 数や直近のプロンプト集などが集約されたダッシュボードを作成します。
**ダッシュボードはアプリケーションに組み込まれたものではなく、Amazon CloudWatch のダッシュボードです。**
**ダッシュボードは GenU に組み込まれたものではなく、Amazon CloudWatch のダッシュボードです。**
Amazon CloudWatch のダッシュボードは、[マネージメントコンソール](https://console.aws.amazon.com/cloudwatch/home#dashboards)から閲覧できます。
ダッシュボードを閲覧するには、マネージメントコンソールにログイン可能かつダッシュボードが閲覧可能な権限を持った IAM ユーザーの作成が必要です。

Expand Down Expand Up @@ -455,9 +455,9 @@ cdk.json には以下の値を設定します。

## 別 AWS アカウントの Bedrock を利用したい場合

別 AWS アカウントの Bedrock を利用することができます。前提条件として、本サンプルアプリケーションによるデプロイは完了済みとします
別 AWS アカウントの Bedrock を利用することができます。前提条件として、GenU の初回デプロイは完了済みとします

別 AWS アカウントの Bedrock を利用するためには、別 AWS アカウントに IAM ロールを 1 つ作成する必要があります。作成する IAM ロール名は任意ですが、本サンプルアプリケーションでデプロイされた以下の名前で始まる IAM ロール名を、別アカウントで作成した IAM ロールの Principal に指定します。
別 AWS アカウントの Bedrock を利用するためには、別 AWS アカウントに IAM ロールを 1 つ作成する必要があります。作成する IAM ロール名は任意ですが、GenU デプロイ時に作成された以下の名前で始まる IAM ロール名を、別アカウントで作成した IAM ロールの Principal に指定します。

- `GenerativeAiUseCasesStack-APIPredictTitleService`
- `GenerativeAiUseCasesStack-APIPredictService`
Expand Down
6 changes: 3 additions & 3 deletions docs/EXTENSION_INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,16 @@

## 利用方法

インストールが正常にできている場合、任意の Web 画面で文字を選択すると、以下のように「Bedrock 連携」というポップアップ表示がされます。こちらをクリックすることで、選択した文字列が自動コピーされて拡張機能が起動します。
インストールが正常にできている場合、任意の Web サイトで文字を選択すると、以下のように「Bedrock 連携」というポップアップ表示がされます。こちらをクリックすることで、選択した文字列が自動コピーされて拡張機能が起動します。
![ポップアップ表示](../imgs/extension/extension_popup.png)

Web 画面の構造によっては、ポップアップが表示されないことがあります。その場合は、右クリックをしてメニューを表示し「generative-ai-use-cases-jp 拡張機能」をクリックして起動をしてください。この操作でも、選択した文字列が自動コピーされます。
Web サイトの構造によっては、ポップアップが表示されないことがあります。その場合は、右クリックをしてメニューを表示し「generative-ai-use-cases-jp 拡張機能」をクリックして起動をしてください。この操作でも、選択した文字列が自動コピーされます。
![コンテキストメニュー](../imgs/extension/extension_context_menu.png)

文字列を選択せずに右クリックした場合は、「Bedrock連携を開く」というメニューが表示されます。この場合は、文字列はコピーされずに拡張機能が開きます。
![コンテキストメニュー](../imgs/extension/extension_context_menu_default.png)

初回起動時はログイン画面が表示されます。Generative AI Use Cases JP の Web 画面と共通の認証を利用しているので、そちらと同じログイン情報を使ってログインしてください。
初回起動時はログイン画面が表示されます。GenU の Web アプリと共通の認証を利用しているので、そちらと同じログイン情報を使ってログインしてください。
![ログイン画面](../imgs/extension/extension_login.png)

## アンインストール方法
Expand Down
Loading

0 comments on commit 6f17789

Please sign in to comment.