Package co.elastic.clients.elasticsearch.core

Class KnnSearchRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.KnnSearchRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class KnnSearchRequest
extends RequestBase
implements JsonpSerializable
Performs a kNN search.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static KnnSearchRequest of​(java.util.function.Function<KnnSearchRequest.Builder,​ObjectBuilder<KnnSearchRequest>> fn)

    • source

      @Nullable public final SourceConfig source()
      Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.

      API name: _source

    • docvalueFields

      public final java.util.List<FieldAndFormat> docvalueFields()
      The request returns doc values for field names matching these patterns in the hits.fields property of the response. Accepts wildcard (*) patterns.

      API name: docvalue_fields

    • fields

      public final java.util.List<java.lang.String> fields()
      The request returns values for field names matching these patterns in the hits.fields property of the response. Accepts wildcard (*) patterns.

      API name: fields

    • filter

      public final java.util.List<Query> filter()
      Query to filter the documents that can match. The kNN search will return the top k documents that also match this filter. The value can be a single query or a list of queries. If filter isn't provided, all documents are allowed to match.

      API name: filter

    • index

      public final java.util.List<java.lang.String> index()
      Required - A comma-separated list of index names to search; use _all or to perform the operation on all indices

      API name: index

    • knn

      public final KnnSearchQuery knn()
      Required - kNN query to execute

      API name: knn

    • routing

      @Nullable public final java.lang.String routing()
      A comma-separated list of specific routing values

      API name: routing

    • storedFields

      public final java.util.List<java.lang.String> storedFields()
      List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.

      API name: stored_fields

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupKnnSearchRequestDeserializer

      protected static void setupKnnSearchRequestDeserializer​(ObjectDeserializer<KnnSearchRequest.Builder> op)

    • createKnnSearchEndpoint

      public static <TDocument> Endpoint<KnnSearchRequest,​KnnSearchResponse<TDocument>,​ErrorResponse> createKnnSearchEndpoint​(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create an "knn_search" endpoint.