How to Manage Prompts using GUI with Prompts Lab

Prompts Lab is a GUI tool that automatically detects prompts in your project and allows you to interact with them. You can use it to test your prompts with Large Language Models and see how the model responds to different prompts.

Note

To follow this guide, ensure that you have installed the ragbits package and are in a directory with Python files that define some ragbits prompts (usually, this would be the root directory of your project) in your command line terminal. If you haven't defined any prompts yet, you can use the SongPrompt example from Ragbit's Quickstart Guide and save it in a Python file with a name starting with "prompt_" in your project directory.

Starting Prompts Lab

Start Prompts Lab by running the following command in your terminal:

ragbits prompts lab

The tool will open in your default web browser. You will see a list of prompts detected in your project.

Note

By default, Prompts Lab assumes that prompts are defined in Python files with names starting with "prompt_". If you use a different naming convention, you can specify a different file name pattern using the --file-pattern option. For instance, if you want to search for prompts in all Python files in your project, run the following command:

ragbits prompts lab --file-pattern "**/*.py"

You can also change the default pattern for your entire project by setting the prompt_path_pattern configuration option in the [tool.ragbits] section of your pyproject.toml file.

Interacting with Prompts

To work with a specific prompt, select it from the list. The "Inputs" pane allows you to enter the values for the placeholders in the prompt. For the SongPrompt prompt example, this would be the subject, age group, and genre of the song:

Then, click "Render prompt" to view the final prompt content, with all placeholders replaced with the values you provided. To check how the Large Language Model responds to the prompt, click "Send to LLM".

Note

If there is no default LLM configured for your project, Prompts Lab will use OpenAI's gpt-3.5-turbo. Ensure that the OPENAI_API_KEY environment variable is set and contains your OpenAI API key.

Alternatively, you can use your own custom LLM factory (a function that creates an instance of ragbit's LLM class) by specifying the path to the factory function using the --llm-factory option with the ragbits prompts lab command.

Conclusion

In this guide, you learned how to use the ragbits CLI to interact with prompts that you have defined in your project using the Prompts Lab tool. This tool enables you to test your prompts with Large Language Models and see how the model responds to different prompts.