ElasticSearch.search() source parameter doesn't make sense

[Dreamsorcerer]

The docs say The source fields that are returned for matching documents.. How am I supposed to define the source fields with a type of bool | Mapping[str, Any] | None?
https://elasticsearch-py.readthedocs.io/en/v8.18.1/api/elasticsearch.html#elasticsearch.Elasticsearch.search

Any examples I can find online all do _source=["field"], which neither matches the name nor the type...

[miguelgrinberg]

@Dreamsorcerer I apologize, this isn't very clear. The source parameter in Elasticsearch has several alternative formats. You can set it to the following values:

• True to include all fields in search results
• False to include no fields in search results
• A dictionary with keys include and exclude, each set to a list of strings with the field names to include or exclude
• A list of strings, which is interpreted the same as source={"include": ["field1", "field2"]}.

We currently do not provide a type hint for the last form, so if you use that you will get a typing warning. But the Elasticsearch server does accept this format.

Also, the reason why you see references to _source with an underscore is that this is the name this parameter has in the Elasticsearch server. But the Python client calls it source.

I hope this helps.