Package co.elastic.clients.elasticsearch.core.rank_eval

Class RankEvalMetricDetail

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

  • Field Details

  • Method Details

    • of

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

    • metricScore

      public final double metricScore()
      Required - The metric_score in the details section shows the contribution of this query to the global quality metric score

      API name: metric_score

    • unratedDocs

      public final java.util.List<UnratedDocument> unratedDocs()
      Required - The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents

      API name: unrated_docs

    • hits

      public final java.util.List<RankEvalHitItem> hits()
      Required - The hits section shows a grouping of the search results with their supplied ratings

      API name: hits

    • metricDetails

      public final java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​JsonData>> metricDetails()
      Required - The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results

      API name: metric_details

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

    • setupRankEvalMetricDetailDeserializer

      protected static void setupRankEvalMetricDetailDeserializer​(ObjectDeserializer<RankEvalMetricDetail.Builder> op)