langchain/templates/pirate-speak
2023-11-16 17:10:08 -08:00
..
pirate_speak Harrison/quick start (#12491) 2023-10-28 16:26:52 -07:00
tests Harrison/quick start (#12491) 2023-10-28 16:26:52 -07:00
LICENSE Harrison/quick start (#12491) 2023-10-28 16:26:52 -07:00
poetry.lock IMPROVEMENT Allow openai v1 in all templates that require it (#13489) 2023-11-16 17:10:08 -08:00
pyproject.toml IMPROVEMENT Allow openai v1 in all templates that require it (#13489) 2023-11-16 17:10:08 -08:00
README.md Template Readmes and Standardization (#12819) 2023-11-03 13:15:29 -07:00

pirate-speak

This template converts user input into pirate speak.

Environment Setup

Set the OPENAI_API_KEY environment variable to access the OpenAI models.

Usage

To use this package, you should first have the LangChain CLI installed:

pip install -U langchain-cli

To create a new LangChain project and install this as the only package, you can do:

langchain app new my-app --package pirate-speak

If you want to add this to an existing project, you can just run:

langchain app add pirate-speak

And add the following code to your server.py file:

from pirate_speak.chain import chain as pirate_speak_chain

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"

If you are inside this directory, then you can spin up a LangServe instance directly by:

langchain serve

This will start the FastAPI app with a server is running locally at http://localhost:8000

We can see all templates at http://127.0.0.1:8000/docs We can access the playground at http://127.0.0.1:8000/pirate-speak/playground

We can access the template from code with:

from langserve.client import RemoteRunnable

runnable = RemoteRunnable("http://localhost:8000/pirate-speak")