mirror of
https://github.com/run-llama/llama-hub.git
synced 2025-08-14 19:51:25 +00:00
28 lines
1.0 KiB
Markdown
28 lines
1.0 KiB
Markdown
|
# Elasticsearch Loader
|
||
|
|
|
||
|
|
The Elasticsearch Loader returns a set of texts corresponding to documents retrieved from an Elasticsearch index.
|
||
|
|
The user initializes the loader with an Elasticsearch index. They then pass in a field, and optionally a JSON query DSL object to fetch the fields they want.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Here's an example usage of the ElasticsearchReader.
|
||
|
|
|
||
|
|
```python
|
||
|
|
from llama_index import download_loader
|
||
|
|
|
||
|
|
ElasticsearchReader = download_loader("ElasticsearchReader")
|
||
|
|
|
||
|
|
reader = ElasticsearchReader(
|
||
|
|
"http://localhost:9200",
|
||
|
|
index_name,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
query_dict = {"query": {"match": {"message": {"query": "this is a test"}}}}
|
||
|
|
documents = reader.load_data(
|
||
|
|
"<field_name>", query=query_dict, embedding_field="field_name"
|
||
|
|
)
|
||
|
|
```
|
||
|
|
|
||
|
|
This loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/jerryjliu/gpt_index/tree/main/gpt_index) and/or subsequently used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.
|