Introduction

The HQS Modeling Assistant is a virtual assistant to improve your interaction with our HQStage modules. It leverages Large Language Models (LLM) and allows the user to interact with our software via natural language, completely abstracting the underlying complex data structures and interfaces of its functionalities, allowing the user to talk about the fundamental science, instead of focusing on the specifics of the input of a certain software. For installation instruction please visit the basic usage section of the HQStage documentation.

The HQS Modeling Assistant can take several forms, but for now it is available as Jupyter Notebook Assistant, since all HQStage modules are used from within a Python programming environment. The Notebook Assistant provides a chat-widget within Jupyter notebooks. Via this chat, the assistant can help you learn about the functionality of our modules, as well as directly interact with the code cells in the notebook and execute code.

The Modeling Assistant is powered by the LLMs provided by OpenAI. For the installable version this requires an individual OpenAI API key. Please refer to the usage section for further instructions. To get the most out of using the Modeling Assistant, we have put together a few tips in the chapter on prompt engineering. While LLMs offer tremendous potential, they also present challenges, such as copyright issues related to training data and the phenomenon of hallucinations. The Modeling Assistant addresses the issues associated with hallucinations by integrating additional tools that enable verification of data structures and facilitate the execution of actual mathematical calculations to provide a powerful virtual assistant.

The development of the HQS Modeling Assistant was done with the goal of improving the user experience of our own software. However, the software architecture is general. If you are interested in building an assistant for your (scientific) software based on our Modeling Assistant to improve the user experience, please contact us at info@quantumsimulations.de.