From 1c4499d4da12147f1068e7e6d885517cac35444a Mon Sep 17 00:00:00 2001 From: Alex Castillo Date: Sat, 7 Nov 2026 08:48:04 -0400 Subject: [PATCH] Python: fix VectorSearch.search overloads advertising vector_field_name The overloads declared a vector_field_name keyword while the implementation and the hybrid/keyword overloads use vector_property_name, so type checkers and IDEs suggested an argument that ends up ignored in **kwargs. Rename the overload parameter and docstrings, and add a signature test. --- python/semantic_kernel/data/vector.py | 8 ++++---- python/tests/unit/data/test_vector_search_base.py | 13 +++++++++++++ 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/python/semantic_kernel/data/vector.py b/python/semantic_kernel/data/vector.py index 69bdc78a938e..7d07475f1641 100644 --- a/python/semantic_kernel/data/vector.py +++ b/python/semantic_kernel/data/vector.py @@ -1760,7 +1760,7 @@ async def search( self, values: Any, *, - vector_field_name: str | None = None, + vector_property_name: str | None = None, filter: OptionalOneOrList[Callable | str] = None, top: int = 3, skip: int = 0, @@ -1773,7 +1773,7 @@ async def search( Args: values: The values to search for. These will be vectorized, either by the store or using the provided generator. - vector_field_name: The name of the vector field to use for the search. + vector_property_name: The name of the vector field to use for the search. filter: The filter to apply to the search. top: The number of results to return. skip: The number of results to skip. @@ -1796,7 +1796,7 @@ async def search( self, *, vector: Sequence[float | int], - vector_field_name: str | None = None, + vector_property_name: str | None = None, filter: OptionalOneOrList[Callable | str] = None, top: int = 3, skip: int = 0, @@ -1808,7 +1808,7 @@ async def search( Args: vector: The vector to search for - vector_field_name: The name of the vector field to use for the search. + vector_property_name: The name of the vector field to use for the search. filter: The filter to apply to the search. top: The number of results to return. skip: The number of results to skip. diff --git a/python/tests/unit/data/test_vector_search_base.py b/python/tests/unit/data/test_vector_search_base.py index dffc280b2d66..ee383d0a12e5 100644 --- a/python/tests/unit/data/test_vector_search_base.py +++ b/python/tests/unit/data/test_vector_search_base.py @@ -43,3 +43,16 @@ async def test_create_search_function_preserves_filter_for_invalid_invocation_op mock_search.assert_awaited_once() assert mock_search.await_args.kwargs["filter"] == search_filter + + +def test_search_overloads_match_implementation_parameters(): + """The public `search` overloads must only advertise keyword arguments the implementation accepts.""" + import inspect + from typing import get_overloads + + impl_params = set(inspect.signature(VectorSearch.search).parameters) + for overload in get_overloads(VectorSearch.search): + overload_params = set(inspect.signature(overload).parameters) + assert "vector_field_name" not in overload_params + assert "vector_property_name" in overload_params + assert overload_params - {"kwargs"} <= impl_params | {"kwargs"}