Skip to content

Latest commit

 

History

History

ja

README.md

AWS Langchain

このリポジトリは Langchain と Amazon Kendra を利用するためのサンプルを提供します。 現在、SageMaker、OpenAI、および Anthropic プロバイダー向けに QA チェーンを実行するための Kendra retriever クラスのサンプルが含まれています。

インストール

リポジトリをクローンします

git clone https://github.com/aws-samples/amazon-kendra-langchain-extensions.git

リポジトリのあるディレクトリに移動します

cd amazon-kendra-langchain-extensions

サンプルディレクトリに移動します

cd kendra_retriever_samples

依存関係をインストールします

pip を使用する場合

pip install -r requirements.txt

Conda を利用する場合

conda env create -f environment.yml

Bedrock の場合

Bedrock を使用する場合、Bedrock サポートを持つ最新の boto3 および langchain バージョンに更新し、Bedrock へのアクセス権を持つ AWS_PROFILE を使用していることを確認してください。

pip install --force-reinstall "langchain>=0.0.306"
pip install --force-reinstall "boto3>=1.28.57"

サンプルの実行

サンプルを実行する前に、Large Language Model をデプロイする（または Anthropic や OpenAI を使用する場合は API キーを取得する）必要があります。このリポジトリのサンプルは、SageMaker Jumpstart と Amazon Bedrock を使用して展開されたモデルでテストされています。 LLM のモデル ID は以下の表にまとめられています。

モデル名 環境変数名 Jumpstart モデル ID streamlit プロバイダ 日本語対応
Falcon 40B instruct FALCON_40B_ENDPOINT huggingface-llm-falcon-40b-instruct-bf16 falcon40b
Bedrock Claude None bedrock_claude
Bedrock Claude V2 None bedrock_claudev2

LLMをデプロイした後、kendra ID、aws_region、エンドポイント名（または外部プロバイダーの API キー）の環境変数を設定する必要があります。

例えば、kendra_chat_open_ai.py のサンプルを実行する場合、以下の環境変数を設定する必要があります

  • AWS_REGION
  • KENDRA_INDEX_ID
  • OPENAI_API_KEY

以下のコマンドを使用して環境変数を設定できます。使用するプロバイダーの環境変数のみを設定します。たとえば、Flan-xl を使用する場合は FLAN_XXL_ENDPOINT のみを設定します。他のエンドポイントとキーは設定する必要はありません。

export LANGUAGE_CODE=ja
export AWS_REGION=<YOUR-AWS-REGION>
export AWS_PROFILE=<AWS Profile>
export KENDRA_INDEX_ID=<YOUR-KENDRA-INDEX-ID>

export FALCON_40B_ENDPOINT=<YOUR-SAGEMAKER-ENDPOINT-FOR-FALCON> # only if you are using falcon as the endpoint
export OPENAI_API_KEY=<YOUR-OPEN-AI-API-KEY> #  only if you are using OPENAI as the endpoint

streamlit アプリからのサンプルの実行（日本語未対応）

サンプルディレクトリには、streamlit を使用してウェブアプリとして実行できる app.py ファイルが含まれています。

streamlit run app.py falcon40b

上記のコマンドは、LLM チェーンとして kendra_chat_falcon_40b を実行します。異なるチェーンを実行するには、異なるプロバイダーを渡してください。たとえば、open_ai チェーンを実行する場合は streamlit run app.py openai を実行します。テーブル上の「streamlitプロバイダ名」列を活用してプロバイダ名を確認してください。

コマンドラインからのサンプルの実行

python <sample-file-name.py>

Contributing

このリポジトリのフォークを作成して、変更内容をプルリクエストで提出してください。 詳細については、CONTRIBUTING を参照してください。

License

このライブラリは MIT-0 ライセンスのもとで提供されています。詳細は LICENSE ファイルをご覧ください。