JabRef 6.0-beta.1 · org.jabref.logic.ai.preferences.AiPreferences

Modifier and Type	Field and Description
private final BooleanProperty	aiFeaturesEnabledCurrently Controls whether to show the privacy policy banner and whether to request a restart.
private final BooleanProperty	aiFeaturesEnabledInitially Controls whether the AI features should start/work in a JabRef session.
private final ObjectProperty<AiProvider>	aiProvider
private final BooleanProperty	autoGenerateEmbeddings
private final BooleanProperty	autoGenerateSummaries
private final StringProperty	chattingSystemMessageTemplate
private final StringProperty	chattingUserMessageTemplate
private final StringProperty	citationParsingSystemMessageTemplate
private final IntegerProperty	contextWindowSize
private final BooleanProperty	customizeExpertSettings
private static final AiProvider	DEFAULT_AI_PROVIDER
private static final Map<AiProvider, PredefinedChatModel>	DEFAULT_CHAT_MODEL
private final IntegerProperty	documentSplitterChunkSize
private final ObjectProperty<DocumentSplitterKind>	documentSplitterKind
private final IntegerProperty	documentSplitterOverlapSize
private final StringProperty	embeddingModel
private final IntegerProperty	followUpQuestionsCount
private final StringProperty	followUpQuestionsTemplate
private final StringProperty	geminiApiBaseUrl
private final StringProperty	geminiChatModel
private final BooleanProperty	generateFollowUpQuestions
private final StringProperty	huggingFaceApiBaseUrl
private final StringProperty	huggingFaceChatModel
private static final String	KEYRING_AI_SERVICE
private static final String	KEYRING_AI_SERVICE_ACCOUNT
private static final Logger	LOGGER
private final StringProperty	markdownChatExportTemplate
private final StringProperty	mistralAiApiBaseUrl
private final StringProperty	mistralAiChatModel
private final StringProperty	openAiApiBaseUrl
private final StringProperty	openAiChatModel
private final IntegerProperty	ragMaxResultsCount
private final DoubleProperty	ragMinScore
private final ObjectProperty<ResponseEngineKind>	responseEngineKind
private final StringProperty	summarizationChunkSystemMessageTemplate
private final StringProperty	summarizationCombineSystemMessageTemplate
private final StringProperty	summarizationFullDocumentSystemMessageTemplate
private final ObjectProperty<SummarizatorKind>	summarizatorKind
private final DoubleProperty	temperature
private final ObjectProperty<TokenEstimatorKind>	tokenEstimatorKind

Access	Constructor and Description
private	AiPreferences()
public	AiPreferences(boolean aiFeaturesEnabledCurrently, boolean autoGenerateEmbeddings, boolean autoGenerateSummaries, AiProvider aiProvider, String openAiChatModel, String mistralAiChatModel, String geminiChatModel, String huggingFaceChatModel, boolean customizeExpertSettings, String openAiApiBaseUrl, String mistralAiApiBaseUrl, String geminiApiBaseUrl, String huggingFaceApiBaseUrl, SummarizatorKind summarizatorKind, TokenEstimatorKind tokenEstimatorKind, String embeddingModel, double temperature, int contextWindowSize, DocumentSplitterKind documentSplitterKind, int documentSplitterChunkSize, int documentSplitterOverlapSize, ResponseEngineKind responseEngineKind, int ragMaxResultsCount, double ragMinScore, String chattingSystemMessageTemplate, String chattingUserMessageTemplate, String summarizationChunkSystemMessageTemplate, String summarizationCombineSystemMessageTemplate, String summarizationFullDocumentSystemMessageTemplate, String citationParsingSystemMessageTemplate, String markdownChatExportTemplate, boolean generateFollowUpQuestions, int followUpQuestionsCount, String followUpQuestionsTemplate)

Method Summary

Modifier and Type	Method and Description
public BooleanProperty	aiFeaturesEnabledCurrentlyProperty()
public ReadOnlyBooleanProperty	aiFeaturesEnabledProperty()
public ObjectProperty<AiProvider>	aiProviderProperty()
public BooleanProperty	autoGenerateEmbeddingsProperty()
public BooleanProperty	autoGenerateSummariesProperty()
public StringProperty	chattingSystemMessageTemplateProperty()
public StringProperty	chattingUserMessageTemplateProperty()
public StringProperty	citationParsingSystemMessageTemplateProperty()
public IntegerProperty	contextWindowSizeProperty()
public void	copyFrom(AiPreferences other) Copies all persisted, user-editable values from `other` into this instance.
public static AiPreferences	copyOf(AiPreferences other) Creates an independent copy of `other`, e.g. as a dialog-scoped working copy that is edited freely and flushed back via `copyFrom(AiPreferences)` on save.
public BooleanProperty	customizeExpertSettingsProperty()
public IntegerProperty	documentSplitterChunkSizeProperty()
public ObjectProperty<DocumentSplitterKind>	documentSplitterKindProperty()
public IntegerProperty	documentSplitterOverlapSizeProperty()
public StringProperty	embeddingModelProperty()
public IntegerProperty	followUpQuestionsCountProperty()
public StringProperty	followUpQuestionsTemplateProperty()
public StringProperty	geminiApiBaseUrlProperty()
public StringProperty	geminiChatModelProperty()
public BooleanProperty	generateFollowUpQuestionsProperty()
public boolean	getAiFeaturesEnabled()
public boolean	getAiFeaturesEnabledCurrently()
public AiProvider	getAiProvider()
private List<Property<?>>	getApiBaseUrlsProperties()
public String	getApiKeyForAiProvider(AiProvider aiProvider)
public boolean	getAutoGenerateEmbeddings()
public boolean	getAutoGenerateSummaries()
private List<Property<?>>	getChatModelNamesProperties()
public List<Property<?>>	getChatProperties()
public String	getChattingSystemMessageTemplate()
public String	getChattingUserMessageTemplate()
public String	getCitationParsingSystemMessageTemplate()
public int	getContextWindowSize()
public boolean	getCustomizeExpertSettings()
public static AiPreferences	getDefault()
public int	getDocumentSplitterChunkSize()
public DocumentSplitterKind	getDocumentSplitterKind()
public int	getDocumentSplitterOverlapSize()
public List<? extends Property<?>>	getDocumentSplitterProperties()
public String	getEmbeddingModel()
public List<Property<?>>	getEmbeddingsProperties()
public int	getFollowUpQuestionsCount()
public String	getFollowUpQuestionsTemplate()
public String	getGeminiApiBaseUrl()
public String	getGeminiChatModel()
public boolean	getGenerateFollowUpQuestions()
public String	getHuggingFaceApiBaseUrl()
public String	getHuggingFaceChatModel()
public String	getMarkdownChatExportTemplate()
public String	getMistralAiApiBaseUrl()
public String	getMistralAiChatModel()
public String	getOpenAiApiBaseUrl()
public String	getOpenAiChatModel()
public int	getRagMaxResultsCount()
public double	getRagMinScore()
public ResponseEngineKind	getResponseEngineKind()
public List<? extends Property<?>>	getResponseEngineProperties()
public String	getSelectedApiBaseUrl()
public String	getSelectedChatModel()
public String	getSummarizationChunkSystemMessageTemplate()
public String	getSummarizationCombineSystemMessageTemplate()
public String	getSummarizationFullDocumentSystemMessageTemplate()
public SummarizatorKind	getSummarizatorKind()
public List<? extends Property<?>>	getSummarizatorProperties()
public double	getTemperature()
public TokenEstimatorKind	getTokenEstimatorKind()
public StringProperty	huggingFaceApiBaseUrlProperty()
public StringProperty	huggingFaceChatModelProperty()
public StringProperty	markdownChatExportTemplateProperty()
public StringProperty	mistralAiApiBaseUrlProperty()
public StringProperty	mistralAiChatModelProperty()
public StringProperty	openAiApiBaseUrlProperty()
public StringProperty	openAiChatModelProperty()
public IntegerProperty	ragMaxResultsCountProperty()
public DoubleProperty	ragMinScoreProperty()
public ObjectProperty<ResponseEngineKind>	responseEngineKindProperty()
public BooleanBinding	restartNeededBinding()
public void	setAiFeaturesEnabledCurrently(boolean aiFeaturesEnabledCurrently)
public void	setAiProvider(AiProvider aiProvider)
public void	setAutoGenerateEmbeddings(boolean autoGenerateEmbeddings)
public void	setAutoGenerateSummaries(boolean autoGenerateSummaries)
public void	setChattingSystemMessageTemplate(String template)
public void	setChattingUserMessageTemplate(String template)
public void	setCitationParsingSystemMessageTemplate(String template)
public void	setContextWindowSize(int contextWindowSize)
public void	setCustomizeExpertSettings(boolean customizeExpertSettings)
public void	setDocumentSplitterChunkSize(int documentSplitterChunkSize)
public void	setDocumentSplitterKind(DocumentSplitterKind documentSplitterKind)
public void	setDocumentSplitterOverlapSize(int documentSplitterOverlapSize)
public void	setEmbeddingModel(String embeddingModel)
public void	setFollowUpQuestionsCount(int followUpQuestionsCount)
public void	setFollowUpQuestionsTemplate(String followUpQuestionsTemplate)
public void	setGeminiApiBaseUrl(String geminiApiBaseUrl)
public void	setGeminiChatModel(String geminiChatModel)
public void	setGenerateFollowUpQuestions(boolean generateFollowUpQuestions)
public void	setHuggingFaceApiBaseUrl(String huggingFaceApiBaseUrl)
public void	setHuggingFaceChatModel(String huggingFaceChatModel)
public void	setMarkdownChatExportTemplate(String template)
public void	setMistralAiApiBaseUrl(String mistralAiApiBaseUrl)
public void	setMistralAiChatModel(String mistralAiChatModel)
public void	setOpenAiApiBaseUrl(String openAiApiBaseUrl)
public void	setOpenAiChatModel(String openAiChatModel)
public void	setRagMaxResultsCount(int ragMaxResultsCount)
public void	setRagMinScore(double ragMinScore)
public void	setResponseEngineKind(ResponseEngineKind responseEngineKind)
public void	setSummarizationChunkSystemMessageTemplate(String template)
public void	setSummarizationCombineSystemMessageTemplate(String template)
public void	setSummarizationFullDocumentSystemMessageTemplate(String template)
public void	setSummarizatorKind(SummarizatorKind summarizatorKind)
public void	setTemperature(double temperature)
public void	setTokenEstimatorKind(TokenEstimatorKind tokenEstimatorKind)
public void	storeAiApiKeyInKeyring(AiProvider aiProvider, String newKey)
public StringProperty	summarizationChunkSystemMessageTemplateProperty()
public StringProperty	summarizationCombineSystemMessageTemplateProperty()
public StringProperty	summarizationFullDocumentSystemMessageTemplateProperty()
public ObjectProperty<SummarizatorKind>	summarizatorKindProperty()
public DoubleProperty	temperatureProperty()
public ObjectProperty<TokenEstimatorKind>	tokenEstimatorKindProperty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class AiPreferences

Field Summary

Constructor Summary

Method Summary