-
Notifications
You must be signed in to change notification settings - Fork 81
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.
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
Add Tutorial 24: Building a Conversational Chat Application #196
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
"id": "TEebQqubxa4G" | ||
}, | ||
"source": [ | ||
"# Tutorial: Building a Human-like Chat Application\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about "building a chat application with ConversationalAgent"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@TuanaCelik I'd like to emphasize that the chat application is human-like or conversational in the title. Also, I noticed that we have the same "Doing something with something" structure in all tutorial titles. I lean toward updating the title structure for this one :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah ok, my main comment was around having the node we highlight in the title, which was the structure that Aga came up with if I remember correctly. But we can also make the conscious decision to change that if you like. If @dfokina and you both agree on this, I'm good 👍 -
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO it's good to have the node in the title – users will be able to find it easier and more drawn to try it out. I just looked up that not all of our tutorials do that, which can be confusing for me personally.
The easiest would be Building a Human-like Chat App with ConversationalAgent, but that's a tad too long.
How about Building a Conversational Chat App? It suggest both an idea of human-like natural language, and the use of ConversationalAgent 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I liked both options @dfokina . I'll try them and if the first one seems too long, I'll go with the second. Is it okay to use "app" rather than "application" in the title?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll confirm with Aga tomorrow, but I think it's okay to use "app", because we're using more informal language in haystack anyway :)
"\n", | ||
"A [ConversationalAgent]() is a type of agent that is specifically implemented to create chat applications. With its memory integration, the new ConversationalAgent enables human-like conversation with large language models (LLMs). \n", | ||
"\n", | ||
"This tutorial introduces you to the ConversationalAgent, ConversationSummaryMemory and explains how you can create your conversational chat application. \n" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ConversationalAgent
and ConversationSummaryMemory
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@TuanaCelik I usually don't mark component names as code
. Do you think I should change it in the rest tutorial as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tend to not, but usually try to for when I'm first introducing I do. I think it's your style choice :) Feel free to ignore comment
Left super minor comments. LGTM, great tutorial 🎉 |
Added some suggestions to the text, otherwise all good :) |
* Add links to predefined PromptTemplates
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apart from the title comment, all good with me so approving already ✅
This is not the final version, but it's ready for review