Package ai.yda.framework.rag.retriever.filesystem.autoconfigure

Class RetrieverFilesystemProperties

java.lang.Object

ai.yda.framework.rag.retriever.shared.RetrieverProperties

ai.yda.framework.rag.retriever.filesystem.autoconfigure.RetrieverFilesystemProperties

@ConfigurationProperties("ai.yda.framework.rag.retriever.filesystem")
public class RetrieverFilesystemProperties
extends ai.yda.framework.rag.retriever.shared.RetrieverProperties

Provides configuration properties for filesystem Retriever. These properties can be customized through the application’s external configuration, such as a properties file, YAML file, or environment variables. The properties include collectionName, topK, isProcessingEnabled, clearCollectionOnStartup and fileStoragePath settings.

The properties are prefixed with CONFIG_PREFIX and can be customized by defining values under this prefix in the external configuration.

 Example configuration in a YAML file:
 ai:
    yda:
      framework:
         rag:
            retriever:
                filesystem:
                    collectionName: your-collection-name
                    topK: your-top-k
                    isProcessingEnabled: true/false
                    clearCollectionOnStartup: true/false
                    fileStoragePath: your-file-storage-path
 

Since:

0.1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PREFIX	The configuration prefix used to reference properties related to the filesystem Retriever in application configurations.

Constructor Summary

Constructors

Constructor	Description
RetrieverFilesystemProperties()	Default constructor for RetrieverFilesystemProperties.

Method Summary

Methods inherited from class ai.yda.framework.rag.retriever.shared.RetrieverProperties

getClearCollectionOnStartup, getCollectionName, getIsProcessingEnabled, getTopK, setClearCollectionOnStartup, setCollectionName, setIsProcessingEnabled, setTopK

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONFIG_PREFIX

public static final String CONFIG_PREFIX

The configuration prefix used to reference properties related to the filesystem Retriever in application configurations. This prefix is used for binding properties within the particular namespace.

See Also:

• Constant Field Values

Constructor Details

RetrieverFilesystemProperties

public RetrieverFilesystemProperties()

Default constructor for RetrieverFilesystemProperties.