Package co.elastic.clients.elasticsearch.core

Class KnnSearchResponse<TDocument>

java.lang.Object
co.elastic.clients.elasticsearch.core.KnnSearchResponse<TDocument>
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class KnnSearchResponse<TDocument>
extends java.lang.Object
implements JsonpSerializable
See Also:
API specification

  • Field Details

  • Method Details

    • of

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

    • took

      public final long took()
      Required - Milliseconds it took Elasticsearch to execute the request.

      API name: took

    • timedOut

      public final boolean timedOut()
      Required - If true, the request timed out before completion; returned results may be partial or empty.

      API name: timed_out

    • shards

      public final ShardStatistics shards()
      Required - Contains a count of shards used for the request.

      API name: _shards

    • hits

      public final HitsMetadata<TDocument> hits()
      Required - Contains returned documents and metadata.

      API name: hits

    • fields

      public final java.util.Map<java.lang.String,​JsonData> fields()
      Contains field values for the documents. These fields must be specified in the request using the fields parameter.

      API name: fields

    • maxScore

      @Nullable public final java.lang.Double maxScore()
      Highest returned document score. This value is null for requests that do not sort by score.

      API name: max_score

    • 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)

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • createKnnSearchResponseDeserializer

      public static <TDocument> JsonpDeserializer<KnnSearchResponse<TDocument>> createKnnSearchResponseDeserializer​(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create a JSON deserializer for KnnSearchResponse

    • setupKnnSearchResponseDeserializer

      protected static <TDocument> void setupKnnSearchResponseDeserializer​(ObjectDeserializer<KnnSearchResponse.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)