- Sidekick
- Description
- Guided tour
- Why Sidekick?
- Sidekick Features
- Sidekick Release Notes
- Usage
- Examples
- Running Sidekick
- About
- References
Sidekick is an AI powered tool for creativity, thinking, learning, exploring ideas, problem-solving, knowledge-building, and getting things done.
It provides a chat interface to OpenAI's GPT models along with pre-canned AI personas and a prompt fragment library to help you get more out of the AI and a working environment where you can create notes by selecting the most interesting and useful parts of the chat to edit and organise into a more complete text aligned with what you want.
For more details, see the Sidekick manual For more insights on how to use Sidekick, ask the Sidekick AI Help
Login, or create a new account if you don't already have one. Each user has their own database of chats and notes.
Once you have configured the app with your OpenAI API key, you can chat with the AI using the API. All your chats will be stored in Sidekick and you can edit them and use them to create notes.
Clicking the Spanner button in the main toolbar or clicking the 'Prompt Engineer' button at the bottom of the Chat window opens the Prompt Engineer, which includes a selection of pre-canned prompt templates.
Click a template name to copy the template to the prompt window. Prompt templates have this structure:
Some prompt text with optional {PARAMETERS} that you can double click on to replace with your own text.
To save new prompt templates of your own, just add a prompt name like this above your prompt and click the save button.
Right clicking on a message in the chat lets you copy it to the clipboard, copy it as HTML, append it to the prompt, use it as the prompt, append it to a note, append all messages to a note, delete it, or delete all messages. Curating the chat history by deleting individual messages that were not what you wanted can be a useful way to improve the AI's responses.
When text is selected, you can submit prompts provided in the Selection Actions sub-menu applied to that selection.
The Chat Actions sub-menu provides actions that can be applied to the whole chat.
The Personas tool lets you change the persona of the AI so the response can be provided from a perspective that suits your purpose. You can filter personas by name, keywords in their profile, and favourite status. So you can search for personas that are good at a particular topic or that have a particular personality. E.g. try searching for expert, creative, logic, company.
Different personas can give you different perspectives on the same prompt.
Code blocks are syntax highlighted.
Model settings lets you change the model and the temperature and other settings to alter (creativity / consistency) of the response.
Prompt composer lets you build your prompt from a library of fragments.
Sidekick Script can be created in a jupyter notebook style tool that lets you create cells of different types including text, lists, and templates to parameterise prompts for querying the AI.
Here is an example script to generate a quiz where the number of questions, topic areas, themes, methods for creating questions, and difficulty levels are parameterised. The script uses the AI to generate the questions and answers:
Sidekick Notes lets you create and edit notes. You can also import and export notes as text files, copy selected AI responses over from the chat window, and use the NoteWriter AI to write your note for you by telling it what you want.
Notes let you edit the content in plain text markdown and then render a view with the formatting applied.
The Sidekick Manual explains the features of the tool, the ideas behind them, how to use Sidekick and different scenarios you can use it for.
Sidekick AI Help lets you ask questions of the manual rather than reading it!
It also draws on the knowledge of GPT to expand on the principles outlined in the manual, which includes innovation techniques as well as descriptions of how the tool can be used, and provides examples of how to apply the tool to what you are working on.
Everyone has access to Generative AI in the form of ChatGPT and other tools. However most of these tools are designed for general use and are built on top of APIs that are more powerful under the hood. Many of the out-of-the-box tools also use the prompts users enter to further train their models. This is generally not the case for the APIs.
Sidekick is intended as a tool for people who want to use Generative AI to help them think, explore ideas, solve problems, build knowledge, and get things done. It is designed to be easy to use and to help you get the most out of the AI.
It's also using the APIs directly, so once you get your API key you can deploy Sidekick wherever you want and use it without having to worry about your prompts being used to train the AI. As all the code is provided you can also extend it or modify it to suit your needs.
GenAI has much more potential than chat. OpenAI have been making it easier to build on the models by adding features to the API. For example, You can write a program to call GPT-4 and tell it about other APIs you have access to and what they do so that as part of GPT-4's response to your prompt, it can ask you to make calls to those other APIs to get more information. This means you can integrate the 'AI in the cloud' to other information sources you have, and use its intelligence to build automations and enable it to answer questions based on realtime data or data only you have access to.
Sidekick v0 is the beginning of a project to provide a platform for extending and integrating AIs with information sources and other APIs to build a new kind of AI-powered tool for creativity, thinking, exploring ideas, problem-solving, knowledge-building, and getting things done.
You can either just deploy this and let it run, or you can use it as a starting point to build your own AI-powered tools.
- Chat with an AI
- Change the persona of the AI
- Re-ask the same questions of the AI with different personas
- Compose your prompt from a library of fragments
- Create and edit notes
- Augment notes with the best parts from your chats
- Export notes
- Import notes
- Use the Note Writer to write your note for you
- Add notes to the AI knowledge library so they can be used as knowledge in Chat
- Use the AI knowledge library to augment the AI's knowledge
- Create notes defining concepts of information that you want the AI to know about
- Click the book icon at the bottom of the Chat window to load notes as knowledge for use in that chat
- Your notes will be added into the user prompt automatically to provide context for the AI to respond to your prompt
- Add knowledge notes about you and how you want the AI to behave, what you are interested in, or specific knowledge relevant to you the AI doesn't know about
Go here: Release notes
- From the home page
- Click the
Explore Chatsbutton to show or hide the Chat Explorer view - Click the
Chatbutton to show or hide the Chat Window - Click the
Notesbutton to show or hide the Notes Explorer view - Click the
Personasbutton to change the persona of the AI - Click the
Prompt Composerbutton to show or hide the prompt composer
- Click the
- When in the Chat Window
- Enter a prompt
- Click the
Chatbutton or hit return to chat with the AI - Chats are saved automatically
- Click in the name field at the top of the chat if you want to rename it. Escape clears the name so you can enter a new one.
- Right click on a chat to:
- Copy it to the clipboard
- Copy as HTML to the clipboard, where responses are in markdown formatting
- Append to chat prompt, e.g. to refer to all or part of a previous response
- Use as chat prompt, e.g. to edit and continue the conversation
- Append to note, e.g. to save the most interesting and useful parts of the chat
- Append all to note, to save the whole chat into a note along with other chats or your own notes or to edit it
- Delete it from the chat history so it doesn't impact the AI's future responses
- Delete all messages to clear the chat and start again
- Click the
Notesbutton to show or hide the Notes Explorer view - From the Notes Explorer view
- Filter notes by name
- Bulk delete filtered notes that are no longer required
- Click on a note to edit it (there is a delete button in the note editor if you want to delete it)
- When in a Note
- Click the
Exportbutton to download a note as a local text file - Click the
Importbutton to import a local text file into the current note - Enter a prompt at the bottom of the note and click the
Chatbutton or hit return to chat with the AI about the note
- Click the
- Click the
Model Settingsbutton to open the Model Settings, where you can:- Change the model
- Change the temperature and other model settings to alter (creativity / consistency) of the response
- You will need your own OpenAI API key to use this application. You can get one here.
- Tech stack is: Python Flask NodeJS React MaterialUI, and you will need pipenv, npm, python3
See the Local installation guide for how to get this up and running.
The plan is to make all configuration editable from the user interface. For now, you can configure the application by editing the JSON configuration files.
To see how to change the way the application is installed and run and where it stores its settings and data, see the configuration guide.
This project is in active development, however each release is intended to be ready to use and feature complete as far as it has so far been developed.
Contribution guidelines for this project
This project is in active development. You can see the roadmap here.
Go here: References