Package: jupyterlab-voice-control
jupyterlab-voice-control⚠️This extension is experimental⚠️Voice commands for JupyterLab extension relies on experimental Speech Recognition API and is not suitable for use in production environments. You can check the current support oncaniuse.com/speech-recognition.Please be aware that the Speech Recognition method is an implementation detail of the browser,
and some browsers, including Google Chrome, may send recordings of your voice to cloud for recognition.While it is currently just proof of concept, please do get in touch by opening a new issue if you found this extension
useful/promising and would like to leave any feedback which would be greatly appreciated.UsageTo use this extension look for a microphone () icon on the status bar.Press the disabled microphone icon () to start voice recognition (or useAlt+vshortcut). You will need to agree for the browser to use your microphone:You can use any of the commands available in thecommand palette, for example try "Download" or "Run selected cells".Sometimes the speech recognition may be inaccurate, or you may misremember the name of the command.
In those cases the voice control assistant will prompt you with suggestions with words
"Did you mean..." and one or more suggestions on the status bar:You can accept the first suggestion by saying "yes".To choose the second suggestion say "second suggestion", and so on.Speech synthesis option is available (in the settings) if you prefer it over checking the status bar continuously.The threshold for inclusion of a similar-sounding phrase as a suggestion can be adjusted in the settings.If there are no errors or suggestions, the recognised speech will be shown on the status bar together with a confidence estimate:By default commands recognised with low confidence (<50%) will not be executed (as it is deemed safer in case of any potentially destructive actions), but you can change the threshold in the settings.Creating custom commandsIn the settings editor you can assign custom phrases to commands in the same way as you can configure shortcuts.
We refer to the words you need to say in order to execute a command astrigger phrase.The voice control extension provides additional commands for interaction with the interface such as typing text (vc:insert-text), accepting suggestions (vc:accept-suggestion), stopping recognition (vc:stop-listening), etc.The trigger phrase can be a regular expression and includenamed capturing groups. The captured groups will be passed as arguments to the command (/merged with pre-specified arguments if any, with groups overriding pre-specified arguments in case of a collision). For example, to create a command for opening files we could specify:{"phrase":"^open file (?<path>.*)","command":"filebrowser:open-path"}^ensures that only phrases starting with "open file" will be matched.We provide commandvc:open-notebook(by default underopen notebook (?<path>.*)) which automatically
appends notebook file extension (.ipynb) as it can be problematic for speech recognition software.RequirementsJupyterLab >= 3.4 (may work with older versions of 3.x, but not tested)InstallTo install the extension, execute:pipinstalljupyterlab-voice-controlUninstallTo remove the extension, execute:pipuninstalljupyterlab-voice-controlContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyterlab-voice-control directory# Install package in development modepipinstall-e.# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Rebuild extension Typescript source after making changesjlpmbuildYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.# Watch the source directory in one terminal, automatically rebuilding when neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).By default, thejlpm buildcommand generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:jupyterlabbuild--minimize=FalseDevelopment uninstallpipuninstalljupyterlab-voice-controlIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedjupyterlab-voice-controlwithin that folder.Testing the extensionFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASE