From 72ce19a66e579afb170fdc03358bb71116ab7dc0 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Tue, 13 Aug 2024 15:55:58 +0200 Subject: [PATCH] Integrate "ai-functionality.md" in "README.md" and fix images --- en/{ai/img => .gitbook/assets}/AiChat.png | Bin .../img => .gitbook/assets}/AiPreferences.png | Bin en/{ai/img => .gitbook/assets}/AiSummary.png | Bin en/ai/README.md | 28 +++++++++++++++--- en/ai/ai-functionality.md | 25 ---------------- en/ai/preferences.md | 2 +- 6 files changed, 25 insertions(+), 30 deletions(-) rename en/{ai/img => .gitbook/assets}/AiChat.png (100%) rename en/{ai/img => .gitbook/assets}/AiPreferences.png (100%) rename en/{ai/img => .gitbook/assets}/AiSummary.png (100%) delete mode 100644 en/ai/ai-functionality.md diff --git a/en/ai/img/AiChat.png b/en/.gitbook/assets/AiChat.png similarity index 100% rename from en/ai/img/AiChat.png rename to en/.gitbook/assets/AiChat.png diff --git a/en/ai/img/AiPreferences.png b/en/.gitbook/assets/AiPreferences.png similarity index 100% rename from en/ai/img/AiPreferences.png rename to en/.gitbook/assets/AiPreferences.png diff --git a/en/ai/img/AiSummary.png b/en/.gitbook/assets/AiSummary.png similarity index 100% rename from en/ai/img/AiSummary.png rename to en/.gitbook/assets/AiSummary.png diff --git a/en/ai/README.md b/en/ai/README.md index 70bb7c966..f48cd3c42 100644 --- a/en/ai/README.md +++ b/en/ai/README.md @@ -1,8 +1,28 @@ ---- -description: Learn what AI features JabRef has. ---- +# AI functionality in JabRef -# AI +## 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](../.gitbook/assets/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](../.gitbook/assets/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. {% page-ref page="ai-functionality.md" %} diff --git a/en/ai/ai-functionality.md b/en/ai/ai-functionality.md deleted file mode 100644 index 287be4eba..000000000 --- a/en/ai/ai-functionality.md +++ /dev/null @@ -1,25 +0,0 @@ -# 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. diff --git a/en/ai/preferences.md b/en/ai/preferences.md index 4d9cc8cff..c50dc414e 100644 --- a/en/ai/preferences.md +++ b/en/ai/preferences.md @@ -2,7 +2,7 @@ Here are some new options in the JabRef preferences. -![AI preferences](../img/AiPreferences.png) +![AI preferences](../.gitbook/assets/AiPreferences.png) - "Enable AI functionality in JabRef": by default it's turned off, so you need to check this option, if you want to use the new AI features - "AI provider": you can choose either OpenAI, Mistral AI, or Hugging Face