https://github.com/mdibyo/spk
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mdibyo/spk
- Owner: mDibyo
- Created: 2024-04-24T16:24:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T10:46:24.000Z (about 2 years ago)
- Last Synced: 2025-02-21T11:48:15.439Z (over 1 year ago)
- Language: HTML
- Size: 81.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# spk
spk is a simple Chrome extension that enables voice typing in any textarea. It uses the Chrome Speech Recognition API, with OpenAI GPT 3.5-Turbo and GPT 4.0 for punctuation, capitalization, and proper noun-correction support.
## Concept
The spk extension is active as soon as any webpage is loaded:
- It starts by scanning the document for proper nouns - these are used to seed speech recognition since the user is more likely than not to be referring to items on the page.
- When the user enters an textarea, they immediately get the option to "spk" rather than type. After selecting, the user can start dictating what they want to type.
- "spk" first uses Chrome's Speech Recognition API for the initial speech-to-text and then improves/corrects it using an LLM chain.
- "spk" is able to learn from errors - "spk" remembers any edits that the user made to the voice dictation output, and takes those into consideration in future.
## Development
### OpenAI API Key
The extension in its current state requires that the user provide an Open API key for access to Open AI's LLMs. You will be able to add it in the "spk" extension dialog (accessed by clicking the "spk" Chrome extension icon in the Chrome browser).
### Install dependencies
This project requires node (v18+). If your system node version is not up-to-date, consider using a version manager like [NVM](https://github.com/nvm-sh/nvm) to install and manage node versions.
```shell
npm install
```
### Open an example webpage
Open an example webpage for the extension to work on. You can specify the example with the `EXAMPLE` environment variable.
```shell
EXAMPLE=best_food npm run start-example
```
If the `EXAMPLE` environment variable is not defined, the "default" example will be started.
**You can also skip this step and open any webpage.**
### Build Chrome extension and load into browser
In a separate terminal, run
```shell
npm start
```
This will create an unpacked version of the extension in a `dist` folder. Load the unpacked extension in Chrome following instructions [here](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked).
Add your Open AI key, as noted above.
Then go to any page.
**Note**: The autoreload behavior of the development version of the extension, makes it so that every tab reloads when a change is made to the extension(!). To avoid this, you can narrow down the set of domains the extension is active on, by changing the src/manifest.json file - update the "content_scripts"."matches" field to `["*://localhost:*/*"]`.
## Release
When the time is right, the Chrome extension can be released by building a packaged extension (with `npm build`) and then uploading to the Chrome App store.