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

Class ElasticsearchRetrievalChain

java.lang.Object

com.github.hakenadu.javalangchains.chains.data.retrieval.RetrievalChain

com.github.hakenadu.javalangchains.chains.data.retrieval.ElasticsearchRetrievalChain

All Implemented Interfaces:

Chain<String,Stream<Map<String,String>>>, Closeable, AutoCloseable

public class ElasticsearchRetrievalChain
extends RetrievalChain
implements Closeable

This RetrievalChain retrieves documents from an elasticsearch index

Constructor Summary

Constructors

Constructor	Description
ElasticsearchRetrievalChain(String index)	Creates an instance of ElasticsearchRetrievalChain
ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient)	Creates an instance of ElasticsearchRetrievalChain
ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient, int maxDocumentCount)	Creates an instance of ElasticsearchRetrievalChain
ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient, int maxDocumentCount, com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Creates an instance of ElasticsearchRetrievalChain
ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient, int maxDocumentCount, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Function<String,com.fasterxml.jackson.databind.node.ObjectNode> queryCreator)	Creates an instance of ElasticsearchRetrievalChain
ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient, int maxDocumentCount, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Function<String,com.fasterxml.jackson.databind.node.ObjectNode> queryCreator, BiFunction<com.fasterxml.jackson.databind.node.ObjectNode,String,Map<String,String>> documentCreator)	Creates an instance of ElasticsearchRetrievalChain

Method Summary

Modifier and Type	Method	Description
void	close()
static BiFunction<com.fasterxml.jackson.databind.node.ObjectNode,String,Map<String,String>>	defaultDocumentCreator(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	creates the default queryCreator
Stream<Map<String,String>>	run(String input)	Execute this Chain

Methods inherited from class com.github.hakenadu.javalangchains.chains.data.retrieval.RetrievalChain

getMaxDocumentCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.hakenadu.javalangchains.chains.Chain

chain

Constructor Details

ElasticsearchRetrievalChain

public ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient, int maxDocumentCount, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Function<String,com.fasterxml.jackson.databind.node.ObjectNode> queryCreator, BiFunction<com.fasterxml.jackson.databind.node.ObjectNode,String,Map<String,String>> documentCreator)

Creates an instance of ElasticsearchRetrievalChain

Parameters:

index - index

restClient - restClient

maxDocumentCount - RetrievalChain.getMaxDocumentCount()

objectMapper - objectMapper

queryCreator - queryCreator

documentCreator - documentCreator

ElasticsearchRetrievalChain

public ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient, int maxDocumentCount, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Function<String,com.fasterxml.jackson.databind.node.ObjectNode> queryCreator)

Creates an instance of ElasticsearchRetrievalChain

Parameters:

index - index

restClient - restClient

maxDocumentCount - RetrievalChain.getMaxDocumentCount()

objectMapper - objectMapper

queryCreator - queryCreator

ElasticsearchRetrievalChain

public ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient, int maxDocumentCount, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Creates an instance of ElasticsearchRetrievalChain

Parameters:

index - index

restClient - restClient

maxDocumentCount - RetrievalChain.getMaxDocumentCount()

objectMapper - objectMapper

ElasticsearchRetrievalChain

public ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient, int maxDocumentCount)

Creates an instance of ElasticsearchRetrievalChain

Parameters:

index - index

restClient - restClient

maxDocumentCount - RetrievalChain.getMaxDocumentCount()

ElasticsearchRetrievalChain

public ElasticsearchRetrievalChain(String index, org.elasticsearch.client.RestClient restClient)

Creates an instance of ElasticsearchRetrievalChain

Parameters:

index - index

restClient - restClient

ElasticsearchRetrievalChain

public ElasticsearchRetrievalChain(String index)

Creates an instance of ElasticsearchRetrievalChain

Parameters:

index - index

Method Details

run

public Stream<Map<String,String>> run(String input)

Description copied from interface: Chain

Execute this Chain

Specified by:

run in interface Chain<String,Stream<Map<String,String>>>

Parameters:

input - this chain's input

Returns:

this chain's output

close

public void close() throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

defaultDocumentCreator

public static BiFunction<com.fasterxml.jackson.databind.node.ObjectNode,String,Map<String,String>> defaultDocumentCreator(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

creates the default queryCreator

Parameters:

objectMapper - the ObjectMapper used for json operations

Returns:

BiFunction which consumes a hit node and the question and produces a document consisting of all (key, value)-pairs of the hit's _source object