ElasticSearch Search

author: Jael

Description

The search operator runs a search via ElasticSearch client given a query. It takes a dictionary as input, which should be written in Query DSL. To use this operator, you need to set up ElasticSearch in advance.

Code Example

With an example ElasticSearch client 'localhost:9200', search across the index 'test_index' using an example query {'match_all': {}} to get all documents.

from towhee import pipe, ops, DataCollection


query = {'match_all': {}}
es_search = (
    pipe.input('index_name', 'query')
        .map(('index_name', 'query'), 'res', ops.elasticsearch.search_client(
            host='localhost', port=9200
        ))
        .output('query', 'res')
)

res = es_search('test_index', query)
DataCollection(res).show() # Optional: display output data

Factory Constructor

Create the operator via the following factory method:

elasticsearch.search(host='localhost', port=9200, user=None, password=None, ca_certs=None)

Parameters:

host: str

The host to connect ElasticSearch client.

port: int

The port to connect ElasticSearch client.

user: str

The username to connect ElasticSearch client if needed, defaults to None.

password: str

The user password to connect ElasticSearch client if needed, defaults to None.

ca_certs: str

The path to CA certificates to connect ElasticSearch client if needed, defaults to None.

Returns:

Search results wrapped by elastic_transport.ObjectApiResponse.