langchain/templates
2024-01-03 13:28:05 -08:00
..
anthropic-iterative-search templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
basic-critique-revise templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
bedrock-jcvd templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
cassandra-entomology-rag templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
cassandra-synonym-caching templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
chain-of-note-wiki templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
chat-bot-feedback templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
cohere-librarian templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
csv-agent templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
docs Fix typo (#15202) 2023-12-28 08:24:41 -08:00
elastic-query-generator templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
extraction-anthropic-functions templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
extraction-openai-functions templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
guardrails-output-parser templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
hybrid-search-weaviate templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
hyde templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
llama2-functions templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
mongo-parent-document-retrieval templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
neo4j-advanced-rag templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
neo4j-cypher templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
neo4j-cypher-ft templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
neo4j-cypher-memory templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
neo4j-generation templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
neo4j-parent templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
neo4j-vector-memory templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
openai-functions-agent templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
openai-functions-agent-gmail templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
openai-functions-tool-retrieval-agent templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
pii-protected-chatbot templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
pirate-speak templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
pirate-speak-configurable templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
plate-chain templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
propositional-retrieval templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
python-lint templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-astradb templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-aws-bedrock templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-aws-kendra templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-chroma templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-chroma-multi-modal templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-chroma-multi-modal-multi-vector templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-chroma-private templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-codellama-fireworks templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-conversation templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-conversation-zep templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-elasticsearch templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-fusion templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-gemini-multi-modal templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-google-cloud-sensitive-data-protection templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-google-cloud-vertexai-search templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-gpt-crawler templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-matching-engine templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-momento-vector-index templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-mongo templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-multi-index-fusion templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-multi-index-router templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-multi-modal-local templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-multi-modal-mv-local templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-ollama-multi-query templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-opensearch templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-pinecone templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-pinecone-multi-query templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-pinecone-rerank templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-redis templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-self-query templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-semi-structured templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-singlestoredb templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-supabase templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-timescale-conversation templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-timescale-hybrid-search-time templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-vectara templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-vectara-multiquery templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rag-weaviate templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
research-assistant templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
retrieval-agent templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
rewrite-retrieve-read templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
self-query-qdrant templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
self-query-supabase templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
skeleton-of-thought templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
solo-performance-prompting-agent templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
sql-llama2 templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
sql-llamacpp templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
sql-ollama templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
sql-pgvector templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
sql-research-assistant templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
stepback-qa-prompting templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
summarize-anthropic templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
vertexai-chuck-norris templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
xml-agent templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
.gitignore
Makefile core[patch], langchain[patch]: fix required deps (#14373) 2023-12-07 14:24:58 -08:00
poetry.lock templates: fix deps (#15439) 2024-01-03 13:28:05 -08:00
pyproject.toml templates: fix deps (#15439) 2024-01-03 13:28:05 -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.