JupyterLab Extension
Ask your Asyntai knowledge base from a JupyterLab side panel
Overview
The Asyntai AI Assistant extension adds a panel to the right sidebar of JupyterLab. Your team asks questions there and gets answers from your Asyntai knowledge base, without leaving the notebook.
Put your data dictionary, internal guides and team documentation in Asyntai. Analysts and researchers then get answers about tables, metrics and processes while they work, in more than 80 languages.
Features
- Ask from the side panel. Each conversation keeps its history, so follow-up questions work
- Insert in notebook. Put any answer in a new Markdown cell below the active cell
- Ask about the selection. Right-click a cell or a file and send the selected code or text to the panel
- Add a notebook to the knowledge base. Send the text and code of a notebook to Asyntai, so the assistant can answer from it
- Pick the knowledge base. If your account has more than one website, choose which one the panel asks
- Works with the light, dark and high-contrast themes
Requirements
- JupyterLab 4
- Python 3.10 or later
- An Asyntai account on the Starter plan or higher, because the extension uses the Asyntai API
Installation
Follow these steps to add Asyntai to JupyterLab:
Install the Extension
Run this command in the Python environment where JupyterLab runs:
pip install jupyterlab-asyntai-ai-assistantYou can also open the Extension Manager in the JupyterLab sidebar, search for Asyntai and click Install. Restart JupyterLab after the install.
Copy Your API Key
Sign in to Asyntai, open Settings → API and copy your API key.
Connect the Panel
Click the Asyntai icon in the right sidebar of JupyterLab. Paste your API key and click Save key. The extension checks the key and remembers it, so you connect only once.
Ask a Question
Write your question and press Enter. Press Shift+Enter for a new line.
Commands
Open the Command Palette with Ctrl+Shift+C (Cmd+Shift+C on macOS) and type Asyntai:
| Command | What it does |
|---|---|
| Open Asyntai AI Assistant | Opens the side panel |
| Ask Asyntai about the selection | Puts the selected text, or the active cell, in the question box |
| Add this notebook to the Asyntai knowledge base | Sends the Markdown and code of the open notebook to the knowledge base of the selected website |
| New Asyntai conversation | Starts a new conversation with an empty history |
Settings
Open Settings → Settings Editor and select Asyntai AI Assistant:
| Setting | What it does |
|---|---|
apiKey | Your Asyntai API key. The panel fills it in when you click Save key |
websiteId | The website whose knowledge base the panel asks. The panel fills it in when you pick a website |
apiBaseUrl | The address of the Asyntai API. Keep the default |
Tip: Add your data dictionary and metric definitions to the knowledge base in the Asyntai dashboard. Then ask questions like "Which table has the monthly revenue?" from the panel.
Removing It
Click Change API key at the bottom of the panel to enter another key. To remove the extension, run pip uninstall jupyterlab-asyntai-ai-assistant and restart JupyterLab.
Plans & Pricing
The extension is free. It uses the Asyntai API, which is part of the Starter plan and higher. Each question uses one message from your monthly allowance, shared with your website widget and your other integrations. View pricing.
Need Help?
If you have any questions or run into issues, contact us at [email protected].