Restructure AI documenation

JabRef · Aug 12, 2024 · 55fc859 · 55fc859
1 parent 8162d91
commit 55fc859
Show file tree

Hide file tree

Showing 10 changed files with 281 additions and 263 deletions.
diff --git a/en/ai.md b/en/ai.md
diff --git a/en/ai/README.md b/en/ai/README.md
@@ -0,0 +1,16 @@
+---
+description: Learn what AI features JabRef has.
+---
+
+# AI
+
+{% page-ref page="ai-functionality.md" %}
+
+{% page-ref page="ai-providers-and-api-keys.md" %}
+
+{% page-ref page="troubleshooting.md" %}
+
+{% page-ref page="preferences.md" %}
+
+{% page-ref page="local-llm.md" %}
+
diff --git a/en/ai/ai-functionality.md b/en/ai/ai-functionality.md
@@ -0,0 +1,25 @@
+# AI functionality in JabRef
+
+## AI summary tab
+
+We have made a new entry editor tab: "AI Summary", where AI will generate for you a quick overview of the paper.
+
+![AI summary tab screenshot](/img/AiSummary.png)
+
+The AI will mention for you main objectives of the research, methods used, key findings, and conclusions.
+
+## AI chat tab
+
+The next new entry editor tab is "AI chat", where all the question and answering (Q&A) happens.
+
+![AI chat tab screenshot](/img/AiChat.png)
+
+In this window you can see the following elements:
+
+- Chat history with your messages
+- Prompt for sending messages
+- A button for clearing the chat history (just in case)
+
+## How does the AI functionality work?
+
+In the background, JabRef analyses the linked PDF files of library entries. The information used after the indexing is then supplied to the AI, which, to be precise, in our case is a Large Language Model (LLM). The LLM is currently not stored on your computer. Instead, we have many integrations with AI providers (OpenAI, Mistral AI, Hugging Face), so you can choose the one you like the most. These AI providers are available only remotely via the internet. In short: we send chunks of text to AI service and then receive processed responses. In order to use it you need to configure JabRef to use your [API](https://en.wikipedia.org/wiki/API) key.