You can use the LangSmith Python and TypeScript SDK to manage prompts programmatically.
Previously this functionality lived in the langchainhub package which is now deprecated. All functionality going forward will live in the langsmith package.
In Python, you can directly use the LangSmith SDK (recommended, full functionality) or you can use through the LangChain package (limited to pushing and pulling prompts).In TypeScript, you must use the LangChain npm package for pulling prompts (it also allows pushing). For all other functionality, use the LangSmith package.
If you already have LANGSMITH_API_KEY set to your current workspace’s api key from LangSmith, you can skip this step.Otherwise, get an API key for your workspace by navigating to Settings > API Keys > Create API Key in LangSmith.Set your environment variable.
Copy
Ask AI
export LANGSMITH_API_KEY="lsv2_..."
What we refer to as “prompts” used to be called “repos”, so any references to “repo” in the code are referring to a prompt.
To create a new prompt or update an existing prompt, you can use the push prompt method.
Copy
Ask AI
from langsmith import Clientfrom langchain_core.prompts import ChatPromptTemplateclient = Client()prompt = ChatPromptTemplate.from_template("tell me a joke about {topic}")url = client.push_prompt("joke-generator", object=prompt)# url is a link to the prompt in the UIprint(url)
You can also push a prompt as a RunnableSequence of a prompt and a model. This is useful for storing the model configuration you want to use with this prompt. The provider must be supported by the LangSmith playground. (see settings here: Supported Providers)
Copy
Ask AI
from langsmith import Clientfrom langchain_core.prompts import ChatPromptTemplatefrom langchain_openai import ChatOpenAIclient = Client()model = ChatOpenAI(model="gpt-4o-mini")prompt = ChatPromptTemplate.from_template("tell me a joke about {topic}")chain = prompt | modelclient.push_prompt("joke-generator-with-model", object=chain)
To pull a prompt, you can use the pull prompt method, which returns a the prompt as a langchain PromptTemplate.To pull a private prompt you do not need to specify the owner handle (though you can, if you have one set).To pull a public prompt from the LangChain Hub, you need to specify the handle of the prompt’s author.
Similar to pushing a prompt, you can also pull a prompt as a RunnableSequence of a prompt and a model. Just specify include_model when pulling the prompt. If the stored prompt includes a model, it will be returned as a RunnableSequence. Make sure you have the proper environment variables set for the model you are using.
Copy
Ask AI
from langsmith import Clientclient = Client()chain = client.pull_prompt("joke-generator-with-model", include_model=True)chain.invoke({"topic": "cats"})
When pulling a prompt, you can also specify a specific commit hash or commit tag to pull a specific version of the prompt.
For pulling prompts, if you are using Node.js or an environment that supports dynamic imports, we recommend using the langchain/hub/node entrypoint, as it handles deserialization of models associated with your prompt configuration automatically.If you are in a non-Node environment, “includeModel” is not supported for non-OpenAI models and you should use the base langchain/hub entrypoint.
If you want to store your prompts in LangSmith but use them directly with a model provider’s API, you can use our conversion methods. These convert your prompt into the payload required for the OpenAI or Anthropic API.These conversion methods rely on logic from within LangChain integration packages, and you will need to install the appropriate package as a dependency in addition to your official SDK of choice. Here are some examples:
You can also list, delete, and like/unlike prompts using the list prompts, delete prompt, like prompt and unlike prompt methods. See the LangSmith SDK client for extensive documentation on these methods.
Copy
Ask AI
# List all prompts in my workspaceprompts = client.list_prompts()# List my private prompts that include "joke"prompts = client.list_prompts(query="joke", is_public=False)# Delete a promptclient.delete_prompt("joke-generator")# Like a promptclient.like_prompt("efriis/my-first-prompt")# Unlike a promptclient.unlike_prompt("efriis/my-first-prompt")