Package com.github.hakenadu.javalangchains.chains.retrieval.lucene

Class LuceneRetrievalChain

java.lang.Object
com.github.hakenadu.javalangchains.chains.retrieval.RetrievalChain
com.github.hakenadu.javalangchains.chains.retrieval.lucene.LuceneRetrievalChain
All Implemented Interfaces:
Chain<String,​Stream<Map<String,​String>>>, Closeable, AutoCloseable
public class LuceneRetrievalChain
extends RetrievalChain
implements Closeable
This RetrievalChain retrieves documents from a lucene index

  • Constructor Details

    • LuceneRetrievalChain

      public LuceneRetrievalChain​(org.apache.lucene.store.Directory indexDirectory, int maxDocumentCount, Function<String,​org.apache.lucene.search.Query> queryCreator, Function<org.apache.lucene.document.Document,​Map<String,​String>> documentCreator)
      Creates an instance of LuceneRetrievalChain
      Parameters:
      indexDirectory - Lucene Index Directory
      maxDocumentCount - maximal count of retrieved documents
      queryCreator - this Function accepts the user's question and provides the Query which is executed against the Lucene Directory
      documentCreator - this Function accepts a lucene Document and provides a Map of key value pairs for subsequent chains

    • LuceneRetrievalChain

      public LuceneRetrievalChain​(org.apache.lucene.store.Directory indexDirectory, int maxDocumentCount, Function<String,​org.apache.lucene.search.Query> queryCreator)
      Creates an instance of LuceneRetrievalChain. Uses createDocument(Document) to map all lucene document fields into the output Map.
      Parameters:
      indexDirectory - Lucene Index Directory
      maxDocumentCount - maximal count of retrieved documents
      queryCreator - this Function accepts the user's question and provides the Query which is executed against the Lucene Directory

    • LuceneRetrievalChain

      public LuceneRetrievalChain​(org.apache.lucene.store.Directory indexDirectory, int maxDocumentCount)
      Creates an instance of LuceneRetrievalChain. Uses createQuery(String) to provide a default Query using a StandardAnalyzer targeting the field PromptConstants.CONTENT.. Uses createDocument(Document) to map all lucene document fields into the output Map.
      Parameters:
      indexDirectory - Lucene Index Directory
      maxDocumentCount - maximal count of retrieved documents

    • LuceneRetrievalChain

      public LuceneRetrievalChain​(org.apache.lucene.store.Directory indexDirectory)
      Creates an instance of LuceneRetrievalChain with a maximum of 4 retrieved documents. Uses createQuery(String) to provide a default Query using a StandardAnalyzer targeting the field PromptConstants.CONTENT.. Uses createDocument(Document) to map all lucene document fields into the output Map.
      Parameters:
      indexDirectory - Lucene Index Directory

  • Method Details