TantivyEx.CustomCollector (TantivyEx v0.4.1)

View Source

Custom collectors and scoring functionality for TantivyEx.

Summary

Types

collector_resource()

@type collector_resource() :: reference()

Functions

clear_all(collector_resource)

@spec clear_all(collector_resource()) :: :ok | {:error, term()}

create_aggregation(collector_resource, collector_name, aggregation_specs)

@spec create_aggregation(collector_resource(), String.t(), list()) ::
  :ok | {:error, term()}

create_filtering(collector_resource, collector_name, filter_specs)

@spec create_filtering(collector_resource(), String.t(), list()) ::
  :ok | {:error, term()}

create_scoring_function(collector_resource, name, scoring_type, parameters)

@spec create_scoring_function(collector_resource(), String.t(), String.t(), map()) ::
  :ok | {:error, term()}

create_top_k(collector_resource, collector_name, k, scoring_function_name)

@spec create_top_k(collector_resource(), String.t(), non_neg_integer(), String.t()) ::
  :ok | {:error, term()}

execute(collector_resource, index_resource, collector_name, query_str)

@spec execute(collector_resource(), reference(), String.t(), String.t()) ::
  {:ok, String.t()} | {:error, term()}

get_results(collector_resource, collector_name)

@spec get_results(collector_resource(), String.t()) ::
  {:ok, String.t()} | {:error, term()}

list_collectors(collector_resource)

@spec list_collectors(collector_resource()) :: {:ok, String.t()} | {:error, term()}

new()

@spec new() :: {:ok, collector_resource()} | {:error, term()}

set_field_boosts(collector_resource, scoring_function_name, field_boosts)

@spec set_field_boosts(collector_resource(), String.t(), map()) ::
  :ok | {:error, term()}