Cuiys
0923f7c691
* refactor: make Reranker stateless with std::variant value semantics (#461) Replace class hierarchy (Reranker/ScoreBasedReranker/RrfReranker/ WeightedReranker/CallbackReranker) with std::variant<RrfParams, WeightedParams, CallbackParams> value type and a stateless free function reranker::rerank(). Key changes: - reranker.h: define RerankParams variant + reranker::rerank() API - query.h: MultiQuery::reranker (shared_ptr) -> MultiQuery::rerank (value) - schema.h: add CollectionSchema::get_field_ptr() returning FieldSchema::Ptr - collection.cc: push field lookup to caller, pass vector<FieldSchema::Ptr> - c_api: remove opaque zvec_reranker_t, add zvec_multi_query_set_rerank_* - python binding: expose _RrfParams/_WeightedParams/_CallbackParams + setters - python layer: WeightedReRanker(list[float]), remove Python rerank logic - all tests updated to new interface Benefits: - Thread-safe by design: no mutable state, safe to share across threads - Collection-decoupled: no bind_schema(), field info passed as parameter - Simpler lifecycle: value semantics, no shared_ptr management Closes #461 * chore: remove nightly_build.yml unrelated to reranker refactor * chore: remove uv.lock unrelated to reranker refactor * fix: raise ValueError when multi-query has no reranker After the reranker stateless refactor the C++ MultiQuery rerank strategy uses a std::variant with a default value, so the implicit 'reranker required' validation no longer triggered. Restore the check in QueryExecutor._execute_multi_query so that a hybrid (multi-query) request without a reranker raises ValueError. * fix(reranker): use index_type FTS check for non-vector normalization Replace dynamic_cast nullptr check with explicit IndexType::FTS check and map FTS/BM25 positive scores to (0.0, 1.0) via 2*atan(score)/pi. * refactor(reranker): move Params types into reranker namespace and qualify usages Move RrfParams, WeightedParams, CallbackParams and RerankParams into the zvec::reranker namespace, and add explicit reranker:: qualification at all usage sites outside the reranker module (query.h, python/c bindings, tests). * refactor(query): drop unused PendingQuery wrapper, use std::vector<SearchQuery> directly * refactor(reranker): make _to_cpp_params non-abstract with default NotImplementedError Remove @abstractmethod from RerankFunction._to_cpp_params and provide a default implementation raising NotImplementedError. Drop the redundant _to_cpp_params overrides from Qwen and Sentence rerankers since they use the Python rerank path and don't need the C++ conversion.
57 lines
1.8 KiB
Python
57 lines
1.8 KiB
Python
# Copyright 2025-present the zvec project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
from __future__ import annotations
|
|
|
|
from abc import ABC, abstractmethod
|
|
from typing import TYPE_CHECKING
|
|
|
|
from ..model.doc import Doc, DocList
|
|
|
|
if TYPE_CHECKING:
|
|
from ..model.schema import FieldSchema, VectorSchema
|
|
|
|
|
|
class RerankFunction(ABC):
|
|
"""Abstract base class for reranker parameter containers.
|
|
|
|
Subclasses define rerank parameters and implement _to_cpp_params()
|
|
for conversion to C++ parameter structs (used by collection fast path).
|
|
Each subclass also provides a standalone rerank() implementation.
|
|
"""
|
|
|
|
def _to_cpp_params(self):
|
|
"""Return C++ reranker params. Override in subclasses that use C++ path."""
|
|
raise NotImplementedError
|
|
|
|
@abstractmethod
|
|
def rerank(
|
|
self,
|
|
query_results: list[list[Doc]],
|
|
topn: int = 10,
|
|
*,
|
|
fields: list[FieldSchema | VectorSchema] | None = None,
|
|
) -> DocList:
|
|
"""Execute rerank on sub-query results.
|
|
|
|
Args:
|
|
query_results: List of per-sub-query document lists.
|
|
topn: Maximum number of results to return.
|
|
fields: Per-sub-query Python FieldSchema/VectorSchema objects
|
|
(required for WeightedReRanker score normalization).
|
|
|
|
Returns:
|
|
Re-ranked document list.
|
|
"""
|
|
...
|