langchain/templates
Matvey Arye 180657ca7a
Add template for conversational rag with timescale vector (#13041)
**Description:** This is like the rag-conversation template in many
ways. What's different is:
- support for a timescale vector store.
- support for time-based filters.
- support for metadata filters.

<!-- Thank you for contributing to LangChain!

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,
- **Tag maintainer:** for a quicker response, tag the relevant
maintainer (see below),
- **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` to check this
locally.

See contribution guidelines for more information on how to write/run
tests, lint, etc:

https://github.com/langchain-ai/langchain/blob/master/.github/CONTRIBUTING.md

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/extras`
directory.

If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
 -->

---------

Co-authored-by: Erick Friis <erick@langchain.dev>
2023-11-10 16:12:32 -08:00
..
anthropic-iterative-search Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
basic-critique-revise Add basic critique revise template (#12688) 2023-11-09 17:33:29 -08:00
cassandra-entomology-rag Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
cassandra-synonym-caching Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
chat-bot-feedback Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
csv-agent Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
docs Add mongo parent template to index (#13222) 2023-11-10 11:56:44 -08:00
elastic-query-generator Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
extraction-anthropic-functions Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
extraction-openai-functions Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
guardrails-output-parser template versions again (#13030) 2023-11-07 15:15:18 -08:00
hybrid-search-weaviate Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
hyde Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
llama2-functions Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
mongo-parent-document-retrieval Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
neo4j-advanced-rag Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
neo4j-cypher Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
neo4j-cypher-ft Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
neo4j-cypher-memory Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
neo4j-generation Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
neo4j-parent Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
neo4j-vector-memory Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
openai-functions-agent Support oai tool call (#13110) 2023-11-09 07:29:29 -08:00
openai-functions-tool-retrieval-agent Tool Retrieval Template (#13104) 2023-11-08 18:33:31 -08:00
pii-protected-chatbot Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
pirate-speak Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
pirate-speak-configurable Pirate Speak Configurable Template (#13153) 2023-11-09 22:13:45 +00:00
plate-chain Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-astradb Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-aws-bedrock Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-aws-kendra Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-chroma Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-chroma-private Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-codellama-fireworks Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-conversation Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-conversation-zep Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-elasticsearch template versions again (#13030) 2023-11-07 15:15:18 -08:00
rag-fusion Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-matching-engine Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-momento-vector-index Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-mongo Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-pinecone Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-pinecone-multi-query Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-pinecone-rerank Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-redis template versions again (#13030) 2023-11-07 15:15:18 -08:00
rag-semi-structured Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-singlestoredb Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-supabase Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-timescale-conversation Add template for conversational rag with timescale vector (#13041) 2023-11-10 16:12:32 -08:00
rag-timescale-hybrid-search-time Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rag-vectara vectara rag mq (#13214) 2023-11-10 10:08:45 -08:00
rag-vectara-multiquery vectara rag mq (#13214) 2023-11-10 10:08:45 -08:00
rag-weaviate Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
rewrite-retrieve-read Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
self-query-qdrant Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
self-query-supabase Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
solo-performance-prompting-agent Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
sql-llama2 Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
sql-llamacpp Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
sql-ollama Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
stepback-qa-prompting Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
summarize-anthropic Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
xml-agent Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
.gitignore Adds linter in templates (#12321) 2023-10-26 13:55:07 -07:00
Makefile Format Templates (#12396) 2023-10-26 19:44:30 -07:00
poetry.lock Relock Templates (#13028) 2023-11-07 15:01:49 -08:00
pyproject.toml Both lint and format templates with ruff v0.1.3. (#12676) 2023-10-31 14:52:00 -07:00
README.md Update readmes with new cli install (#12847) 2023-11-03 12:10:32 -07: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 package/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.