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

Class RetrieverFilesystemAutoConfiguration

java.lang.Object

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

@AutoConfiguration
@EnableConfigurationProperties(RetrieverFilesystemProperties.class)
public class RetrieverFilesystemAutoConfiguration
extends Object

Autoconfiguration class for setting up the FilesystemRetriever bean with the necessary properties and dependencies. The configuration is based on properties defined in the external configuration files

The configuration is based on properties defined in the external configuration files (e.g., application.properties or application.yml) under RetrieverFilesystemProperties.CONFIG_PREFIX, MilvusVectorStoreProperties.CONFIG_PREFIX and OpenAiConnectionProperties.CONFIG_PREFIX namespaces.

Since:

1.0.0

See Also:

• FilesystemRetriever
• RetrieverFilesystemProperties
• MilvusVectorStoreProperties
• MilvusServiceClientProperties
• OpenAiConnectionProperties
• OpenAiEmbeddingProperties

Constructor Summary

Constructors

Constructor	Description
RetrieverFilesystemAutoConfiguration()	Default constructor for RetrieverFilesystemAutoConfiguration.

Method Summary

Modifier and Type	Method	Description
ai.yda.framework.rag.retriever.filesystem.FilesystemRetriever	filesystemRetriever(RetrieverFilesystemProperties filesystemProperties, org.springframework.ai.autoconfigure.vectorstore.milvus.MilvusVectorStoreProperties milvusProperties, org.springframework.ai.autoconfigure.vectorstore.milvus.MilvusServiceClientProperties milvusClientProperties, org.springframework.ai.autoconfigure.openai.OpenAiConnectionProperties openAiConnectionProperties, org.springframework.ai.autoconfigure.openai.OpenAiEmbeddingProperties openAiEmbeddingProperties)	Creates and configures an instance of FilesystemRetriever using the provided properties and services.

Methods inherited from class java.lang.Object

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

Constructor Details

RetrieverFilesystemAutoConfiguration

public RetrieverFilesystemAutoConfiguration()

Default constructor for RetrieverFilesystemAutoConfiguration.

Method Details

filesystemRetriever

@Bean
public ai.yda.framework.rag.retriever.filesystem.FilesystemRetriever filesystemRetriever(RetrieverFilesystemProperties filesystemProperties,
 org.springframework.ai.autoconfigure.vectorstore.milvus.MilvusVectorStoreProperties milvusProperties,
 org.springframework.ai.autoconfigure.vectorstore.milvus.MilvusServiceClientProperties milvusClientProperties,
 org.springframework.ai.autoconfigure.openai.OpenAiConnectionProperties openAiConnectionProperties,
 org.springframework.ai.autoconfigure.openai.OpenAiEmbeddingProperties openAiEmbeddingProperties)
                                                                                  throws Exception

Creates and configures an instance of FilesystemRetriever using the provided properties and services.

This method performs the following steps:

• Creates a MilvusVectorStore instance using the provided properties and services.
• Initializes the MilvusVectorStore instance by calling afterPropertiesSet().
• Creates and returns a FilesystemRetriever instance with the initialized parameters

Parameters:

filesystemProperties - properties for configuring the FilesystemRetriever, including collectionName, topK, isProcessingEnabled, clearCollectionOnStartup and fileStoragePath settings.

milvusProperties - properties for configuring the Milvus Vector Store.

milvusClientProperties - properties for configuring the Milvus Service Client.

openAiConnectionProperties - properties for configuring the OpenAI connection.

openAiEmbeddingProperties - properties for configuring the OpenAI Embeddings.

Returns:

a fully configured FilesystemRetriever instance.

Throws:

Exception - if an error occurs during initialization.