AskGPT: ChatGPT Highlight Plugin for KOReader

Introducing AskGPT, a new plugin for KOReader that allows you to ask questions about the parts of the book you're reading and receive insightful answers from ChatGPT, an AI language model. With AskGPT, you can have a more interactive and engaging reading experience, and gain a deeper understanding of the content.

Getting Started

To use this plugin, You'll need to do a few things:

Get KoReader installed on your e-reader. You can find instructions for doing this for a variety of devices here.

If you want to do this on a Kindle, you are going to have to jailbreak it. I recommend following this guide to jailbreak your Kindle.

Acquire an API key from an API account on OpenAI (with credits). Once you have your API key, create a configuration.lua file in the following structure or modify and rename the configuration.lua.sample file:

Note: The prior api_key.lua style configuration is deprecated. Please use the new configuration.lua style configuration.

local CONFIGURATION = {
    api_key = "YOUR_API_KEY",
    model = "gpt-4o-mini",
    base_url = "https://api.openai.com/v1/chat/completions"
}

return CONFIGURATION

In this new format you can specify the model you want to use, the API key, and the base URL for the API. The model is optional and defaults to gpt-4o-mini. The base URL is also optional and defaults to https://api.openai.com/v1/chat/completions. This is useful if you want to use a different model or a different API endpoint (such as via Azure or another LLM that uses the same API style as OpenAI).

For example, you could use a local API via a tool like Ollama and set the base url to point to your computers IP address and port.

local CONFIGURATION = {
    api_key = "ollama",
    model = "zephyr",
    base_url = "http://192.168.1.87:11434/v1/chat/completions",
    additional_parameters = {}
}

return CONFIGURATION

Other Features

Additionally, as other extra features are rolled out, they will be optional and can be set in the features table in the configuration.lua file.

Translation

To enable translation, you can set the translate_to parameter in the features table. For example, if you want to translate the text to French, you can set the translate_to parameter to "French".

By setting the translate_to parameter, you can have the plugin translate the text to the language you specify. This is useful if you are reading a book in a language you are not fluent in and want to understand a chunk of text in a language you are more comfortable with.

local CONFIGURATION = {
    api_key = "YOUR_API_KEY",
    model = "gpt-4o-mini",
    base_url = "https://api.openai.com/v1/chat/completions",
    features = {
        translate_to = "French"
    }
}

Changing the default system directives

You can control the default system behaviour by setting the chat_system_directive and/or translation_system_directive parameters in the features table. For example, for language learning, it can be useful to get information about grammar or vocabulary in addition of a direct translation.

local CONFIGURATION = {
    api_key = "YOUR_API_KEY",
    model = "gpt-4o-mini",
    base_url = "https://api.openai.com/v1/chat/completions",
    features = {
        chat_system_directive = "The following is a conversation with an AI assistant. The assistant is helpful, creative, clever, and very friendly. Answer as concisely as possible.",
        translation_system_directive = "You are a helpful translation assistant. Provide direct translations without additional commentary.",
    }

Installation

If you clone this project, you should be able to put the directory, askgpt.koplugin, in the koreader/plugins directory and it should work. If you want to use the plugin without cloning the project, you can download the zip file from the releases page and extract the askgpt.koplugin directory to the koreader/plugins directory. If for some reason you extract the files of this repository in another directory, rename it before moving it to the koreader/plugins directory.

How To Use

To use AskGPT, simply highlight the text that you want to ask a question about, and select "Ask ChatGPT" from the menu. The plugin will then send your highlighted text to the ChatGPT API, and display the answer to your question in a pop-up window.

I hope you enjoy using this plugin and that it enhances your e-reading experience. If you have any feedback or suggestions, please let me know!

If you want to support development, become a Sponsor on GitHub.

License: GPLv3