From 8fe160ab61dd5616c25aba50368124799607ca29 Mon Sep 17 00:00:00 2001 From: Piyush Jain Date: Tue, 16 Apr 2024 18:34:05 -0700 Subject: [PATCH 1/3] Updated README with details. --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ae0feb72..47f3d152 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,45 @@ # 🦜️🔗 LangChain 🤝 Amazon Web Services (AWS) -NOTE: This repository is a work-in-progress. Currently, the AWS integrations are in `langchain-community`. +This repository provides LangChain components for various AWS services. It aims to replace and expand upon the existing LangChain AWS components found in the `langchain-community` package in the LangChain repository. -This repository contains 1 package with AWS integrations with LangChain: +## Features -- [langchain-aws](https://pypi.org/project/langchain-aws/) integrates [AWS](https://aws.amazon.com). +- **LLM Classes**: Includes LLM classes for AWS services like Bedrock and SageMaker Endpoints, allowing you to leverage their language models within LangChain. +- **Retrievers**: Supports retrievers for services like Amazon Kendra and Bedrock KnowledgeBases, enabling efficient retrieval of relevant information from these sources. +- **Graphs**: Provides components for working with AWS Neptune graphs within LangChain. +- **More to come**: This repository will continue to expand and offer additional components for various AWS services as development progresses. + +**Note**: This repository will replace all AWS integrations currently present in the `langchain-community` package. Users are encouraged to migrate to this repository as soon as possible. + +## Installation + +You can install the `langchain-aws` package from PyPI. + +```bash +pip install langchain-aws +``` + +## Usage + +Here's a simple example of how to use the `langchain-aws` package. + +```python +from langchain_aws import BedrockLLM + +# Initialize the Bedrock LLM +llm = BedrockLLM(model_id="anthropic.claude-v2:1") + +# Invoke the llm +response = llm.invoke("Hello! How are you today?") +print(response) +``` + +For more detailed usage examples and documentation, please refer to the [LangChain docs](https://python.langchain.com/docs/integrations/platforms/aws/). + +## Contributing + +We welcome contributions to this project! Please follow the [contribution guide](.github/CONTRIBUTION.md) for instructions to setup the project for development and guidance on how to contribute effectively. + +## License + +This project is licensed under the [MIT License](LICENSE). From 69d0c00281de350d672761ce919db104bc1c4de5 Mon Sep 17 00:00:00 2001 From: Piyush Jain Date: Tue, 16 Apr 2024 18:50:26 -0700 Subject: [PATCH 2/3] Update links. --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 47f3d152..b2659f4b 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ This repository provides LangChain components for various AWS services. It aims ## Features -- **LLM Classes**: Includes LLM classes for AWS services like Bedrock and SageMaker Endpoints, allowing you to leverage their language models within LangChain. -- **Retrievers**: Supports retrievers for services like Amazon Kendra and Bedrock KnowledgeBases, enabling efficient retrieval of relevant information from these sources. -- **Graphs**: Provides components for working with AWS Neptune graphs within LangChain. +- **LLMs**: Includes LLM classes for AWS services like [Bedrock](https://aws.amazon.com/bedrock) and [SageMaker Endpoints](https://aws.amazon.com/sagemaker/deploy/), allowing you to leverage their language models within LangChain. +- **Retrievers**: Supports retrievers for services like [Amazon Kendra](https://aws.amazon.com/kendra/) and [KnowledgeBases for Amazon Bedrock](https://aws.amazon.com/bedrock/knowledge-bases/), enabling efficient retrieval of relevant information from these sources in your RAG applications. +- **Graphs**: Provides components for working with [AWS Neptune](https://aws.amazon.com/neptune/) graphs within LangChain. - **More to come**: This repository will continue to expand and offer additional components for various AWS services as development progresses. **Note**: This repository will replace all AWS integrations currently present in the `langchain-community` package. Users are encouraged to migrate to this repository as soon as possible. @@ -27,7 +27,9 @@ Here's a simple example of how to use the `langchain-aws` package. from langchain_aws import BedrockLLM # Initialize the Bedrock LLM -llm = BedrockLLM(model_id="anthropic.claude-v2:1") +llm = BedrockLLM( + model_id="anthropic.claude-v2:1" +) # Invoke the llm response = llm.invoke("Hello! How are you today?") @@ -38,7 +40,7 @@ For more detailed usage examples and documentation, please refer to the [LangCha ## Contributing -We welcome contributions to this project! Please follow the [contribution guide](.github/CONTRIBUTION.md) for instructions to setup the project for development and guidance on how to contribute effectively. +We welcome contributions to this project! Please follow the [contribution guide](https://github.com/langchain-ai/langchain-aws/blob/main/.github/CONTRIBUTING.md) for instructions to setup the project for development and guidance on how to contribute effectively. ## License From fa4d160682a68c46b5cd5e938122779e09cc04d5 Mon Sep 17 00:00:00 2001 From: Piyush Jain Date: Tue, 16 Apr 2024 18:51:42 -0700 Subject: [PATCH 3/3] Updated description. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b2659f4b..3d7de677 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository provides LangChain components for various AWS services. It aims ## Features - **LLMs**: Includes LLM classes for AWS services like [Bedrock](https://aws.amazon.com/bedrock) and [SageMaker Endpoints](https://aws.amazon.com/sagemaker/deploy/), allowing you to leverage their language models within LangChain. -- **Retrievers**: Supports retrievers for services like [Amazon Kendra](https://aws.amazon.com/kendra/) and [KnowledgeBases for Amazon Bedrock](https://aws.amazon.com/bedrock/knowledge-bases/), enabling efficient retrieval of relevant information from these sources in your RAG applications. +- **Retrievers**: Supports retrievers for services like [Amazon Kendra](https://aws.amazon.com/kendra/) and [KnowledgeBases for Amazon Bedrock](https://aws.amazon.com/bedrock/knowledge-bases/), enabling efficient retrieval of relevant information in your RAG applications. - **Graphs**: Provides components for working with [AWS Neptune](https://aws.amazon.com/neptune/) graphs within LangChain. - **More to come**: This repository will continue to expand and offer additional components for various AWS services as development progresses.