From 11769a8c8da91253fd2655c8301bff3098a2f0a4 Mon Sep 17 00:00:00 2001 From: Erick Friis <erick@langchain.dev> Date: Thu, 4 Apr 2024 17:28:44 -0700 Subject: [PATCH] x --- README.md | 5 +++++ libs/weaviate/README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 README.md create mode 100644 libs/weaviate/README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a0f70e3 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# 🦜️🔗 LangChain Weaviate + +This repository contains 1 package with Weaviate integrations with LangChain: + +- [langchain-weaviate](https://pypi.org/project/langchain-weaviate/) integrates [Weaviate](https://weaviate.io/). diff --git a/libs/weaviate/README.md b/libs/weaviate/README.md new file mode 100644 index 0000000..e8b177f --- /dev/null +++ b/libs/weaviate/README.md @@ -0,0 +1,41 @@ +# langchain-weaviate + +## About + +This package contains the [Weaviate](https://github.com/weaviate/weaviate) integrations for [LangChain](https://github.com/langchain-ai/langchain). + +- **Weaviate** is an open source, AI-native vector database that helps developers create intuitive and reliable AI-powered applications. +- **LangChain** is a framework for developing applications powered by language models. + +Using this package, LangChain users can conveniently set Weaviate as their vector store to store and retrieve embeddings. + +## Requirements + +To use this package, you need to have a running Weaviate instance. + +Weaviate can be [deployed in many different ways](https://weaviate.io/developers/weaviate/starter-guides/which-weaviate) such as in containerized environments, on Kubernetes, or in the cloud as a managed service, on-premises, or through a cloud provider such as AWS or Google Cloud. + +The deployment method to choose depends on your use case and infrastructure requirements. + +Two of the most common ways to deploy Weaviate are: +- [Docker Compose](https://weaviate.io/developers/weaviate/installation/docker-compose) +- [Weaviate Cloud Services (WCS)](https://console.weaviate.cloud) + +## Installation and Setup + +As an integration package, this assumes you have already installed LangChain. If not, please refer to the [LangChain installation guide](https://python.langchain.com/docs/get_started/installation). + +Then, install this package: + +```bash +pip install langchain-weaviate +``` + +## Usage + +Please see the included [Jupyter notebook](docs/vectorstores.ipynb) for an example of how to use this package. + +## Further resources + +- [LangChain documentation](https://python.langchain.com/docs) +- [Weaviate documentation](https://weaviate.io/developers/weaviate)