Finish OpenAI integration for definition hint generation#121
Merged
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
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.
Description
This PR adds the UI components to the definition hints generated by the OpenAI API. It adds the hint field to the data sent to the front end, updates the TypeScript types, and changes the definition panel and obscurity panel to display the definition hints for words instead of the full definitions.
Related Issues
Resolves #113
Next Steps
The definition hints are unquestionably an improvement over the dictionary definitions for use in hint panels, but they are not perfect. Many hints still give away too much information, and some straight-up ignore the instructions, such as not to include any form of the root word in the hint. There will likely need to be iterative improvement on the hint generation logic before the hints are consistently generated correctly.
At a high level, this iterative improvement could include any of the following elements: