langchain/templates
Bagatur fa5d49f2c1
docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429)
ran 
```bash
g grep -l "langchain.vectorstores" | xargs -L 1 sed -i '' "s/langchain\.vectorstores/langchain_community.vectorstores/g"
g grep -l "langchain.document_loaders" | xargs -L 1 sed -i '' "s/langchain\.document_loaders/langchain_community.document_loaders/g"
g grep -l "langchain.chat_loaders" | xargs -L 1 sed -i '' "s/langchain\.chat_loaders/langchain_community.chat_loaders/g"
g grep -l "langchain.document_transformers" | xargs -L 1 sed -i '' "s/langchain\.document_transformers/langchain_community.document_transformers/g"
g grep -l "langchain\.graphs" | xargs -L 1 sed -i '' "s/langchain\.graphs/langchain_community.graphs/g"
g grep -l "langchain\.memory\.chat_message_histories" | xargs -L 1 sed -i '' "s/langchain\.memory\.chat_message_histories/langchain_community.chat_message_histories/g"
gco master libs/langchain/tests/unit_tests/*/test_imports.py
gco master libs/langchain/tests/unit_tests/**/test_public_api.py
```
2024-01-02 16:47:11 -05:00
..
anthropic-iterative-search docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
basic-critique-revise docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
bedrock-jcvd docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
cassandra-entomology-rag docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
cassandra-synonym-caching docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
chain-of-note-wiki docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
chat-bot-feedback docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
cohere-librarian docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
csv-agent docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
docs Fix typo (#15202) 2023-12-28 08:24:41 -08:00
elastic-query-generator docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
extraction-anthropic-functions docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
extraction-openai-functions docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
guardrails-output-parser docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
hybrid-search-weaviate docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
hyde docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
llama2-functions docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
mongo-parent-document-retrieval docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
neo4j-advanced-rag docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
neo4j-cypher docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
neo4j-cypher-ft docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
neo4j-cypher-memory docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
neo4j-generation docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
neo4j-parent docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
neo4j-vector-memory docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
openai-functions-agent docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
openai-functions-agent-gmail Add image (#14611) 2023-12-12 10:55:42 -08:00
openai-functions-tool-retrieval-agent docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
pii-protected-chatbot docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
pirate-speak docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
pirate-speak-configurable docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
plate-chain docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
propositional-retrieval docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
python-lint docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
rag-astradb docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-aws-bedrock docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-aws-kendra docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
rag-chroma docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-chroma-multi-modal docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-chroma-multi-modal-multi-vector docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-chroma-private docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-codellama-fireworks docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-conversation docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-conversation-zep docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-elasticsearch docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-fusion docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-gemini-multi-modal docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-google-cloud-sensitive-data-protection docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
rag-google-cloud-vertexai-search docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
rag-gpt-crawler docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-matching-engine docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-momento-vector-index docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-mongo docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-multi-index-fusion docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
rag-multi-index-router docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
rag-multi-modal-local docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-multi-modal-mv-local docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-ollama-multi-query docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-opensearch docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-pinecone docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-pinecone-multi-query docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-pinecone-rerank docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-redis docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-self-query docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-semi-structured docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-singlestoredb docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-supabase docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-timescale-conversation docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-timescale-hybrid-search-time docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-vectara docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-vectara-multiquery docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
rag-weaviate docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
research-assistant docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
retrieval-agent docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
rewrite-retrieve-read docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
self-query-qdrant docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
self-query-supabase docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
skeleton-of-thought docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
solo-performance-prompting-agent docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
sql-llama2 docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
sql-llamacpp docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
sql-ollama docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
sql-pgvector docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
sql-research-assistant docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
stepback-qa-prompting docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
summarize-anthropic docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 2024-01-02 16:47:11 -05:00
vertexai-chuck-norris docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
xml-agent docs, community[patch], experimental[patch], langchain[patch], cli[pa… (#15412) 2024-01-02 15:32:16 -05:00
.gitignore Adds linter in templates (#12321) 2023-10-26 13:55:07 -07:00
Makefile core[patch], langchain[patch]: fix required deps (#14373) 2023-12-07 14:24:58 -08:00
poetry.lock core[patch], langchain[patch]: fix required deps (#14373) 2023-12-07 14:24:58 -08:00
pyproject.toml core[patch], langchain[patch]: fix required deps (#14373) 2023-12-07 14:24:58 -08:00
README.md docs: Typo in Templates README.md (#14812) 2023-12-17 20:56:56 -05:00

LangChain Templates

LangChain Templates are the easiest and fastest way to build a production-ready LLM application. These templates serve as a set of reference architectures for a wide variety of popular LLM use cases. They are all in a standard format which make it easy to deploy them with LangServe.

🚩 We will be releasing a hosted version of LangServe for one-click deployments of LangChain applications. Sign up here to get on the waitlist.

Quick Start

To use, first install the LangChain CLI.

pip install -U langchain-cli

Next, create a new LangChain project:

langchain app new my-app

This will create a new directory called my-app with two folders:

  • app: This is where LangServe code will live
  • packages: This is where your chains or agents will live

To pull in an existing template as a package, you first need to go into your new project:

cd my-app

And you can the add a template as a project. In this getting started guide, we will add a simple pirate-speak project. All this project does is convert user input into pirate speak.

langchain app add pirate-speak

This will pull in the specified template into packages/pirate-speak

You will then be prompted if you want to install it. This is the equivalent of running pip install -e packages/pirate-speak. You should generally accept this (or run that same command afterwards). We install it with -e so that if you modify the template at all (which you likely will) the changes are updated.

After that, it will ask you if you want to generate route code for this project. This is code you need to add to your app to start using this chain. If we accept, we will see the following code generated:

from pirate_speak.chain import chain as pirate_speak_chain

add_routes(app, pirate_speak_chain, path="/pirate-speak")

You can now edit the template you pulled down. You can change the code files in packages/pirate-speak to use a different model, different prompt, different logic. Note that the above code snippet always expects the final chain to be importable as from pirate_speak.chain import chain, so you should either keep the structure of the package similar enough to respect that or be prepared to update that code snippet.

Once you have done as much of that as you want, it is In order to have LangServe use this project, you then need to modify app/server.py. Specifically, you should add the above code snippet to app/server.py so that file looks like:

from fastapi import FastAPI
from langserve import add_routes
from pirate_speak.chain import chain as pirate_speak_chain

app = FastAPI()

add_routes(app, pirate_speak_chain, path="/pirate-speak")

(Optional) Let's now configure LangSmith. LangSmith will help us trace, monitor and debug LangChain applications. LangSmith is currently in private beta, you can sign up here. If you don't have access, you can skip this section

export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_API_KEY=<your-api-key>
export LANGCHAIN_PROJECT=<your-project>  # if not specified, defaults to "default"

For this particular application, we will use OpenAI as the LLM, so we need to export our OpenAI API key:

export OPENAI_API_KEY=sk-...

You can then spin up production-ready endpoints, along with a playground, by running:

langchain serve

This now gives a fully deployed LangServe application. For example, you get a playground out-of-the-box at http://127.0.0.1:8000/pirate-speak/playground/:

playground.png

Access API documentation at http://127.0.0.1:8000/docs

docs.png

Use the LangServe python or js SDK to interact with the API as if it were a regular Runnable.

from langserve import RemoteRunnable

api = RemoteRunnable("http://127.0.0.1:8000/pirate-speak")
api.invoke({"text": "hi"})

That's it for the quick start! You have successfully downloaded your first template and deployed it with LangServe.

Additional Resources

Index of Templates

Explore the many templates available to use - from advanced RAG to agents.

Contributing

Want to contribute your own template? It's pretty easy! These instructions walk through how to do that.

Launching LangServe from a Package

You can also launch LangServe from a package directly (without having to create a new project). These instructions cover how to do that.