All Superinterfaces:
NamedWriteable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject, Writeable
All Known Implementing Classes:
Classification, OutlierDetection, Regression

public interface Evaluation extends org.elasticsearch.xcontent.ToXContentObject, NamedWriteable
Defines an evaluation
  • Method Details

    • getName

      String getName()
      Returns the evaluation name
    • getFields

      EvaluationFields getFields()
      Returns the collection of fields required by evaluation
    • getMetrics

      List<? extends EvaluationMetric> getMetrics()
      Returns the list of metrics to evaluate
      Returns:
      list of metrics to evaluate
    • initMetrics

      default <T extends EvaluationMetric> List<T> initMetrics(@Nullable List<T> parsedMetrics, Supplier<List<T>> defaultMetricsSupplier)
    • buildSearch

      default SearchSourceBuilder buildSearch(EvaluationParameters parameters, QueryBuilder userProvidedQueryBuilder)
      Builds the search required to collect data to compute the evaluation result
      Parameters:
      userProvidedQueryBuilder - User-provided query that must be respected when collecting data
    • process

      default void process(SearchResponse searchResponse)
      Processes SearchResponse from the search action
      Parameters:
      searchResponse - response from the search action
    • hasAllResults

      default boolean hasAllResults()
      Returns:
      true iff all the metrics have their results computed
    • getResults

      default List<EvaluationMetricResult> getResults()
      Returns the list of evaluation results
      Returns:
      list of evaluation results