SearchAsYouTypeProperty: Unknown field 'doc_values' (JSON path: mappings.properties.search_as_you_type.doc_values

[yeikel]

Java API client version

8.17.0

Java version

17

Elasticsearch Version

8.13.2

Problem description

Given an index with properties

"search_as_you_type": {
        "type": "search_as_you_type",
        "analyzer": "default",
        "doc_values": false
      }

I am able to post it to the server from Kibana:

But the client fails to post it:

[ERROR]   JsonpMapping Error deserializing co.elastic.clients.elasticsearch._types.mapping.SearchAsYouTypeProperty: Unknown field 'doc_values' (JSON path: mappings.properties.search_as_you_type.doc_values) (in object at line no=52, column no=30, offset=1208)

[l-trotta]

Hello and thank you for reporting this. This is a special case, since search_as_you_type actually doesn't support doc_values as a request field, but the server always includes it as "false" in the response. I'll investigate a bit to understand how we want to handle this!

[yeikel]

Hello and thank you for reporting this. This is a special case, since search_as_you_type actually doesn't support doc_values as a request field, but the server always includes it as "false" in the response. I'll investigate a bit to understand how we want to handle this!

That's interesting because it allowed me to set it to false when I created the index, which gave me the illusion that it was possible to set it

If setting it shouldn't be possible, it should probably fail, I believe

Also, I think that the docs https://www.elastic.co/guide/en/elasticsearch/reference/current/doc-values.html should be updated to include this limitation as it currently says

Doc values are supported on almost all field types, with the notable exception of text and annotated_text fields.

[l-trotta]

Good catch, if this is confirmed then we'll also update the docs.

[l-trotta]

Hey @yeikel, so we established that this doc_values in this case is an internal field which won't be added to the clients. This works fine for requests, since in this case it's not supported, while for responses using the default json deserialization settings it will be simply ignored by the java client. Docs will be updated! Thanks again for the report.

[yeikel]

Hey @yeikel, so we established that this doc_values in this case is an internal field which won't be added to the clients. This works fine for requests, since in this case it's not supported, while for responses using the default json deserialization settings it will be simply ignored by the java client. Docs will be updated! Thanks again for the report.

Will that happen in a future iteration of the client? Because in my current client I see that error

[l-trotta]

It might be an issue with the configured json mapper being in strict mode, could you show me how is the client configured?

[yeikel]

final var host = new HttpHost(elasticsearchContainer.getHost(), elasticsearchContainer.getFirstMappedPort(), "http");

        final var restClient = RestClient.builder(host)
                .setRequestConfigCallback(requestConfigBuilder -> requestConfigBuilder
                        .setConnectTimeout(10_000)
                        .setSocketTimeout(10_000))
                .setHttpClientConfigCallback(getHttpClientConfigCallback())
                .build();

        final var jacksonJsonpMapper = new JacksonJsonpMapper();

        return new ElasticsearchClient(new RestClientTransport(restClient, jacksonJsonpMapper));

It is not a blocker; I just removed the "doc_values": false configuration from the schema as that's not valid to begin with. Just figured I should share just in case it needs to be corrected

[l-trotta]

Got it, I was just curious because testing it with the same json mapper I'm not getting the same exception, as doc_values get ignored by deserialization when calling:

esClient.indices().getMapping(g -> g.index("my-index-search-as-you-type"));