Skip to main content
Elasticsearch is a distributed, RESTful search and analytics engine. It provides a distributed, multi-tenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents.

Installation and setup

Setup Elasticsearch

There are two ways to get started with Elasticsearch:

Install Elasticsearch on your local machine

The easiest way to run Elasticsearch locally for development and testing is using the start-local script. This script sets up Elasticsearch using Docker with a simple one-line command.
This creates an elastic-start-local folder. To start Elasticsearch:
Elasticsearch will be available at http://localhost:9200. The password for the elastic user and API key are automatically generated and stored in the .env file in the elastic-start-local folder. If you only need Elasticsearch without Kibana, you can use the --esonly option:
The start-local setup is for local testing only and should not be used in production. For production installations, refer to the official Elasticsearch documentation.

Deploy Elasticsearch on elastic cloud

Elastic Cloud is a managed Elasticsearch service. Signup for a free trial.

Install client

Embedding models

See a usage example.

Vector store

See a usage example.

Retrievers

ElasticsearchRetriever

The ElasticsearchRetriever enables flexible access to all Elasticsearch features through the Query DSL. See a usage example.

LLM cache

Byte store

See a usage example.

Chain

It is a chain for interacting with Elasticsearch Database.