How to change the AI prompt of the Dictionary (AI) function?

[Lyhcan]

Can we change both the AI system's and user's prompts for the button above, like we do with the other custom buttons? If so, how?

[omer-faruq]

Its prompt is in this file: dictdialog.lua. Since it is a bit complex I don't want to put it in Configuration.lua. Feel free to share your final version of it.

        content = prev_context .. "<<" .. highlightedText .. ">>" .. next_context .. "\n" ..
            "explain vocabulary or content in <<>> in above sentence with following format:\n" ..
            "⮞ Vocabulary in original conjugation if its different than the form in the sentence\n" ..
            "⮞ 3 synonyms for the word if available\n" ..
            "⮞ Give the meaning of the expression without reference to context.Answer this part in ".. configuration.features.dictionary_translate_to .." language\n" ..
            "⮞ Explanation of content in <<>> according to context. Answer this part in ".. configuration.features.dictionary_translate_to .." language\n" ..
            "⮞ Give another example sentence. Answer this part  in the language of text in <<>>\n" ..
            "only show the replies, do not give a description"

[Lyhcan]

Thanks! Is it possible to set that as the default action when I long-press a word? Instead of opening the KOReader dictionaries, could it trigger the AI popup directly?

edit: KOReader has a menu option called "Long-press on text" under Taps and gestures > Long-press on text. How hard would it be to add the "Dictionary (AI)" as an option to select there so that a long press on a word triggers the AI popup with the definition in context?

[omer-faruq]

The idea sounds like worth trying and I did some work using Windsurf, and almost accomplished the request. However, there is an issue: the info message remains open after Dictionary (AI) opens. Therefore I'm reluctant to put this on the main code, but you can try to use:
1- under the show_dictionary_button_in_dictionary_popup option add a line into Configuration.lua as:
replace_default_dictionary_popup = true, -- Set to true to replace the default dictionary popup with the AI dictionary popup
2- Replace main.lua with the attached one:
main.zip

[omer-faruq]

I have no idea about placing an option on the "Taps and Gestures" menu and using it for this purpose. I started this fork using Windsurf ( almost blindly), and unfortunately still have no idea about the code outside the plugin.

[Lyhcan]

VID_20250322_162352983.mp4

readerhighlight.txt

I'll give that a try thanks!. Regarding adding an option to the "Taps and gestures > Long-press on text" menu, you can do that in this file: \koreader\frontend\apps\reader\modules\readerhighlight.lua.

Here's what I've accomplished so far with ChatGPT's help, but I got stuck because I don't really know how to code, lol.

I managed to add an option called "Dictionary AI" under Taps and Gestures > Long-Press Menu. I can now select this option as the long-press action.

However, I think there's something wrong with the implementation of this function, which is also in the readerhighlight.lua file.

Here's what I've done with ChatGPT's help:

Added the AI Dictionary Option under Taps and Gestures > Long-Press Menu

local long_press_action = {
    {_("Ask with popup dialog"), "ask"},
    {_("Do nothing"), "nothing"},
    {_("Highlight"), "highlight"},
    {_("Select and highlight"), "select"},
    {_("Add note"), "note"},
    {_("Translate"), "translate"},
    {_("Wikipedia"), "wikipedia"},
    {_("Dictionary"), "dictionary"},
    {_("Fulltext search"), "search"},
    {_("Dictionary AI"), "dictionary_ai"},  -- Add the AI dictionary option
}

Modified onHoldRelease() function:

function ReaderHighlight:onHoldRelease()
    -- ... (existing code)

    if self.selected_text then
        if self.is_word_selection then
            self:lookupDictWord()
        else
            if long_final_hold or default_highlight_action == "ask" then
                -- bypass default action and show popup if long final hold
                self:onShowHighlightMenu()
            elseif default_highlight_action == "highlight" then
                self:saveHighlight(true)
                self:onClose()
            elseif default_highlight_action == "select" then
                self:startSelection()
                self:onClose()
            elseif default_highlight_action == "note" then
                self:addNote()
                self:onClose()
            elseif default_highlight_action == "translate" then
                self:translate()
            elseif default_highlight_action == "wikipedia" then
                self:lookupWikipedia()
                self:onClose()
            elseif default_highlight_action == "dictionary" then
                self:lookupDict()
                self:onClose()
            elseif default_highlight_action == "search" then
                self:onHighlightSearch()
            elseif default_highlight_action == "dictionary_ai" then
                self:lookupDictAI()  -- Handle the AI dictionary action
                -- No self:onClose() to not remove the selected text
                -- which will have been the first search result
            end
        end
    end
    return true
end

lookupDictAI() function (I believe the problem is here, but I'm not sure)

function ReaderHighlight:lookupDictAI()
    if self.selected_text then
        -- Attempt to load the Assistant plugin
        local success, showDictionaryDialog = pcall(require, "plugins/assistant.koplugin/dictdialog")
        if success then
            -- If the plugin is successfully loaded, call the dictionary dialog function
            showDictionaryDialog(self.ui, self.selected_text.text)
        else
            -- If the plugin is not available, show an error message
            UIManager:show(InfoMessage:new{
                text = _("The Assistant plugin is not available. Please install it to use the AI dictionary feature."),
            })
        end
    end
end

After successfully selecting the Dictionary AI option under Taps and Gestures > Long-Press, I get this message when I hold a word:
"The Assistant plugin is not available. Please install it to use the AI dictionary feature."

I have no idea about placing an option on the "Taps and Gestures" menu and using it for this purpose. I started this fork using Windsurf ( almost blindly), and unfortunately still have no idea about the code outside the plugin.

[Lyhcan]

You accomplished what I wanted yayy😃, It's a shame that the dictionary popup stays open lol. If someone manages to fix that issue, it could even be put in the main code. I'll give this a try later.