Skip to content

docs: tweaks to prompt creation and quickstart #873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −15
Open

docs: tweaks to prompt creation and quickstart #873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/prompt_engineering/how_to_guides/create_a_prompt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,14 @@ Click "Start" to run the prompt.

## Save your prompt

To save your prompt, click the "Save" button, name your prompt, and decide if you want it to be "private" or "public".
Private prompts are only visible to your workspace, while public prompts are discoverable to anyone.
To save your prompt, click the "Save" button and name your prompt.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To save your prompt, click the "Save" button and name your prompt.
To save your prompt, give it a unique name and click the "Save" button. By default, prompts are only accessible in the workspace they were created in.


The model and configuration you select in the Playground settings will be saved with the prompt. When you reopen the prompt, the model and configuration will automatically load from the saved version.
![](./static/create_a_prompt/save_prompt.png)
The model configuration settings you choose will be saved with the prompt. When you reopen the prompt, the model and configuration will automatically load from the saved version.

Prompts default to private and are only visible to your workspace, while public prompts are discoverable to anyone. You can make your prompt public by clicking the "Make public" button at the top of the prompt page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Prompts default to private and are only visible to your workspace, while public prompts are discoverable to anyone. You can make your prompt public by clicking the "Make public" button at the top of the prompt page.

:::tip Public Prompts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:::tip Public Prompts

The first time you create a public prompt, you'll be asked to set a LangChain Hub handle. All your public prompts will be linked to this handle. In a shared workspace, this handle will be set for the whole workspace.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The first time you create a public prompt, you'll be asked to set a LangChain Hub handle. All your public prompts will be linked to this handle. In a shared workspace, this handle will be set for the whole workspace.

:::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:::


![](./static/create_a_prompt/public_handle.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![](./static/create_a_prompt/public_handle.png)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would simplify and remove public prompts from here


## View your prompts
Expand Down
13 changes: 5 additions & 8 deletions docs/prompt_engineering/how_to_guides/langchain_hub.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@ sidebar_position: 6

# LangChain Hub

Navigate to the **LangChain Hub** section of the left-hand sidebar.
Navigate to the **Prompts** section of the left-hand sidebar and click on the **LangChain Hub** link at the bottom of the page.

![](./static/langchain_hub.png)
![](./static/langchain_hub/langchain_hub.png)

Here you'll find all of the publicly listed prompts in the LangChain Hub.
You can search for prompts by name, handle, use cases, descriptions, or models. You can fork prompts to your personal organization, view the prompt's details, and run the prompt in the playground.
You can [pull any public prompt into your code](./manage_prompts_programatically.mdx) using the SDK.

To view prompts tied to your workspace, visit the Prompts tab in the sidebar.
Here you'll find all of the publicly listed prompts in the LangChain Hub. Any prompt you mark as **public** will be listed here.

![](./static/prompts_tab.png)
You can search for prompts by name, handle, prompt tags, descriptions, or models. You can fork prompts to your personal organization, view the prompt's details, and run the prompt in the playground.
You can [pull any public prompt into your code](./manage_prompts_programatically.mdx) using the SDK.
Binary file removed docs/prompt_engineering/how_to_guides/static/create_a_prompt/save_prompt.png
View file
Open in desktop
Binary file not shown.
Binary file added docs/prompt_engineering/how_to_guides/static/langchain_hub/langchain_hub.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions docs/prompt_engineering/quickstarts/quickstart_ui.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ If you are interested in testing how your prompt performs over a dataset instead

One you have run some tests and made your desired changes to your prompt you can click the “Save” button to save your prompt for future use.

Prompts default to being private, which means they are only visible to your workspace. You can make your prompt public by clicking the "Make public" button at the top of the prompt page to share it with the LangChain Community via the [LangChain Hub](../how_to_guides/langchain_hub).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Prompts default to being private, which means they are only visible to your workspace. You can make your prompt public by clicking the "Make public" button at the top of the prompt page to share it with the LangChain Community via the [LangChain Hub](../how_to_guides/langchain_hub).
Prompts default to being private, which means they are only visible to your workspace.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here, remove public prompts. there really isnt a good reason for most ppl to be using


![](./static/save_prompt_ui.gif)

## 5. Iterate on a prompt
Expand All @@ -61,8 +63,7 @@ To improve your prompts:

![](./static/save_prompt_commit_ui.gif)

You can also tag specific commits to mark important moments in your commit history:

You can also use [Commit Tags](../how_to_guides/prompt_tags) to mark important versions in your commit history and to dynamically pull versions of your prompt in your code.
![](./static/tag_prompt_ui.gif)

## 6. Next steps
Expand Down
Loading