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 license 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 (if change is visible to the user)
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

ThiloteE · 2025-03-23T11:17:47Z

I now remember why we did not hard-code system prompts in the AI preferences: Because of internationalisation. Hard-coded prompts necessitate for JabRef maintainers to translate them to other languages, if the community calls for it, whereas user configurable prompts give users the possibility to use their language of choice.

InAnYan

Awesome!

Left some small review comments

InAnYan · 2025-03-24T11:46:49Z

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

    </Loadable>

+    <HBox spacing="10" alignment="CENTER" fx:id="exQuestionBox">
+        <Label text="Try with examples" BorderPane.alignment="CENTER"/>
+        <Hyperlink fx:id="exQuestion1" text="What is the goal of the paper?" BorderPane.alignment="CENTER" styleClass="exampleQuestionStyle"/>


Thanks for introducing those questions.

Can you make them localized?

I think the proper way is to do this:

Leave text empty in FXML.

Then in some initialization method in Java class, call setText with Localization.lang("...").

Can't you just use the same method as for the "Try with examples" Label by adding a % in front? Or aren't they detected by the localization tests?

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

InAnYan · 2025-03-24T12:03:45Z

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

    </Loadable>

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


This should be localized with %.

See more at https://devdocs.jabref.org/code-howtos/localization.html#localization-in-fxml.

trag-bot · 2025-03-27T07:07:08Z

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

@@ -111,6 +119,35 @@ private void initializeNotice() {
        noticeText.setText(newNotice);
    }

+    private void initializeExampleQuestions() {
+        exQuestion1.setText(Localization.lang("What is the goal of the paper?"));


The strings for example questions should be defined as constants to avoid magic strings and improve maintainability.

Yeah, private static final String ....

@koppor This is a false positive. For l10n this doesn't work

I was thinking about

private static final String EXAMPLE_QUESTION_1 = Localization.lang("What is the goal of the paper?"));

on top of the class - to make it very easy to update the example question.

I also can follow the line of argumetnation that find-in-all-files also finds the string and then can be replaced.

Use the String you want to localize directly, do not use members or local variables: Localization.lang("Translate me"); instead of Localization.lang(someVariable) (possibly in the form someVariable = Localization.lang("Translate me")
https://devdocs.jabref.org/code-howtos/localization.html

maybe I confused it with that one

koppor · 2025-03-28T07:07:59Z

@kaushikaW Please merge upstream/main, because CHANGELOG.md was modified meanwhile.

trag-bot · 2025-03-29T15:49:30Z

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

+        addExampleQuestionAction(exQuestion3);
+    }
+
+    private void addExampleQuestionAction(Hyperlink hyperlink) {


The method addExampleQuestionAction contains nested logic that could be simplified by returning early when the hyperlink text is already in the chat history, following the fail-fast principle.

trag-bot · 2025-04-18T15:22:50Z

@trag-bot didn't find any issues in the code! ✅✨

kaushikaW · 2025-04-18T15:49:32Z

@InAnYan why this PR filing do I have mentioned wrong issue no in the PR description.

koppor · 2025-04-18T17:52:26Z

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

+    -fx-underline: false !important;
+    -fx-text-fill: -fx-text-base-color;
+}
+.exampleQuestionStyle:hover {


Emtpy line missing

Fixed these in #12966

koppor · 2025-04-18T17:52:37Z

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

@@ -57,11 +64,17 @@ public class AiChatComponent extends VBox {

    private final ObservableList<Notification> notifications = FXCollections.observableArrayList();

+


Too many empty lines

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 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

InAnYan requested changes Mar 24, 2025

View reviewed changes

subhramit added status: changes required Pull requests that are not yet complete and removed status: awaiting second review For non-trivial changes labels Mar 25, 2025

kaushikaW added 5 commits March 27, 2025 10:30

added localization to ai chat

442f7e5

Added localization to the AI chat

f58ccd2

merged with origin

3dfcaeb

added localization to ai chat

18966bd

added localization to ai chat

bc76d55

trag-bot bot reviewed Mar 27, 2025

View reviewed changes

kaushikaW requested a review from InAnYan March 27, 2025 07:23

koppor mentioned this pull request Mar 28, 2025

Post conflict message as soon as conflict occurrs #12842

Merged

1 task

kaushikaW added 2 commits March 29, 2025 21:00

make example questions strings contant strings

e705748

Merge remote-tracking branch 'upstream/main' into fix-for-issue-12745

e1a37c5

trag-bot bot reviewed Mar 29, 2025

View reviewed changes

kaushikaW requested a review from koppor March 29, 2025 15:50

koppor mentioned this pull request Apr 11, 2025

Add example questions to AI chat #12702

Closed

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

ffc990e

InAnYan approved these changes Apr 18, 2025

View reviewed changes

Siedlerchr added this pull request to the merge queue Apr 18, 2025

Merged via the queue into JabRef:main with commit 0d5de68 Apr 18, 2025
35 of 36 checks passed

koppor reviewed Apr 18, 2025

View reviewed changes

subhramit added a commit that referenced this pull request Apr 18, 2025

Fix newline comments by @koppor in #12747

73f174c

subhramit mentioned this pull request Apr 18, 2025

Fix newline comments #12966

Merged

2 tasks

subhramit added a commit that referenced this pull request Apr 18, 2025

Fix newline comments by @koppor in #12747 (#12966)

bc19818

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

ThiloteE commented Mar 23, 2025

InAnYan left a comment

InAnYan Mar 24, 2025

palukku Mar 24, 2025

InAnYan Mar 24, 2025

trag-bot bot Mar 27, 2025

koppor Mar 28, 2025

Siedlerchr Mar 28, 2025

koppor Mar 28, 2025

Siedlerchr Mar 28, 2025

Siedlerchr Mar 28, 2025

koppor commented Mar 28, 2025

trag-bot bot Mar 29, 2025

trag-bot bot commented Apr 18, 2025

kaushikaW commented Apr 18, 2025

koppor Apr 18, 2025

subhramit Apr 18, 2025

koppor Apr 18, 2025

		@@ -57,11 +64,17 @@ public class AiChatComponent extends VBox {

		private final ObservableList<Notification> notifications = FXCollections.observableArrayList();

Added example questions to AI chat #12747

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

Choose a reason for hiding this comment

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

ThiloteE commented Mar 23, 2025

InAnYan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trag-bot bot Mar 27, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koppor commented Mar 28, 2025

trag-bot bot Mar 29, 2025

Choose a reason for hiding this comment

trag-bot bot commented Apr 18, 2025

kaushikaW commented Apr 18, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaushikaW commented Mar 16, 2025 •

edited

Loading

subhramit commented Mar 16, 2025 •

edited

Loading