You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
langchain/templates
ccurme c010ec8b71
patch: deprecate (a)get_relevant_documents (#20477)
- `.get_relevant_documents(query)` -> `.invoke(query)`
- `.get_relevant_documents(query=query)` -> `.invoke(query)`
- `.get_relevant_documents(query, callbacks=callbacks)` ->
`.invoke(query, config={"callbacks": callbacks})`
- `.get_relevant_documents(query, **kwargs)` -> `.invoke(query,
**kwargs)`

---------

Co-authored-by: Erick Friis <erick@langchain.dev>
6 days ago
..
anthropic-iterative-search patch: deprecate (a)get_relevant_documents (#20477) 6 days ago
basic-critique-revise templates: readme langsmith not private beta (#20173) 2 weeks ago
bedrock-jcvd docs: aws docs updates (#20571) 2 weeks ago
cassandra-entomology-rag templates: readme langsmith not private beta (#20173) 2 weeks ago
cassandra-synonym-caching templates: readme langsmith not private beta (#20173) 2 weeks ago
chain-of-note-wiki templates: readme langsmith not private beta (#20173) 2 weeks ago
chat-bot-feedback templates, cli: more security deps (#19006) 2 months ago
cohere-librarian patch: deprecate (a)get_relevant_documents (#20477) 6 days ago
csv-agent templates: readme langsmith not private beta (#20173) 2 weeks ago
docs pinecone[patch], docs: PineconeVectorStore, release 0.0.3 (#17896) 2 months ago
elastic-query-generator templates: readme langsmith not private beta (#20173) 2 weeks ago
extraction-anthropic-functions templates: readme langsmith not private beta (#20173) 2 weeks ago
extraction-openai-functions templates: readme langsmith not private beta (#20173) 2 weeks ago
gemini-functions-agent templates: `utilities` import fix (#20679) 1 week ago
guardrails-output-parser templates: readme langsmith not private beta (#20173) 2 weeks ago
hybrid-search-weaviate templates: readme langsmith not private beta (#20173) 2 weeks ago
hyde templates: readme langsmith not private beta (#20173) 2 weeks ago
intel-rag-xeon templates: readme langsmith not private beta (#20173) 2 weeks ago
llama2-functions templates: readme langsmith not private beta (#20173) 2 weeks ago
mongo-parent-document-retrieval templates: readme langsmith not private beta (#20173) 2 weeks ago
neo4j-advanced-rag templates: readme langsmith not private beta (#20173) 2 weeks ago
neo4j-cypher Update neo4j cypher templates to the function callback (#20515) 1 week ago
neo4j-cypher-ft Update neo4j cypher templates to the function callback (#20515) 1 week ago
neo4j-cypher-memory Update neo4j cypher templates to the function callback (#20515) 1 week ago
neo4j-generation templates: readme langsmith not private beta (#20173) 2 weeks ago
neo4j-parent templates: readme langsmith not private beta (#20173) 2 weeks ago
neo4j-semantic-layer templates: readme langsmith not private beta (#20173) 2 weeks ago
neo4j-semantic-ollama templates: readme langsmith not private beta (#20173) 2 weeks ago
neo4j-vector-memory templates: readme langsmith not private beta (#20173) 2 weeks ago
nvidia-rag-canonical templates: readme langsmith not private beta (#20173) 2 weeks ago
openai-functions-agent templates: `utilities` import fix (#20679) 1 week ago
openai-functions-agent-gmail templates: readme langsmith not private beta (#20173) 2 weeks ago
openai-functions-tool-retrieval-agent patch: deprecate (a)get_relevant_documents (#20477) 6 days ago
pii-protected-chatbot templates: readme langsmith not private beta (#20173) 2 weeks ago
pirate-speak templates: readme langsmith not private beta (#20173) 2 weeks ago
pirate-speak-configurable templates: readme langsmith not private beta (#20173) 2 weeks ago
plate-chain templates, cli: more security deps (#19006) 2 months ago
propositional-retrieval templates: readme langsmith not private beta (#20173) 2 weeks ago
python-lint templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-astradb templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-aws-bedrock templates: bump lockfile deps (#19001) 2 months ago
rag-aws-kendra templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-azure-search templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-chroma templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-chroma-multi-modal templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-chroma-multi-modal-multi-vector templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-chroma-private templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-codellama-fireworks templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-conversation templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-conversation-zep templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-elasticsearch templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-fusion templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-gemini-multi-modal templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-google-cloud-sensitive-data-protection templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-google-cloud-vertexai-search templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-gpt-crawler templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-jaguardb templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-lancedb templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-lantern templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-matching-engine templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-momento-vector-index templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-mongo templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-multi-index-fusion templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-multi-index-router templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-multi-modal-local templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-multi-modal-mv-local templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-ollama-multi-query templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-opensearch templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-pinecone templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-pinecone-multi-query templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-pinecone-rerank templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-redis templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-redis-multi-modal-multi-vector templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-self-query templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-semi-structured templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-singlestoredb templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-supabase templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-timescale-conversation templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-timescale-hybrid-search-time templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-vectara templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-vectara-multiquery templates: readme langsmith not private beta (#20173) 2 weeks ago
rag-weaviate templates: readme langsmith not private beta (#20173) 2 weeks ago
research-assistant templates: readme langsmith not private beta (#20173) 2 weeks ago
retrieval-agent templates: readme langsmith not private beta (#20173) 2 weeks ago
retrieval-agent-fireworks templates: readme langsmith not private beta (#20173) 2 weeks ago
rewrite-retrieve-read templates: `utilities` import fix (#20679) 1 week ago
robocorp-action-server templates: readme langsmith not private beta (#20173) 2 weeks ago
self-query-qdrant templates: update qdrant self query (#19218) 1 month ago
self-query-supabase templates: bump lockfile deps (#19001) 2 months ago
shopping-assistant templates: readme langsmith not private beta (#20173) 2 weeks ago
skeleton-of-thought templates: readme langsmith not private beta (#20173) 2 weeks ago
solo-performance-prompting-agent templates: readme langsmith not private beta (#20173) 2 weeks ago
sql-llama2 templates: `utilities` import fix (#20679) 1 week ago
sql-llamacpp templates: `utilities` import fix (#20679) 1 week ago
sql-ollama templates: `utilities` import fix (#20679) 1 week ago
sql-pgvector templates: readme langsmith not private beta (#20173) 2 weeks ago
sql-research-assistant templates: `utilities` import fix (#20679) 1 week ago
stepback-qa-prompting templates: `utilities` import fix (#20679) 1 week ago
summarize-anthropic templates: readme langsmith not private beta (#20173) 2 weeks ago
vertexai-chuck-norris templates: readme langsmith not private beta (#20173) 2 weeks ago
xml-agent templates: readme langsmith not private beta (#20173) 2 weeks ago
.gitignore Adds linter in templates (#12321) 6 months ago
Makefile core[patch], langchain[patch]: fix required deps (#14373) 5 months ago
README.md templates: readme langsmith not private beta (#20173) 2 weeks ago
poetry.lock templates: bump lockfile deps (#19001) 2 months ago
pyproject.toml infra, multiple: Upgrade configuration for Ruff v0.2.0 (#16905) 3 months ago

README.md

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. You can sign up for LangSmith 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/:

Screenshot of the LangServe Playground interface with input and output fields demonstrating pirate speak conversion.

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

Screenshot of the API documentation interface showing available endpoints for the pirate-speak application.

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.