Added example questions to AI chat #12747

kaushikaW · 2025-03-16T10:54:31Z

Fixes #12702
Added 3 example questions to the AI chat tab section (see the screenshot).
Currently, the 3 questions are hardcoded in the codebase and are not being generated by the AI model.
Some extra styles have been added to improve the user experience.

Mandatory checks

I own the copyright of the code submitted and I licence it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

subhramit · 2025-03-16T13:23:39Z

Please keep in mind the contributing guidelines.

subhramit · 2025-03-16T13:24:27Z

@palukku Thank you for helping with reviews.

palukku · 2025-03-16T13:28:26Z

JabRef supports both light and dark modes, so please ensure that the colors are appropriate for both. The current text color might be too light, reducing readability, and the hover state is also not very legible.

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.fxml

src/main/java/org/jabref/gui/Base.css

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

# Conflicts: # src/main/java/org/jabref/gui/Base.css # src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.fxml # src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

kaushikaW · 2025-03-16T17:46:07Z

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.fxml

    </Loadable>

+    <HBox spacing="10" alignment="CENTER">


@palukku added external css styles and remove inline css styles

kaushikaW · 2025-03-16T17:46:44Z

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

@@ -62,6 +63,9 @@ public class AiChatComponent extends VBox {
    @FXML private Button notificationsButton;
    @FXML private ChatPromptComponent chatPrompt;
    @FXML private Label noticeText;
+    @FXML private Hyperlink exQuestion1;


@palukku added inline FXML annotations

kaushikaW · 2025-03-16T17:48:27Z

@palukku @subhramit Do I need to add UI changes I done in this issue to the CHANGELOG.md file

subhramit · 2025-03-16T20:17:58Z

@palukku @subhramit Do I need to add UI changes I done in this issue to the CHANGELOG.md file

No, just the summary should be fine. Add it to the changelog.

palukku

Your code looks fine now and works as intended.
However, one thing is missing in my opinion: the example questions are always displayed. It would be nice to check the history; if a question has already been sent, remove its "button" from the box. Once all example questions have been asked, remove the entire example box.

You can use chatPrompt#getHistory to check that and remove the hyperlinks by obtaining the parent HBox and removing them from its children.

kaushikaW · 2025-03-17T18:12:55Z

Your code looks fine now and works as intended. However, one thing is missing in my opinion: the example questions are always displayed. It would be nice to check the history; if a question has already been sent, remove its "button" from the box. Once all example questions have been asked, remove the entire example box.

You can use chatPrompt#getHistory to check that and remove the hyperlinks by obtaining the parent HBox and removing them from its children.

Well I also though of your opinion , but removing each example question as it's used creates a small issue—once all questions are gone, the user is cant see any example questions . is it ok

palukku

I made some adjustments to the style to better blend with JabRef's existing design. Additionally, I included the removal of buttons after use. Since the chat isn't persistent and varies across entries, we can safely remove each button individually after the corresponding question is asked. When JabRef is reopened, the chat will be empty again, and the suggested questions will reappear.

src/main/java/org/jabref/gui/Base.css

palukku · 2025-03-17T20:41:07Z

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.fxml

+    <HBox spacing="10" alignment="CENTER">
+        <Label
+                fx:id="exQuestionLabel"
+                text="Try with examples"
+                BorderPane.alignment="CENTER"
+                styleClass="exampleQuestionLabelStyle"
+        />


Suggested change

<HBox spacing="10" alignment="CENTER">

<Label

fx:id="exQuestionLabel"

text="Try with examples"

BorderPane.alignment="CENTER"

styleClass="exampleQuestionLabelStyle"

/>

<HBox fx:id="exQuestionBox" spacing="10" alignment="CENTER">

<Label

text="Try with examples"

BorderPane.alignment="CENTER"

/>

palukku · 2025-03-17T20:41:49Z

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

@@ -62,6 +63,9 @@ public class AiChatComponent extends VBox {
    @FXML private Button notificationsButton;
    @FXML private ChatPromptComponent chatPrompt;
    @FXML private Label noticeText;
+    @FXML private Hyperlink exQuestion1;


Suggested change

@FXML private Hyperlink exQuestion1;

@FXML private HBox exQuestionBox;

@FXML private Hyperlink exQuestion1;

palukku · 2025-03-17T20:42:35Z

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

+    private void sendExampleQuestions() {
+        exQuestion1.setOnAction(event -> {
+            onSendMessage(exQuestion1.getText());
+        });
+
+        exQuestion2.setOnAction(event -> {
+            onSendMessage(exQuestion2.getText());
+        });
+
+        exQuestion3.setOnAction(event -> {
+            onSendMessage(exQuestion3.getText());
+        });
+    }
+


Suggested change

private void sendExampleQuestions() {

exQuestion1.setOnAction(event -> {

onSendMessage(exQuestion1.getText());

});

exQuestion2.setOnAction(event -> {

onSendMessage(exQuestion2.getText());

});

exQuestion3.setOnAction(event -> {

onSendMessage(exQuestion3.getText());

});

}

private void sendExampleQuestions() {

addExampleQuestionAction(exQuestion1);

addExampleQuestionAction(exQuestion2);

addExampleQuestionAction(exQuestion3);

}

private void addExampleQuestionAction(Hyperlink hyperlink) {

if (chatPrompt.getHistory().contains(hyperlink.getText())) {

exQuestionBox.getChildren().remove(hyperlink);

if (exQuestionBox.getChildren().size() == 1) {

this.getChildren().remove(exQuestionBox);

}

return;

}

hyperlink.setOnAction(event -> {

onSendMessage(hyperlink.getText());

exQuestionBox.getChildren().remove(hyperlink);

if (exQuestionBox.getChildren().size() == 1) {

this.getChildren().remove(exQuestionBox);

}

});

}

palukku · 2025-03-17T20:48:52Z

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

@@ -10,6 +10,7 @@
 import javafx.collections.ObservableList;
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
+import javafx.scene.control.Hyperlink;
 import javafx.scene.control.Label;


Suggested change

import javafx.scene.control.Label;

import javafx.scene.control.Label;

import javafx.scene.layout.HBox;

this is needed for my code suggestion to work properly.

subhramit · 2025-03-18T11:37:27Z

@kaushikaW please take the latest pull from upstream, resolve merge conflicts and push a single commit for the merge to the updated state. Do not force-push.

kaushikaW · 2025-03-18T11:39:25Z

@kaushikaW please take the latest pull from upstream, resolve merge conflicts and push a single commit for the merge to the updated state. Do not force-push.

ok sure sorry for mistake

kaushikaW · 2025-03-18T12:02:08Z

Hi @palukku I go through your changes and added them to the code thanks for suggestions !

koppor · 2025-03-18T12:50:26Z

Hi @palukku I go through your changes and added them to the code thanks for suggestions !

No need to state this. This increases load of maintainers. ALL maintainers get a notification of your message. They need to switch context etc.

It is clear that you will work on that.

The only reason I see for commenting is that you say: I don't have time now, but will commit something one week :)

ThiloteE · 2025-03-18T17:23:55Z

Your code looks fine now and works as intended. However, one thing is missing in my opinion: the example questions are always displayed. It would be nice to check the history; if a question has already been sent, remove its "button" from the box. Once all example questions have been asked, remove the entire example box.

You can use chatPrompt#getHistory to check that and remove the hyperlinks by obtaining the parent HBox and removing them from its children.

I apologize for responding so late. Will it still be possible to regenerate one of those questions? LLMs are not precise and tend to confabulate, so regeneration is one of the main use cases as it helps for brainstorming.

I have not tried the PR yet, as I don't have much time and will not have much time in the coming weeks.

kaushikaW · 2025-03-18T17:52:59Z

Your code looks fine now and works as intended. However, one thing is missing in my opinion: the example questions are always displayed. It would be nice to check the history; if a question has already been sent, remove its "button" from the box. Once all example questions have been asked, remove the entire example box.
You can use chatPrompt#getHistory to check that and remove the hyperlinks by obtaining the parent HBox and removing them from its children.

I apologize for responding so late. Will it still be possible to regenerate one of those questions? LLMs are not precise and tend to confabulate, so regeneration is one of the main use cases as it helps for brainstorming.

I have not tried the PR yet, as I don't have much time and will not have much time in the coming weeks.

once user clicked on the example question it goes to the chat prompt and despaired from the example question bar (see the ss1). so like wise if user clicked on the all three example questions all the question goes to the chat prompt and disappeared from example question bar(see ss2) . so user have to run the application again to see the example questions.
ss1

ss2

Thoughts

with your thoughts we can use small button to regenerate all three questions (after all three questions are disappeared ) without re run the application to improve UX. (see below ss)

- I am suggesting an idea: Would it be a good approach to randomly pick three questions from a string array containing example questions and displayed to the user .

palukku · 2025-03-18T18:22:55Z

I apologize for responding so late. Will it still be possible to regenerate one of those questions? LLMs are not precise and tend to confabulate, so regeneration is one of the main use cases as it helps for brainstorming.

I have not tried the PR yet, as I don't have much time and will not have much time in the coming weeks.

Directly regenerating the example buttons is not possible, but if you're not happy with the answer you are free to ask the same question manually again or try to ask for a better answer and why the first response is not the one you expected. I don't see it as an issue for this pr since it's only a suggestion of things you can ask.

But an "regenerate response" Button next to the answer of the ai would be an idea, maybe we can open up a new issue for this.

palukku · 2025-03-18T18:27:34Z

- I am suggesting an idea: Would it be a good approach to randomly pick three questions from a string array containing example questions and displayed to the user .

As said here #12702 (comment) this would be a great feature to use ai to create (following) questions that are context aware.

palukku

Tried it out, works fine with both dark and light style.

subhramit · 2025-03-19T17:00:12Z

src/main/java/org/jabref/gui/Base.css

+
+
+
+


Remove these extra newlines

subhramit · 2025-03-19T17:52:03Z

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

@@ -270,3 +300,4 @@ private void deleteLastMessage() {
        }
    }
 }
+


Revert this as well

trag-bot · 2025-03-19T17:57:00Z

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

+            if (exQuestionBox.getChildren().size() == 1) {
+                this.getChildren().remove(exQuestionBox);
+            }


Code duplication exists in two places where the same condition and removal logic is repeated. Should be extracted to a separate method.

palukku · 2025-03-20T00:04:18Z

Oh and please add the changes in short and user friendly words to the CHANGELOG.md!

koppor and others added 3 commits March 15, 2025 22:05

Added example questions to AI chat

7dad3ec

Merge branch 'main' into fix-for-issue-121

cd2a456

Added example questions to AI chat

1e0d59a

kaushikaW marked this pull request as ready for review March 16, 2025 11:01

Merge branch 'main' into fix-for-issue-12745

8c8d8fd

palukku reviewed Mar 16, 2025

View reviewed changes

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java Outdated Show resolved Hide resolved

palukku reviewed Mar 16, 2025

View reviewed changes

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.fxml Outdated Show resolved Hide resolved

palukku reviewed Mar 16, 2025

View reviewed changes

src/main/java/org/jabref/gui/Base.css Outdated Show resolved Hide resolved

palukku reviewed Mar 16, 2025

View reviewed changes

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java Outdated Show resolved Hide resolved

kaushikaW and others added 5 commits March 16, 2025 22:19

added inline FXML annotaions

6402710

fix dark mode support for example questions lables

c2d03e5

refactored codes

70ea8fa

Added example questions to AI chat

cacb4cd

# Conflicts: # src/main/java/org/jabref/gui/Base.css # src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.fxml # src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

merged

dcb12df

kaushikaW commented Mar 16, 2025

View reviewed changes

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java Show resolved Hide resolved

kaushikaW commented Mar 16, 2025

View reviewed changes

koppor mentioned this pull request Mar 16, 2025

Added example questions to AI chat #12745

Closed

7 tasks

This was referenced Mar 16, 2025

Add PR creator as issue assignee when a PR is opened #12753

Merged

Add check for multiple consecutive empty lines #12754

Closed

kaushikaW requested a review from palukku March 17, 2025 14:03

palukku reviewed Mar 17, 2025

View reviewed changes

palukku mentioned this pull request Mar 17, 2025

fiexd the issue (added the sample questions in html file). #12756

Closed

kaushikaW requested a review from palukku March 17, 2025 18:17

palukku suggested changes Mar 17, 2025

View reviewed changes

kaushikaW added 3 commits March 18, 2025 16:39

Merge branch 'main' into fix-for-issue-12745

e7bbf52

refactor the code for issue JabRef#12747

65784bc

refactor the code for issue JabRef#12747

f1c8a10

kaushikaW force-pushed the fix-for-issue-12745 branch from 0d519e5 to f1c8a10 Compare March 18, 2025 11:32

resolve conflicts with main

f669126

kaushikaW requested a review from palukku March 18, 2025 12:00

palukku approved these changes Mar 19, 2025

View reviewed changes

subhramit reviewed Mar 19, 2025

View reviewed changes

remove unwanted lines in Base.css

fc969d6

subhramit reviewed Mar 19, 2025

View reviewed changes

remove unwanted lines in AI=iChatComponent.java

431bb08

trag-bot bot reviewed Mar 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added example questions to AI chat #12747

Added example questions to AI chat #12747

kaushikaW commented Mar 16, 2025 •

edited

Loading

subhramit commented Mar 16, 2025

subhramit commented Mar 16, 2025

palukku commented Mar 16, 2025

kaushikaW Mar 16, 2025

kaushikaW Mar 16, 2025

kaushikaW commented Mar 16, 2025

subhramit commented Mar 16, 2025 •

edited

Loading

palukku left a comment

kaushikaW commented Mar 17, 2025

palukku left a comment

palukku Mar 17, 2025

palukku Mar 17, 2025

palukku Mar 17, 2025 •

edited

Loading

palukku Mar 17, 2025

subhramit commented Mar 18, 2025

kaushikaW commented Mar 18, 2025

kaushikaW commented Mar 18, 2025

koppor commented Mar 18, 2025

ThiloteE commented Mar 18, 2025 •

edited

Loading

kaushikaW commented Mar 18, 2025 •

edited

Loading

palukku commented Mar 18, 2025

palukku commented Mar 18, 2025 •

edited

Loading

palukku left a comment

subhramit Mar 19, 2025

subhramit Mar 19, 2025

trag-bot bot Mar 19, 2025

palukku commented Mar 20, 2025

	@FXML private Hyperlink exQuestion1;
	@FXML private HBox exQuestionBox;
	@FXML private Hyperlink exQuestion1;

	import javafx.scene.control.Label;
	import javafx.scene.control.Label;
	import javafx.scene.layout.HBox;

@@ @@ -270,3 +300,4 @@ private void deleteLastMessage() { @@
                       }
                   }
               }

Added example questions to AI chat #12747

Are you sure you want to change the base?

Added example questions to AI chat #12747

Conversation

kaushikaW commented Mar 16, 2025 • edited Loading

Mandatory checks

subhramit commented Mar 16, 2025

subhramit commented Mar 16, 2025

palukku commented Mar 16, 2025

kaushikaW Mar 16, 2025

Choose a reason for hiding this comment

kaushikaW Mar 16, 2025

Choose a reason for hiding this comment

kaushikaW commented Mar 16, 2025

subhramit commented Mar 16, 2025 • edited Loading

palukku left a comment

Choose a reason for hiding this comment

kaushikaW commented Mar 17, 2025

palukku left a comment

Choose a reason for hiding this comment

palukku Mar 17, 2025

Choose a reason for hiding this comment

palukku Mar 17, 2025

Choose a reason for hiding this comment

palukku Mar 17, 2025 • edited Loading

Choose a reason for hiding this comment

palukku Mar 17, 2025

Choose a reason for hiding this comment

subhramit commented Mar 18, 2025

kaushikaW commented Mar 18, 2025

kaushikaW commented Mar 18, 2025

koppor commented Mar 18, 2025

ThiloteE commented Mar 18, 2025 • edited Loading

kaushikaW commented Mar 18, 2025 • edited Loading

palukku commented Mar 18, 2025

palukku commented Mar 18, 2025 • edited Loading

palukku left a comment

Choose a reason for hiding this comment

subhramit Mar 19, 2025

Choose a reason for hiding this comment

subhramit Mar 19, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 19, 2025

Choose a reason for hiding this comment

palukku commented Mar 20, 2025

kaushikaW commented Mar 16, 2025 •

edited

Loading

subhramit commented Mar 16, 2025 •

edited

Loading

palukku Mar 17, 2025 •

edited

Loading

ThiloteE commented Mar 18, 2025 •

edited

Loading

kaushikaW commented Mar 18, 2025 •

edited

Loading

palukku commented Mar 18, 2025 •

edited

Loading