Adding docs for release (#640)

This PR adds the docs for the release of the improved prompt and chat
experience.
This commit is contained in:
Rodrigo Nader 2023-07-13 16:22:26 -03:00 committed by GitHub
commit c2cd390d7d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 149 additions and 0 deletions

View file

@ -0,0 +1,78 @@
import ThemedImage from "@theme/ThemedImage";
import useBaseUrl from "@docusaurus/useBaseUrl";
import ZoomableImage from "/src/theme/ZoomableImage.js";
import ReactPlayer from "react-player";
# Customize and Build a Chatbot with a custom System Message: A Step-by-Step Guide
## Overview
In this guide, we will modify the "Basic Chat with Prompt and History" example, integrating the ChatPromptTemplate with the SystemMessagePromptTemplate and HumanMessagePromptTemplate components. By following these steps, you'll be able to build a personalized chatbot that can interpret and respond based on user-defined System messages.
## Interactive Guide
<iframe
src="https://app.tango.us/app/embed/f05bb3a7-4ceb-4b61-921f-628563b562f6?iframe=true"
sandbox="allow-scripts allow-top-navigation-by-user-activation allow-popups allow-same-origin"
security="restricted"
title="Step-by-Step Instructions to Customize and Build a Chatbot with custom System Message"
width="100%"
height="800px"
referrerpolicy="strict-origin-when-cross-origin"
frameborder="0"
webkitallowfullscreen="webkitallowfullscreen"
mozallowfullscreen="mozallowfullscreen"
allowfullscreen="allowfullscreen"
></iframe>
## Step-by-Step Instructions
1. Navigate to the "Community Examples" section.
2. Locate the "Basic Chat with Prompt and History" example, and click on "Fork Example".
3. Once in the editor, find the "PromptTemplate" component and remove it.
4. Now, add these three components: ChatPromptTemplate, SystemMessagePromptTemplate, and HumanMessagePromptTemplate.
> **Note:** Remember to set the model to gpt-3.5-turbo-0613 or the most up-to-date version. The latest models have improved capabilities to comprehend System messages.
5. Open the "Prompt" field on the SystemMessagePromptTemplate component.
6. Enter the text: `You are a {role} that {behavior}.`
7. Save your changes by clicking on "Check & Save".
8. Define the 'role' variable by typing "obedient assistant".
9. Next, navigate to the HumanMessagePromptTemplate and open the "Prompt" field.
10. Here, simply enter `{input}`.
11. Save these changes by clicking on "Check & Save".
12. Now, you should see your flow populated with the variables you defined.
13. In the Memory component, set the 'Input Key' to "input".
> **Tip:** When using a Memory component with multiple variables, it's crucial to specify which variable should be used to generate the conversation history.
14. Click on the "Build" button to implement your changes.
15. Open the chat interface to test your modifications.
16. You should now be able to see and use the defined variables in the chat interface.
17. Click on 'role' to examine the variable you established in the canvas.
18. Now, let's define the 'behavior' variable.
19. Enter the text: "writes the word 'Langflow' at the end of every sentence."
20. Test your chatbot by typing "How can you help me?"
21. If everything was set up correctly, your chatbot should respond appropriately, following the defined behavior.
22. Congratulations! You have successfully customized and built your chatbot.
By following these instructions, you have created a dynamic chatbot capable of understanding and responding based on custom system messages, enhancing the user experience and interaction. Enjoy your personalized assistant!

View file

@ -0,0 +1,64 @@
import ThemedImage from "@theme/ThemedImage";
import useBaseUrl from "@docusaurus/useBaseUrl";
import ZoomableImage from "/src/theme/ZoomableImage.js";
import ReactPlayer from "react-player";
# Integrating a Document into a PromptTemplate Variable: A Step-by-Step Guide
## Overview
This guide takes you through the process of augmenting the "Basic Chat with Prompt and History" example. You'll learn how to embed documents as context into the PromptTemplate component utilizing a WebBaseLoader.
## Interactive Guide
<iframe
src="https://app.tango.us/app/embed/76578e84-a700-4b3b-a6ef-8a0350472781?iframe=true"
sandbox="allow-scripts allow-top-navigation-by-user-activation allow-popups allow-same-origin"
security="restricted"
title="Loading a document into a PromptTemplate variable"
width="100%"
height="800px"
referrerpolicy="strict-origin-when-cross-origin"
frameborder="0"
webkitallowfullscreen="webkitallowfullscreen"
mozallowfullscreen="mozallowfullscreen"
allowfullscreen="allowfullscreen"
></iframe>
## Step-by-Step Instructions
1. Start by navigating to the "Community Examples" section.
2. Find the "Basic Chat with Prompt and History" example and click on "Fork Example".
3. In the editor, open the "Template" field.
4. Here, introduce the `{context}` variable, placing it somewhere before the "Current conversation:" text.
5. Once done, save your changes by clicking on "Check & Save".
6. Next, open the search bar and type "web".
7. Drag and drop a WebBaseLoader (or any other loader of your choice) onto the canvas.
8. Connect this loader to the `{context}` variable that we just added.
9. In the "Web Page" field, enter "https://langflow.org/how-upload-examples".
10. Now, click on "ConversationBufferMemory".
11. In the "Input Key" field, enter "text" to define the Chat variable.
> **Tip:** When defining more than one variable and using a Memory component, it's crucial to specify which variable should be used to create the conversation history.
12. Click on the "Build" button to implement your changes.
13. Open the chat interface to test your modifications.
14. Try asking something like, "How do I upload examples?"
15. Click on "Display Prompt" to view your template.
16. Now, you can see what the model used as a basis to generate its response.
By following these instructions, you have successfully loaded a document into a PromptTemplate variable, allowing for more enriched and context-aware chat responses. This customization enhances user interaction by integrating relevant document content into the chat flow.

View file

@ -21,6 +21,12 @@ module.exports = {
"guidelines/collection",
],
},
{
type: "category",
label: "Guides",
collapsed: false,
items: ["guides/loading_document", "guides/chatprompttemplate_guide"],
},
// {
// type: 'category',
// label: 'Components',

View file

@ -1,6 +1,7 @@
import React from "react";
import Footer from "@theme-original/Footer";
import { MendableFloatingButton } from "@mendable/search";
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
export default function FooterWrapper(props) {
const iconSpan1 = React.createElement(