Skip to content
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

Change the prompt we send for generating titles to use a system message #545

Merged
merged 1 commit into from
Jul 31, 2023

Conversation

dkotter
Copy link
Collaborator

@dkotter dkotter commented Jul 27, 2023

Description of the Change

Similar to point 1 in #544, this PR updates the request we send to OpenAI to add our prompt as a system message instead of a user message, and leave the user message to just contain the content.

I don't think this should change anything about the titles that are returned but does seem like best practice and provides more flexibility in the future.

How to test the Change

  1. Ensure you have the title generation feature on and configured
  2. Try generating some titles and ensure content is returned
  3. If desired, try the same test on the latest released version of the plugin to see how titles may differ

Changelog Entry

Changed - Update our title generation prompt to use a system message.

Credits

Props @dkotter

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@dkotter dkotter added this to the 2.3.0 milestone Jul 27, 2023
@dkotter dkotter self-assigned this Jul 27, 2023
@dkotter dkotter requested review from a team and jeffpaul as code owners July 27, 2023 20:12
@dkotter dkotter requested review from a team and Sidsector9 and removed request for a team and jeffpaul July 27, 2023 20:45
Copy link
Member

@Sidsector9 Sidsector9 left a comment

Choose a reason for hiding this comment

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

One important change I noticed is how the tone of the responses have changed so much.
Before, with the user role, the responses suggested titles which were more personal but with the system role, it's like interacting with a chat-bot.

Title: 12 Must-Have Qualities of a Manager

develop

  • What Makes a Good Manager? Discover the Top Qualities for Leadership Success
  • The Top Qualities of a Good Manager: Building Trust and Focusing on Employee Strengths
  • Discover the Top Qualities of a Good Manager for Success
  • The Top Qualities of a Good Manager: Building Trust and Focusing on Employee Strengths

fix branch

  • 12 Must-Have Qualities of a Good Manager: Build Trust, Focus on Strengths, and More
  • The Qualities of a Good Manager: Building Trust and Focusing on Employee Strengths
  • 12 Must-Have Qualities of a Good Manager: Building Trust and Focusing on Employee Strengths
  • 12 Essential Qualities of a Manager for Building Trust and Success

I am wondering if it would be a good idea to provide switching roles as an admin setting maybe in future? 🤔

@Sidsector9 Sidsector9 merged commit 9af6fea into develop Jul 31, 2023
12 checks passed
@Sidsector9 Sidsector9 deleted the feature/modify-title-prompt branch July 31, 2023 06:50
@jeffpaul
Copy link
Member

jeffpaul commented Aug 1, 2023

@Sidsector9 I concur that at least having that be filterable would be nice, perhaps exposing as a setting as well

@Sidsector9
Copy link
Member

@jeffpaul I opened an issue here - #550

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants