JabRef 6.0-beta.1 · org.jabref.gui.preferences.ai.AiTabViewModel

Modifier and Type	Class and Description
public static enum	AiTabViewModel.ConnectionTestState

Modifier and Type

Class and Description

public static enum

AiTabViewModel.ConnectionTestState

Modifier and Type	Field and Description
private final AiModelService	aiModelService
private final AiPreferences	aiPreferences The live application preferences; only read in `setValues()` and written in `storeSettings()`.
private final ListProperty<AiProvider>	aiProvidersList
private final de.saxsys.mvvmfx.utils.validation.Validator	apiBaseUrlValidator
private final de.saxsys.mvvmfx.utils.validation.Validator	apiKeyValidator
private final BooleanProperty	autoGenerateEmbeddings
private final BooleanProperty	autoGenerateSummaries
private final ListProperty<String>	chatModelsList
private final de.saxsys.mvvmfx.utils.validation.Validator	chatModelValidator
private final StringProperty	chattingSystemMessageTemplate
private final StringProperty	chattingUserMessageTemplate
private final StringProperty	citationParsingSystemMessageTemplate
private final StringProperty	connectionTestDetails Details of the last failed connection test; empty otherwise.
private final ObjectProperty<AiTabViewModel.ConnectionTestState>	connectionTestState
private final IntegerProperty	contextWindowSize
private final de.saxsys.mvvmfx.utils.validation.Validator	contextWindowSizeValidator
private final StringProperty	currentApiBaseUrl
private final StringProperty	currentApiKey
private final StringProperty	currentChatModel
private final BooleanProperty	customizeExpertSettings
public static final int	DEFAULT_MAX_CHUNK_SIZE
private final BooleanProperty	disableApiBaseUrl
private final BooleanProperty	disableAutoGenerateEmbeddings
private final BooleanProperty	disableAutoGenerateSummaries
private final BooleanProperty	disableBasicSettings
private final BooleanProperty	disableExpertSettings
private final IntegerProperty	documentSplitterChunkSize
private final de.saxsys.mvvmfx.utils.validation.Validator	documentSplitterChunkSizeValidator
private final IntegerProperty	documentSplitterOverlapSize
private final de.saxsys.mvvmfx.utils.validation.Validator	documentSplitterOverlapSizeValidator
private final EmbeddingModelMetadataService	embeddingModelMetadataService
private final ListProperty<String>	embeddingModelsList
private final de.saxsys.mvvmfx.utils.validation.Validator	embeddingModelValidator
private final BooleanProperty	enableAi
private final IntegerProperty	followUpQuestionsCount
protected static SpinnerValueFactory<Integer>	followUpQuestionsCountValueFactory
private final StringProperty	followUpQuestionsTemplate
private final StringProperty	geminiAiApiKey
private final StringProperty	geminiApiBaseUrl
private final StringProperty	geminiChatModel
private final BooleanProperty	generateFollowUpQuestions
private final StringProperty	huggingFaceApiBaseUrl
private final StringProperty	huggingFaceApiKey
private final StringProperty	huggingFaceChatModel
private static final Logger	LOGGER
private final StringProperty	markdownChatExportTemplate
private final StringProperty	mistralAiApiBaseUrl
private final StringProperty	mistralAiApiKey
private final StringProperty	mistralAiChatModel
private final Locale	oldLocale
private final StringProperty	openAiApiBaseUrl
private final StringProperty	openAiApiKey
private final StringProperty	openAiChatModel
private final IntegerProperty	ragMaxResultsCount
private final de.saxsys.mvvmfx.utils.validation.Validator	ragMaxResultsCountValidator
private final StringProperty	ragMinScore
private final de.saxsys.mvvmfx.utils.validation.Validator	ragMinScoreRangeValidator
private final de.saxsys.mvvmfx.utils.validation.Validator	ragMinScoreTypeValidator
private final ObjectProperty<ResponseEngineKind>	responseEngineProperty
private final ListProperty<ResponseEngineKind>	responseEnginesList
private final List<String>	restartWarnings
private final ObjectProperty<AiProvider>	selectedAiProvider
private final StringProperty	selectedEmbeddingModel
private final IntegerProperty	selectedEmbeddingModelMaxChunkSize
private final StringProperty	selectedEmbeddingModelSize
private final ObjectProperty<SummarizatorKind>	summarizationAlgorithmProperty
private final ListProperty<SummarizatorKind>	summarizationAlgorithmsList
private final StringProperty	summarizationChunkSystemMessageTemplate
private final StringProperty	summarizationCombineSystemMessageTemplate
private final StringProperty	summarizationFullDocumentSystemMessageTemplate
private final TaskExecutor	taskExecutor
private final StringProperty	temperature
private final de.saxsys.mvvmfx.utils.validation.Validator	temperatureRangeValidator
private final de.saxsys.mvvmfx.utils.validation.Validator	temperatureTypeValidator
private final ObjectProperty<TokenEstimatorKind>	tokenEstimationAlgorithmProperty
private final ListProperty<TokenEstimatorKind>	tokenEstimationAlgorithmsProperty
private final AiPreferences	workingAiPreferences The dialog-scoped working copy shared with other tabs (see `PreferencesDialogViewModel`).

Modifier and Type

Field and Description

private final AiModelService

aiModelService

private final AiPreferences

aiPreferences

The live application preferences; only read in setValues() and written in storeSettings().

private final ListProperty<AiProvider>

aiProvidersList

private final de.saxsys.mvvmfx.utils.validation.Validator

apiBaseUrlValidator

private final de.saxsys.mvvmfx.utils.validation.Validator

apiKeyValidator

private final BooleanProperty

autoGenerateEmbeddings

private final BooleanProperty

autoGenerateSummaries

private final ListProperty<String>

chatModelsList

private final de.saxsys.mvvmfx.utils.validation.Validator

chatModelValidator

private final StringProperty

chattingSystemMessageTemplate

private final StringProperty

chattingUserMessageTemplate

private final StringProperty

citationParsingSystemMessageTemplate

private final StringProperty

connectionTestDetails

Details of the last failed connection test; empty otherwise.

private final ObjectProperty<AiTabViewModel.ConnectionTestState>

connectionTestState

private final IntegerProperty

contextWindowSize

private final de.saxsys.mvvmfx.utils.validation.Validator

contextWindowSizeValidator

private final StringProperty

currentApiBaseUrl

private final StringProperty

currentApiKey

private final StringProperty

currentChatModel

private final BooleanProperty

customizeExpertSettings

public static final int

DEFAULT_MAX_CHUNK_SIZE

private final BooleanProperty

disableApiBaseUrl

private final BooleanProperty

disableAutoGenerateEmbeddings

private final BooleanProperty

disableAutoGenerateSummaries

private final BooleanProperty

disableBasicSettings

private final BooleanProperty

disableExpertSettings

private final IntegerProperty

documentSplitterChunkSize

private final de.saxsys.mvvmfx.utils.validation.Validator

documentSplitterChunkSizeValidator

private final IntegerProperty

documentSplitterOverlapSize

private final de.saxsys.mvvmfx.utils.validation.Validator

documentSplitterOverlapSizeValidator

private final EmbeddingModelMetadataService

embeddingModelMetadataService

private final ListProperty<String>

embeddingModelsList

private final de.saxsys.mvvmfx.utils.validation.Validator

embeddingModelValidator

private final BooleanProperty

enableAi

private final IntegerProperty

followUpQuestionsCount

protected static SpinnerValueFactory<Integer>

followUpQuestionsCountValueFactory

private final StringProperty

followUpQuestionsTemplate

private final StringProperty

geminiAiApiKey

private final StringProperty

geminiApiBaseUrl

private final StringProperty

geminiChatModel

private final BooleanProperty

generateFollowUpQuestions

private final StringProperty

huggingFaceApiBaseUrl

private final StringProperty

huggingFaceApiKey

private final StringProperty

huggingFaceChatModel

private static final Logger

LOGGER

private final StringProperty

markdownChatExportTemplate

private final StringProperty

mistralAiApiBaseUrl

private final StringProperty

mistralAiApiKey

private final StringProperty

mistralAiChatModel

private final Locale

oldLocale

private final StringProperty

openAiApiBaseUrl

private final StringProperty

openAiApiKey

private final StringProperty

openAiChatModel

private final IntegerProperty

ragMaxResultsCount

private final de.saxsys.mvvmfx.utils.validation.Validator

ragMaxResultsCountValidator

private final StringProperty

ragMinScore

private final de.saxsys.mvvmfx.utils.validation.Validator

ragMinScoreRangeValidator

private final de.saxsys.mvvmfx.utils.validation.Validator

ragMinScoreTypeValidator

private final ObjectProperty<ResponseEngineKind>

responseEngineProperty

private final ListProperty<ResponseEngineKind>

responseEnginesList

private final List<String>

restartWarnings

private final ObjectProperty<AiProvider>

selectedAiProvider

private final StringProperty

selectedEmbeddingModel

private final IntegerProperty

selectedEmbeddingModelMaxChunkSize

private final StringProperty

selectedEmbeddingModelSize

private final ObjectProperty<SummarizatorKind>

summarizationAlgorithmProperty

private final ListProperty<SummarizatorKind>

summarizationAlgorithmsList

private final StringProperty

summarizationChunkSystemMessageTemplate

private final StringProperty

summarizationCombineSystemMessageTemplate

private final StringProperty

summarizationFullDocumentSystemMessageTemplate

private final TaskExecutor

taskExecutor

private final StringProperty

temperature

private final de.saxsys.mvvmfx.utils.validation.Validator

temperatureRangeValidator

private final de.saxsys.mvvmfx.utils.validation.Validator

temperatureTypeValidator

private final ObjectProperty<TokenEstimatorKind>

tokenEstimationAlgorithmProperty

private final ListProperty<TokenEstimatorKind>

tokenEstimationAlgorithmsProperty

private final AiPreferences

workingAiPreferences

The dialog-scoped working copy shared with other tabs (see PreferencesDialogViewModel).

Access	Constructor and Description
public	AiTabViewModel(AiPreferences aiPreferences, AiPreferences workingAiPreferences, AiModelService aiModelService, TaskExecutor taskExecutor, EmbeddingModelMetadataService embeddingModelMetadataService)

Access

Constructor and Description

public

AiTabViewModel(AiPreferences aiPreferences, AiPreferences workingAiPreferences, AiModelService aiModelService, TaskExecutor taskExecutor, EmbeddingModelMetadataService embeddingModelMetadataService)

Method Summary

Modifier and Type	Method and Description
public ReadOnlyListProperty<AiProvider>	aiProvidersProperty()
public StringProperty	apiBaseUrlProperty()
public StringProperty	apiKeyProperty()
public BooleanProperty	autoGenerateEmbeddings()
public BooleanProperty	autoGenerateSummaries()
public ReadOnlyListProperty<String>	chatModelsProperty()
public StringProperty	chattingSystemMessageTemplateProperty()
public StringProperty	chattingUserMessageTemplateProperty()
public StringProperty	citationParsingSystemMessageTemplateProperty()
public ReadOnlyStringProperty	connectionTestDetailsProperty()
public ReadOnlyObjectProperty<AiTabViewModel.ConnectionTestState>	connectionTestStateProperty()
public IntegerProperty	contextWindowSizeProperty()
public BooleanProperty	customizeExpertSettingsProperty()
public BooleanProperty	disableApiBaseUrlProperty()
public BooleanProperty	disableAutoGenerateEmbeddings()
public BooleanProperty	disableAutoGenerateSummaries()
public BooleanProperty	disableBasicSettingsProperty()
public BooleanProperty	disableExpertSettingsProperty()
public IntegerProperty	documentSplitterChunkSizeProperty()
public IntegerProperty	documentSplitterOverlapSizeProperty()
public ReadOnlyListProperty<String>	embeddingModelsProperty()
public BooleanProperty	enableAi()
public IntegerProperty	followUpQuestionsCountProperty()
public StringProperty	followUpQuestionsTemplateProperty()
public BooleanProperty	generateFollowUpQuestionsProperty()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getApiBaseUrlValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getApiTokenValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getChatModelValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getDocumentSplitterChunkSizeValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getDocumentSplitterOverlapSizeValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getEmbeddingModelValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getMessageWindowSizeValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getRagMaxResultsCountValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getRagMinScoreRangeValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getRagMinScoreTypeValidationStatus()
public List<String>	getRestartWarnings() Overrides default org.jabref.gui.preferences.PreferenceTabViewModel.getRestartWarnings. This method should be called after storing the preferences, to collect the properties, which require a restart of JabRef to load
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getTemperatureRangeValidationStatus()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	getTemperatureTypeValidationStatus()
public StringProperty	markdownChatExportTemplateProperty()
public IntegerProperty	ragMaxResultsCountProperty()
public StringProperty	ragMinScoreProperty()
public void	resetChattingSystemMessageTemplate()
public void	resetChattingUserMessageTemplate()
public void	resetCitationParsingSystemMessageTemplate()
public void	resetExpertSettings()
public void	resetFollowUpQuestionsTemplate()
public void	resetMarkdownChatExportTemplate()
public void	resetSummarizationChunkSystemMessageTemplate()
public void	resetSummarizationCombineSystemMessageTemplate()
public void	resetSummarizationFullDocumentSystemMessageTemplate()
public void	resetTemplates()
public ListProperty<ResponseEngineKind>	responseEngineKindsProperty()
public ObjectProperty<ResponseEngineKind>	responseEngineProperty()
public ObjectProperty<AiProvider>	selectedAiProviderProperty()
public StringProperty	selectedChatModelProperty()
public IntegerProperty	selectedEmbeddingModelMaxChunkSizeProperty()
public StringProperty	selectedEmbeddingModelProperty()
public StringProperty	selectedEmbeddingModelSizeProperty()
public void	setValues() Implements org.jabref.gui.preferences.PreferenceTabViewModel.setValues. This method is called when the dialog is opened, or if it is made visible after being hidden.
public void	storeSettings() Implements org.jabref.gui.preferences.PreferenceTabViewModel.storeSettings. This method is called when the user presses OK in the Preferences dialog.
public ObjectProperty<SummarizatorKind>	summarizationAlgorithmProperty()
public ListProperty<SummarizatorKind>	summarizationAlgorithmsProperty()
public StringProperty	summarizationChunkSystemMessageTemplateProperty()
public StringProperty	summarizationCombineSystemMessageTemplateProperty()
public StringProperty	summarizationFullDocumentSystemMessageTemplateProperty()
public StringProperty	temperatureProperty()
public void	testConnection()
public org.jabref.logic.util.BackgroundTask<String>	testConnectionTask() Tests the connection with the values currently entered in the dialog, not the stored preferences.
public ObjectProperty<TokenEstimatorKind>	tokenEstimationAlgorithmProperty()
public ListProperty<TokenEstimatorKind>	tokenEstimationAlgorithmsProperty()
private void	updateSelectedEmbeddingModelMetadata(@Nullable String modelName)
public boolean	validateBasicSettings()
public boolean	validateExpertSettings()
public boolean	validateSettings() Overrides default org.jabref.gui.preferences.PreferenceTabViewModel.validateSettings. This method is called before the `storeSettings()` method, to check if there are illegal settings in the tab, or if is ready to be closed.

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

public Class AiTabViewModel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary