Quick Start Guide - davidmarsoni/llog GitHub Wiki

The following is a quick start guide to help you get started with Llog. It will show you how to use the main features of the application and how to navigate through it.

:house: Home

The home page of our application. Use the top navigation bar for easy navigation across our application, or click on the two buttons in the middle to focus on its main functionalities:

Home page

  1. Home: Jumps back to the home page.
  2. Add Files: Open the Add Files page to upload and cache Notion content or external documents (PDF, TXT, MD).
  3. See Cached Content: Open the See Cached Content page to browse, filter, and manage all previously uploaded or cached files.
  4. AI Assistant: Open the AI Assistant page to chat with your uploaded content using the Standard Chat or the All Agents.

:inbox_tray: Add Files

This page allows you to upload and cache Notion content (pages or databases) and external documents (PDF, TXT, MD) to be used in the AI Assistant.

Add notion content

[!NOTE] If you don't know how to find the Notion page Id or the Notion database Id, you can just open the information box below the input field and it will show you how to find the Notion page Id or the Notion database Id.

  1. Notion Content: Cache Notion content (pages or databases) to be used in the AI Assistant.
  2. Document Upload: Upload external documents (PDF, TXT or MD) to be used in the AI Assistant.
  3. Toggle between Notion page and Database: Select if you want to cache a Notion page or a database.
  4. Create new Notion Cache: Create a new Notion cache to be used in the AI Assistant.

Add content

[!TIP] For really big Notion pages, we recommend exporting the page as a .md file and uploading it as a document. This will make the process much faster and more efficient.

  1. Drag and drop: Drag and drop your file from your local computer.

:mag: See Cached Content

This page allows you to browse, filter, and manage all the cached content you have uploaded or cached. You can also delete the cached content from this page.

alt text

[!NOTE] The name of the file is just for visibility. The file is not saved with this name; instead, we use a UUID. The name of the file is just there to help you identify the file that you have uploaded or cached. The UUID is used to identify the file in the database and in the AI Assistant.

  1. Filter: As this project can really rapidly become a mess with a lot of files, we added a filter to be able to filter the files by name or by other parameters.
  2. Metadata: See the metadata of the file. This will show you the metadata of the file that you have uploaded or cached. This will also show you the content of the file that you have uploaded or cached.
  3. Move: Move the file to another folder. This allows you to move the file to another folder you have created. You can also create a new folder from this page.
  4. Refresh: Refresh a Notion page or database. This will allow you to refresh the Notion page or database that you have cached.
  5. Delete: Delete the file that you have uploaded or cached. This allows you to delete the file you have uploaded or cached.

:open_file_folder: Folder Management

In the view page of the cached content, you can create folders to organize your files. You can also move files to other folders or delete them.

Folder management

  1. Add Folder: Create a new folder inside the current folder.

  2. Rename Folder: Rename the current folder.

    [!NOTE] The name of the folder will be updated for all the entries that are in the folder.

  3. Delete Folder: Delete the current folder. This will delete all the files inside the folder. You can also delete the folder from the home page.

    [!WARNING] Deleting a folder will move all the files inside the folder to the root folder. This will not delete the files inside the folder.

:scroll: Metadata View

This page allows you to see the metadata of the file that you have uploaded or cached. This is also where you can edit all the metadata of the file that you have uploaded or cached. This is important to be able to help the AI Assistant to understand the file that you have uploaded or cached.

Metadata view

  1. Generate AI Metadata: Generate the metadata of the file automatically. This will use the AI Assistant to generate the metadata of the file that you have uploaded or cached.

  2. Save Changes: Save the changes that you have made to the metadata of the file that you have uploaded or cached.

  3. Basic Metadata: This is the basic metadata of the file that you have uploaded or cached. This contains the type of the file, the creation date, or some useful information about the file.

  4. Advanced Metadata: This is the advanced metadata of the file that you have uploaded or cached. This includes the Theme, Topics and other information about the file.

    [!NOTE] All the advanced metadata are optional. You can leave them empty if you don't want to use them. The AI Assistant will still be able to use the file that you have uploaded or cached without the advanced metadata. It's just a help to make the AI Assistant more efficient and to help it understand the file that you have uploaded or cached.

:robot: AI Assistant

IA Chatbot

  1. Temperature: The temperature of the AI Assistant. This is a value between 0 and 2. The higher the temperature, the more creative the AI Assistant will be. The lower the temperature, the more precise the AI Assistant will be.

  2. Max Tokens: The maximum number of tokens that the AI Assistant will use to generate the answer. The higher the number of tokens, the more detailed the answer will be and the longer the chatbot could take to respond.

  3. Use RAG: Use the RAG (Retrieval Augmented Generation) to generate the answer. This will use the files that you have uploaded or cached to generate the answer. If you don't want to use the RAG, you can just uncheck the box and the AI Assistant will not use the files that you have uploaded or cached to generate the answer.

  4. Choice of the Assistant Type: Choose the type of the AI Assistant that you want to use. You can choose between the Standard Chat and the All Agents.

    [!IMPORTANT] The All Agents mode is like a deep research assistant. It will use multiple agents to generate the answer. This will take more time to generate the answer but it will be more precise and more detailed. This mode can also search information in the web to generate the answer.

  5. Send: Send the message to the AI Assistant. This will send the message to the AI Assistant and it will generate the answer.

:pushpin: Some tips and information about the AI Assistant:

[!NOTE] The AI chatbot will always take your history of the current chat into account. This means that if you ask a question, the AI Assistant will take into account all the previous questions and answers to generate the answer. If you don't want to use the history of the chat, you can just refresh the page and it will reset the chat. This will also reset the AI Assistant and it will not take into account the previous questions and answers.

[!NOTE] The AI Assistant is able to make your response in markdown format. This means that if you ask a question, the AI Assistant will generate the answer in markdown format.

[!TIP] The AI Assistant can respond to some of your instructions, such as the number of words in the answer. For example, you can ask the AI Assistant to generate a summary of a document and to limit the number of words to 100. The AI Assistant will take this into account and will generate the answer with the number of words that you have asked.