How to use Arcana

Info

This service is currently in a beta phase and can change regularly. The same applies to the documentation.

In order to use an Arcana, you either need to set one up or use a publicly available Arcana. Once you have the Arcana ID and the key in the respective fields under the advanced options, you will be able to use it. You can see the Chat AI interface and for the currently selected model, the Meta Llama 3.1 8B RAG model, there are the options to set the Arcana ID and the key. The Chat AI window show the open advanced options for a model that supports Arcanas and both fields the Arcana ID and the Key are shown and currently empty.

These fields will be set automatically if you used a link to an Arcana. Similarly, the System prompt can also be adjusted using a Link. This is most likely the case for an important Arcana such study information or Manuals since setting the system prompt will enhance the phrasing and clarity of the response.

In order to interact with an Arcana, you need to use a model that supports the feature and put the ID and Key into the fields in the “Advanced Options” tab. Once this is done, you can interact with the Material using normal prompting. There are a few important points to be kept in mind. The Material is index using the Docling process, and therefore it is very important for the prompt to contain keywords and phrases that are or might be present in the document. This is crucial to retrieving the correct information. Otherwise, the model has a higher likelihood of hallucinating.

Understanding the output of a query

Once the model has responded to a prompt, you can immediately see that the information that were attached to your prompt by the index Material as now present in the response. Additionally, the actual reference is attached to the output below the response. The reference is directly generated from the Material that is index with this Arcana. Originally, the information might have been in a PDF, which got converted into an annotated Markdown file as you can learn in the Docling process. Therefore, the response will contain the reference in the Markdown format, and it will also be rendered as Markdown by the Chat AI interface.

Integration with chat AI

Currently, only a few models can interact with the Arcana meddle ware process. This will be expanded in the future, but for now it is important to select the current model. For simplicity, this will be preset, if a user follows an Arcana link.

Example queries and responses

Please open one of our public Arcanas for example the bash tutorial. We will now ask the chat bot a question:

  • Prompt: How do I list the files in a folder?
  • Response:
    You can list the files in a folder using the ls command.
    
    Here are some common options you can use with ls:
    
    ls: Lists the files in the current directory.
    ls -l: Lists the files in the current directory in a long format, including file permissions, ownership, and timestamps.
    ls -h: Lists the files in the current directory with human-readable sizes (e.g., 1K, 234M, etc.).
    ls -a: Lists all files in the current directory, including hidden files (those that start with a dot).
    ls -la: Lists all files in the current directory in a long format, including hidden files.
    ls -la --color: Lists all files in the current directory in a long format, including hidden files, with color highlighting for different file types.
    You can also use the cd command to change the directory to the one you want to list files from. For example, cd /path/to/directory will change the directory to the one specified, and then you can use ls to list the files in that directory..
        ```
  • Reference: Our Bash tutorial
The Chat AI window shows a selected Arcana for the Bash tutorial with an example prompt from earlier in this section.

In the screen shot you can also see the response contains references from the original document.