Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/langchain-ai/weblangchain
LangChain-powered web researcher chatbot. Searches for sources on the web and cites them in generated answers.
https://github.com/langchain-ai/weblangchain
Last synced: about 1 month ago
JSON representation
LangChain-powered web researcher chatbot. Searches for sources on the web and cites them in generated answers.
- Host: GitHub
- URL: https://github.com/langchain-ai/weblangchain
- Owner: langchain-ai
- License: mit
- Created: 2023-10-04T03:02:21.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-03-21T14:26:02.000Z (6 months ago)
- Last Synced: 2024-07-13T02:32:18.245Z (2 months ago)
- Language: TypeScript
- Homepage: https://weblangchain.vercel.app
- Size: 190 KB
- Stars: 445
- Watchers: 10
- Forks: 95
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - langchain-ai/weblangchain - LangChain-powered web researcher chatbot. Searches for sources on the web and cites them in generated answers. (TypeScript)
README
# 🦜️🌐 WebLangChain
This repo is an example of performing retrieval using the entire internet as a document store.
**Try it live:** [weblangchain.vercel.app](https://weblangchain.vercel.app)
## ✅ Running locally
By default, WebLangChain uses [Tavily](https://tavily.com) to fetch content from webpages. You can get an API key from [by signing up](https://tavily.com/).
If you'd like to add or swap in different base retrievers (e.g. if you want to use your own data source), you can update the `get_retriever()` method in `main.py`.
1. Install backend dependencies: `poetry install`.
2. Make sure to set your environment variables to configure the application:
```
export OPENAI_API_KEY=
export TAVILY_API_KEY=
# for Anthropic
# remove models from code if unused
ANTHROPIC_API_KEY=
# if you'd like to use the You.com retriever
export YDC_API_KEY=
# if you'd like to use the Google retriever
export GOOGLE_CSE_ID=
export GOOGLE_API_KEY=
# if you'd like to use the Kay.ai retriever
export KAY_API_KEY=
# for tracing
export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_ENDPOINT="https://api.smith.langchain.com"
export LANGCHAIN_API_KEY=
export LANGCHAIN_PROJECT=
```
You will also need to put your Google Cloud credentials in a JSON file under `.google_vertex_ai_credentials.json` in the main directory if you would like to
use Google Vertex as an option. If you're not using Vertex, you'll need to remove `ChatVertexAI` from `main.py`.
3. Start the Python backend with `poetry run make start`.
4. Install frontend dependencies by running `cd nextjs`, then `yarn`.
5. Run the frontend with `yarn dev` for frontend.
6. Open [localhost:3000](http://localhost:3000) in your browser.
Under the hood, the chain is converted to a FastAPI server with various endpoints via [LangServe](https://github.com/langchain-ai/langserve).
This also includes a playground that you can use to interactively swap and configure various pieces of the chain.
You can find it running at `http://localhost:8080/chat/playground`.
## ☕ Running locally (JS backend)
Note that LangServe is not currently supported in JS, and customization of the retriever and model, as well as the playground, are unavailable.
1. Install frontend dependencies by running `cd nextjs`, then `yarn`.
2. Populate a `nextjs/.env.local` file with your own versions of keys from the `nextjs/.env.example` file, and set `NEXT_PUBLIC_API_BASE_URL` to `"http://localhost:3000/api"`.
3. Run the app with `yarn dev`.
4. Open [localhost:3000](http://localhost:3000) in your browser.
## ⚙️ How it works
The general retrieval flow looks like this:
1. Pull in raw content related to the user's initial query using a retriever that wraps Tavily's Search API.
- For subsequent conversation turns, we also rephrase the original query into a "standalone query" free of references to previous chat history.
2. Because the size of the raw documents usually exceed the maximum context window size of the model, we perform additional [contextual compression steps](https://python.langchain.com/docs/modules/data_connection/retrievers/contextual_compression/) to filter what we pass to the model.
- First, we split retrieved documents using a [text splitter](https://python.langchain.com/docs/modules/data_connection/document_transformers/).
- Then we use an [embeddings filter](https://python.langchain.com/docs/modules/data_connection/retrievers/contextual_compression/#embeddingsfilter) to remove any chunks that do not meet a similarity threshold with the initial query.
3. The retrieved context, the chat history, and the original question are passed to the LLM as context for the final generation.
Here's a LangSmith trace illustrating the above:
https://smith.langchain.com/public/f4493d9c-218b-404a-a890-31c15c56fff3/r
It's built using:
- [Tavily](https://tavily.com) as a retriever
- [LangChain](https://github.com/langchain-ai/langchain/) for orchestration
- [LangServe](https://github.com/langchain-ai/langserve) to directly expose LangChain runnables as endpoints
- [FastAPI](https://fastapi.tiangolo.com/)
- [Next.js](https://nextjs.org) for the frontend
## 🚀 Deployment
The live version is hosted on [Fly.dev](https://fly.dev) and [Vercel](https://vercel.com).
The backend Python logic is found in `main.py`, and the frontend Next.js app is under `nextjs/`.