• Python 3.8 or newer
• pip, installed by default alongside Python

To install the latest version of the client, run the following command:

python -m pip install elasticsearch

Refer to theInstallation page to learn more.

You can connect to the Elastic Cloud using an API key and the Elasticsearch endpoint.

from elasticsearch import Elasticsearchclient = Elasticsearch(    "https://...",    api_key="api_key",)

1. Elasticsearch endpoint

Your Elasticsearch endpoint can be found on theMy deployment page of your deployment:

You can generate an API key on theManagement page under Security.

For other connection options, refer to theConnecting section.

Time to use Elasticsearch! This section walks you through the basic, and most important, operations of Elasticsearch. For more operations and more advanced examples, refer to theExamples page.

This is how you create themy_index index:

client.indices.create(index="my_index")

Optionally, you can first define the expected types of your features with a custom mapping.

mappings = {    "properties": {        "foo": {"type": "text"},        "bar": {            "type": "text",            "fields": {                "keyword": {                    "type": "keyword",                    "ignore_above": 256,                }            },        },    }}client.indices.create(index="my_index", mappings=mappings)

This indexes a document with the index API:

client.index(    index="my_index",    id="my_document_id",    document={        "foo": "foo",        "bar": "bar",    })

You can also index multiple documents at once with the bulk helper function:

from elasticsearch import helpersdef generate_docs():    for i in range(10):        yield {            "_index": "my_index",            "foo": f"foo {i}",            "bar": "bar",        }helpers.bulk(client, generate_docs())

These helpers are the recommended way to perform bulk ingestion. While it is also possible to perform bulk ingestion usingclient.bulk directly, the helpers handle retries, ingesting chunk by chunk and more. See theClient helpers page for more details.

You can get documents by using the following code:

client.get(index="my_index", id="my_document_id")

This is how you can create a single match query with the Python client:

client.search(index="my_index", query={    "match": {        "foo": "foo"    }})

This is how you can update a document, for example to add a new field:

client.update(    index="my_index",    id="my_document_id",    doc={        "foo": "bar",        "new_field": "new value",    })

client.delete(index="my_index", id="my_document_id")

client.indices.delete(index="my_index")

• UseClient helpers for a more comfortable experience with the APIs.