Improve prompt engineering quickstart for new users #618
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview ID generated: preview-improv-1758567116-d5a93eb |
katmayb
force-pushed
the
improve-prompt-quickstart
branch
from
cd233b2 to
e1149c7
Compare
|
Preview ID generated: preview-improv-1758568908-c397378 |
|
|
||
| To create a prompt, you'll define a list of messages that you want in your prompt and then push to LangSmith. | ||
|
|
||
| Use the language-specific constructor and push method: |
There was a problem hiding this comment.
Suggested change
| Use the language-specific constructor and push method: | |
| Use the language-specific constructor and push method: |
for language specific things, can we show/hide based on the language selected in the code group
There was a problem hiding this comment.
Not right now with CodeGroup, but it's on my to do list to figure out how to do this more elegantly.
|
Preview ID generated: preview-improv-1758804059-48f4d49 |
|
Preview ID generated: preview-improv-1758804721-d3d3f4e |
katmayb
force-pushed
the
improve-prompt-quickstart
branch
from
980fa0c to
6b79d6d
Compare
|
Preview ID generated: preview-improv-1758917983-96b2a4b |
|
|
||
| </CodeGroup> | ||
|
|
||
| You can view your prompts with the [SDK](https://docs.smith.langchain.com/reference/python/reference) or the [UI](https://smith.langchain.com). With the SDK, call [`list_prompts`](https://docs.smith.langchain.com/reference/python/client/langsmith.client.Client#langsmith.client.Client.list_prompts) (Python) or [`listPrompts`](https://docs.smith.langchain.com/reference/js/classes/client.Client#listprompts) (TypeScript) to display the prompts in your [workspace](/langsmith/administration-overview#workspaces). |
There was a problem hiding this comment.
Suggested change
| You can view your prompts with the [SDK](https://docs.smith.langchain.com/reference/python/reference) or the [UI](https://smith.langchain.com). With the SDK, call [`list_prompts`](https://docs.smith.langchain.com/reference/python/client/langsmith.client.Client#langsmith.client.Client.list_prompts) (Python) or [`listPrompts`](https://docs.smith.langchain.com/reference/js/classes/client.Client#listprompts) (TypeScript) to display the prompts in your [workspace](/langsmith/administration-overview#workspaces). | |
| Follow the resulting link to view the newly created Prompt Hub prompt in the LangSmith UI. |
|
|
||
| You can view your prompts with the [SDK](https://docs.smith.langchain.com/reference/python/reference) or the [UI](https://smith.langchain.com). With the SDK, call [`list_prompts`](https://docs.smith.langchain.com/reference/python/client/langsmith.client.Client#langsmith.client.Client.list_prompts) (Python) or [`listPrompts`](https://docs.smith.langchain.com/reference/js/classes/client.Client#listprompts) (TypeScript) to display the prompts in your [workspace](/langsmith/administration-overview#workspaces). | ||
|
|
||
| ## 3. Test a prompt |
There was a problem hiding this comment.
I would combine step 3 and 4. 3 is a little anti-climactic because you're just loading the prompt. So flow could be
- you’ll pull the prompt you created in step 2
- create a new version of a prompt - edit the system message
|
|
||
| # Push the updated prompt making sure to use the correct prompt name | ||
| # Tags can help you remember specific versions in your commit history | ||
| client.push_prompt("my-prompt", object=new_prompt, tags=["Spanish"]) |
There was a problem hiding this comment.
ah this actually creates a prompt tag, not a commit tag. i dont think we have a way to leave commit tags from the SDK. i'd remove this for now
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the prompt engineering quickstart guide for LangSmith. Intention is to make this accessible for new users, improve the flow of the page, and provide definitions for different features of prompt engineering.
Latest preview:
https://langchain-5e9cc07a-preview-improv-1758917983-96b2a4b.mintlify.app/langsmith/prompt-engineering-quickstart