mirror of
https://github.com/hwchase17/langchain
synced 2024-11-18 09:25:54 +00:00
e52a734818
This document uses Oxford comma (A, B, and C), in this list the comma was missing before "and". This PR corrects that. <!-- Thank you for contributing to LangChain! Please title your PR "<package>: <description>", where <package> is whichever of langchain, community, core, experimental, etc. is being modified. Replace this entire comment with: - **Description:** a description of the change, - **Issue:** the issue # it fixes if applicable, - **Dependencies:** any dependencies required for this change, - **Twitter handle:** we announce bigger features on Twitter. If your PR gets announced, and you'd like a mention, we'll gladly shout you out! Please make sure your PR is passing linting and testing before submitting. Run `make format`, `make lint` and `make test` from the root of the package you've modified to check this locally. See contribution guidelines for more information on how to write/run tests, lint, etc: https://python.langchain.com/docs/contributing/ If you're adding a new integration, please include: 1. a test for the integration, preferably unit tests that do not rely on network access, 2. an example notebook showing its use. It lives in `docs/docs/integrations` directory. If no one reviews your PR within a few days, please @-mention one of @baskaryan, @eyurtsev, @hwchase17. -->
113 lines
7.3 KiB
Markdown
113 lines
7.3 KiB
Markdown
# 🦜️🔗 LangChain
|
|
|
|
⚡ Building applications with LLMs through composability ⚡
|
|
|
|
[](https://github.com/langchain-ai/langchain/releases)
|
|
[](https://github.com/langchain-ai/langchain/actions/workflows/check_diffs.yml)
|
|
[](https://pepy.tech/project/langchain)
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://twitter.com/langchainai)
|
|
[](https://discord.gg/6adMQxSpJS)
|
|
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/langchain-ai/langchain)
|
|
[](https://codespaces.new/langchain-ai/langchain)
|
|
[](https://star-history.com/#langchain-ai/langchain)
|
|
[](https://libraries.io/github/langchain-ai/langchain)
|
|
[](https://github.com/langchain-ai/langchain/issues)
|
|
|
|
Looking for the JS/TS library? Check out [LangChain.js](https://github.com/langchain-ai/langchainjs).
|
|
|
|
To help you ship LangChain apps to production faster, check out [LangSmith](https://smith.langchain.com).
|
|
[LangSmith](https://smith.langchain.com) is a unified developer platform for building, testing, and monitoring LLM applications.
|
|
Fill out [this form](https://airtable.com/appwQzlErAS2qiP0L/shrGtGaVBVAz7NcV2) to get off the waitlist or speak with our sales team.
|
|
|
|
## Quick Install
|
|
|
|
With pip:
|
|
```bash
|
|
pip install langchain
|
|
```
|
|
|
|
With conda:
|
|
```bash
|
|
conda install langchain -c conda-forge
|
|
```
|
|
|
|
## 🤔 What is LangChain?
|
|
|
|
**LangChain** is a framework for developing applications powered by language models. It enables applications that:
|
|
- **Are context-aware**: connect a language model to sources of context (prompt instructions, few shot examples, content to ground its response in, etc.)
|
|
- **Reason**: rely on a language model to reason (about how to answer based on provided context, what actions to take, etc.)
|
|
|
|
This framework consists of several parts.
|
|
- **LangChain Libraries**: The Python and JavaScript libraries. Contains interfaces and integrations for a myriad of components, a basic run time for combining these components into chains and agents, and off-the-shelf implementations of chains and agents.
|
|
- **[LangChain Templates](templates)**: A collection of easily deployable reference architectures for a wide variety of tasks.
|
|
- **[LangServe](https://github.com/langchain-ai/langserve)**: A library for deploying LangChain chains as a REST API.
|
|
- **[LangSmith](https://smith.langchain.com)**: A developer platform that lets you debug, test, evaluate, and monitor chains built on any LLM framework and seamlessly integrates with LangChain.
|
|
|
|
The LangChain libraries themselves are made up of several different packages.
|
|
- **[`langchain-core`](libs/core)**: Base abstractions and LangChain Expression Language.
|
|
- **[`langchain-community`](libs/community)**: Third party integrations.
|
|
- **[`langchain`](libs/langchain)**: Chains, agents, and retrieval strategies that make up an application's cognitive architecture.
|
|
|
|
|
|
|
|
## 🧱 What can you build with LangChain?
|
|
**❓ Retrieval augmented generation**
|
|
|
|
- [Documentation](https://python.langchain.com/docs/use_cases/question_answering/)
|
|
- End-to-end Example: [Chat LangChain](https://chat.langchain.com) and [repo](https://github.com/langchain-ai/chat-langchain)
|
|
|
|
**💬 Analyzing structured data**
|
|
|
|
- [Documentation](https://python.langchain.com/docs/use_cases/qa_structured/sql)
|
|
- End-to-end Example: [SQL Llama2 Template](https://github.com/langchain-ai/langchain/tree/master/templates/sql-llama2)
|
|
|
|
**🤖 Chatbots**
|
|
|
|
- [Documentation](https://python.langchain.com/docs/use_cases/chatbots)
|
|
- End-to-end Example: [Web LangChain (web researcher chatbot)](https://weblangchain.vercel.app) and [repo](https://github.com/langchain-ai/weblangchain)
|
|
|
|
And much more! Head to the [Use cases](https://python.langchain.com/docs/use_cases/) section of the docs for more.
|
|
|
|
## 🚀 How does LangChain help?
|
|
The main value props of the LangChain libraries are:
|
|
1. **Components**: composable tools and integrations for working with language models. Components are modular and easy-to-use, whether you are using the rest of the LangChain framework or not
|
|
2. **Off-the-shelf chains**: built-in assemblages of components for accomplishing higher-level tasks
|
|
|
|
Off-the-shelf chains make it easy to get started. Components make it easy to customize existing chains and build new ones.
|
|
|
|
Components fall into the following **modules**:
|
|
|
|
**📃 Model I/O:**
|
|
|
|
This includes prompt management, prompt optimization, a generic interface for all LLMs, and common utilities for working with LLMs.
|
|
|
|
**📚 Retrieval:**
|
|
|
|
Data Augmented Generation involves specific types of chains that first interact with an external data source to fetch data for use in the generation step. Examples include summarization of long pieces of text and question/answering over specific data sources.
|
|
|
|
**🤖 Agents:**
|
|
|
|
Agents involve an LLM making decisions about which Actions to take, taking that Action, seeing an Observation, and repeating that until done. LangChain provides a standard interface for agents, a selection of agents to choose from, and examples of end-to-end agents.
|
|
|
|
## 📖 Documentation
|
|
|
|
Please see [here](https://python.langchain.com) for full documentation, which includes:
|
|
|
|
- [Getting started](https://python.langchain.com/docs/get_started/introduction): installation, setting up the environment, simple examples
|
|
- Overview of the [interfaces](https://python.langchain.com/docs/expression_language/), [modules](https://python.langchain.com/docs/modules/), and [integrations](https://python.langchain.com/docs/integrations/providers)
|
|
- [Use case](https://python.langchain.com/docs/use_cases/qa_structured/sql) walkthroughs and best practice [guides](https://python.langchain.com/docs/guides/adapters/openai)
|
|
- [LangSmith](https://python.langchain.com/docs/langsmith/), [LangServe](https://python.langchain.com/docs/langserve), and [LangChain Template](https://python.langchain.com/docs/templates/) overviews
|
|
- [Reference](https://api.python.langchain.com): full API docs
|
|
|
|
|
|
## 💁 Contributing
|
|
|
|
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
|
|
|
|
For detailed information on how to contribute, see [here](https://python.langchain.com/docs/contributing/).
|
|
|
|
## 🌟 Contributors
|
|
|
|
[](https://github.com/langchain-ai/langchain/graphs/contributors)
|