From 9fec62f71bc5f313372c03856f1ed2e09cde402c Mon Sep 17 00:00:00 2001 From: dylan Date: Fri, 11 Oct 2024 10:10:09 -0700 Subject: [PATCH] rename vector_search_by_key argument from set_name to key_set and index_namespace to search_namespace --- src/aerospike_vector_search/aio/client.py | 18 ++++----- src/aerospike_vector_search/client.py | 18 ++++----- .../aio/test_vector_client_search_by_key.py | 38 +++++++++---------- .../sync/test_vector_client_search_by_key.py | 38 +++++++++---------- 4 files changed, 56 insertions(+), 56 deletions(-) diff --git a/src/aerospike_vector_search/aio/client.py b/src/aerospike_vector_search/aio/client.py index 96873163..4bcb87cc 100644 --- a/src/aerospike_vector_search/aio/client.py +++ b/src/aerospike_vector_search/aio/client.py @@ -492,13 +492,13 @@ async def is_indexed( async def vector_search_by_key( self, *, - index_namespace: str, + search_namespace: str, index_name: str, key: Union[int, str, bytes, bytearray], key_namespace: str, vector_field: str, limit: int, - set_name: Optional[str] = None, + key_set: Optional[str] = None, search_params: Optional[types.HnswSearchParams] = None, include_fields: Optional[list[str]] = None, exclude_fields: Optional[list[str]] = None, @@ -507,10 +507,10 @@ async def vector_search_by_key( """ Perform a Hierarchical Navigable Small World (HNSW) vector search in Aerospike Vector Search by primary record key. - :param index_namespace: The namespace that stores the index. - :type index_namespace: str + :param search_namespace: The namespace that stores the records to be searched. + :type search_namespace: str - :param index_name: The name of the index. + :param index_name: The name of the index to use in the search. :type index_name: str :param key: The primary key of the record that stores the vector to use in the search. @@ -525,8 +525,8 @@ async def vector_search_by_key( :param limit: The maximum number of neighbors to return. K value. :type limit: int - :param set_name: The name of the set from which to read the record. Defaults to None. - :type set_name: Optional[str] + :param key_set: The name of the set from which to read the record to search by. Defaults to None. + :type key_set: Optional[str] :param search_params: Parameters for the HNSW algorithm. If None, the default parameters for the index are used. Defaults to None. @@ -559,14 +559,14 @@ async def vector_search_by_key( rec_and_key = await self.get( namespace=key_namespace, key=key, - set_name=set_name, + set_name=key_set, timeout=timeout, ) vector = rec_and_key.fields[vector_field] neighbors = await self.vector_search( - namespace=index_namespace, + namespace=search_namespace, index_name=index_name, query=vector, limit=limit, diff --git a/src/aerospike_vector_search/client.py b/src/aerospike_vector_search/client.py index 89b8b377..99848042 100644 --- a/src/aerospike_vector_search/client.py +++ b/src/aerospike_vector_search/client.py @@ -471,13 +471,13 @@ def is_indexed( def vector_search_by_key( self, *, - index_namespace: str, + search_namespace: str, index_name: str, key: Union[int, str, bytes, bytearray], key_namespace: str, vector_field: str, limit: int, - set_name: Optional[str] = None, + key_set: Optional[str] = None, search_params: Optional[types.HnswSearchParams] = None, include_fields: Optional[list[str]] = None, exclude_fields: Optional[list[str]] = None, @@ -486,10 +486,10 @@ def vector_search_by_key( """ Perform a Hierarchical Navigable Small World (HNSW) vector search in Aerospike Vector Search by primary record key. - :param index_namespace: The namespace that stores the index. - :type index_namespace: str + :param search_namespace: The namespace that stores the records to be searched. + :type search_namespace: str - :param index_name: The name of the index. + :param index_name: The name of the index to use in the search. :type index_name: str :param key: The primary key of the record that stores the vector to use in the search. @@ -504,8 +504,8 @@ def vector_search_by_key( :param limit: The maximum number of neighbors to return. K value. :type limit: int - :param set_name: The name of the set from which to read the record. Defaults to None. - :type set_name: Optional[str] + :param key_set: The name of the set from which to read the record to search by. Defaults to None. + :type key_set: Optional[str] :param search_params: Parameters for the HNSW algorithm. If None, the default parameters for the index are used. Defaults to None. @@ -541,14 +541,14 @@ def vector_search_by_key( rec_and_key = self.get( namespace=key_namespace, key=key, - set_name=set_name, + set_name=key_set, timeout=timeout, ) vector = rec_and_key.fields[vector_field] neighbors = self.vector_search( - namespace=index_namespace, + namespace=search_namespace, index_name=index_name, query=vector, limit=limit, diff --git a/tests/standard/aio/test_vector_client_search_by_key.py b/tests/standard/aio/test_vector_client_search_by_key.py index 958a0522..c7493f42 100644 --- a/tests/standard/aio/test_vector_client_search_by_key.py +++ b/tests/standard/aio/test_vector_client_search_by_key.py @@ -14,10 +14,10 @@ def __init__( limit, key, key_namespace, - index_namespace, + search_namespace, include_fields, exclude_fields, - set_name, + key_set, record_data, expected_results, ): @@ -26,10 +26,10 @@ def __init__( self.vector_field = vector_field self.limit = limit self.key = key - self.index_namespace = index_namespace + self.search_namespace = search_namespace self.include_fields = include_fields self.exclude_fields = exclude_fields - self.set_name = set_name + self.key_set = key_set self.record_data = record_data self.expected_results = expected_results self.key_namespace = key_namespace @@ -47,10 +47,10 @@ def __init__( limit=2, key="rec1", key_namespace="test", - index_namespace="test", + search_namespace="test", include_fields=None, exclude_fields=None, - set_name=None, + key_set=None, record_data={ "rec1": { "bin": 1, @@ -100,10 +100,10 @@ def __init__( limit=3, key=1, key_namespace="test", - index_namespace="test", + search_namespace="test", include_fields=["bin"], exclude_fields=["bin"], - set_name=None, + key_set=None, record_data={ 1: { "bin": 1, @@ -143,10 +143,10 @@ def __init__( limit=3, key=bytes("rec1", "utf-8"), key_namespace="test", - index_namespace="test", + search_namespace="test", include_fields=["bin"], exclude_fields=["bin"], - set_name=None, + key_set=None, record_data={ bytes("rec1", "utf-8"): { "bin": 1, @@ -190,7 +190,7 @@ def __init__( # namespace="test", # include_fields=["bin"], # exclude_fields=["bin"], - # set_name=None, + # key_set=None, # record_data={ # bytearray("rec1", "utf-8"): { # "bin": 1, @@ -221,10 +221,10 @@ def __init__( limit=1, key="rec1", key_namespace="test", - index_namespace="test", + search_namespace="test", include_fields=None, exclude_fields=None, - set_name="test_set", + key_set="test_set", record_data={ "rec1": { "bin": 1, @@ -271,7 +271,7 @@ async def test_vector_search_by_key( ): await session_admin_client.index_create( - namespace=test_case.index_namespace, + namespace=test_case.search_namespace, name=test_case.index_name, vector_field=test_case.vector_field, dimensions=test_case.index_dimensions, @@ -283,25 +283,25 @@ async def test_vector_search_by_key( namespace=test_case.key_namespace, key=key, record_data=rec, - set_name=test_case.set_name, + key_set=test_case.key_set, )) tasks.append( session_vector_client.wait_for_index_completion( - namespace=test_case.index_namespace, + namespace=test_case.search_namespace, name=test_case.index_name, ) ) await asyncio.gather(*tasks) results = await session_vector_client.vector_search_by_key( - index_namespace=test_case.index_namespace, + search_namespace=test_case.search_namespace, index_name=test_case.index_name, key=test_case.key, key_namespace=test_case.key_namespace, vector_field=test_case.vector_field, limit=test_case.limit, - set_name=test_case.set_name, + key_set=test_case.key_set, include_fields=test_case.include_fields, exclude_fields=test_case.exclude_fields, ) @@ -318,6 +318,6 @@ async def test_vector_search_by_key( await asyncio.gather(*tasks) await session_admin_client.index_drop( - namespace=test_case.index_namespace, + namespace=test_case.search_namespace, name=test_case.index_name, ) diff --git a/tests/standard/sync/test_vector_client_search_by_key.py b/tests/standard/sync/test_vector_client_search_by_key.py index 3cf1363a..1b96d531 100644 --- a/tests/standard/sync/test_vector_client_search_by_key.py +++ b/tests/standard/sync/test_vector_client_search_by_key.py @@ -12,10 +12,10 @@ def __init__( limit, key, key_namespace, - index_namespace, + search_namespace, include_fields, exclude_fields, - set_name, + key_set, record_data, expected_results, ): @@ -24,10 +24,10 @@ def __init__( self.vector_field = vector_field self.limit = limit self.key = key - self.index_namespace = index_namespace + self.search_namespace = search_namespace self.include_fields = include_fields self.exclude_fields = exclude_fields - self.set_name = set_name + self.key_set = key_set self.record_data = record_data self.expected_results = expected_results self.key_namespace = key_namespace @@ -45,10 +45,10 @@ def __init__( limit=2, key="rec1", key_namespace="test", - index_namespace="test", + search_namespace="test", include_fields=None, exclude_fields=None, - set_name=None, + key_set=None, record_data={ "rec1": { "bin": 1, @@ -98,10 +98,10 @@ def __init__( limit=3, key=1, key_namespace="test", - index_namespace="test", + search_namespace="test", include_fields=["bin"], exclude_fields=["bin"], - set_name=None, + key_set=None, record_data={ 1: { "bin": 1, @@ -141,10 +141,10 @@ def __init__( limit=3, key=bytes("rec1", "utf-8"), key_namespace="test", - index_namespace="test", + search_namespace="test", include_fields=["bin"], exclude_fields=["bin"], - set_name=None, + key_set=None, record_data={ bytes("rec1", "utf-8"): { "bin": 1, @@ -188,7 +188,7 @@ def __init__( # namespace="test", # include_fields=["bin"], # exclude_fields=["bin"], - # set_name=None, + # key_set=None, # record_data={ # bytearray("rec1", "utf-8"): { # "bin": 1, @@ -219,10 +219,10 @@ def __init__( limit=1, key="rec1", key_namespace="test", - index_namespace="test", + search_namespace="test", include_fields=None, exclude_fields=None, - set_name="test_set", + key_set="test_set", record_data={ "rec1": { "bin": 1, @@ -269,7 +269,7 @@ def test_vector_search_by_key( ): session_admin_client.index_create( - namespace=test_case.index_namespace, + namespace=test_case.search_namespace, name=test_case.index_name, vector_field=test_case.vector_field, dimensions=test_case.index_dimensions, @@ -280,22 +280,22 @@ def test_vector_search_by_key( namespace=test_case.key_namespace, key=key, record_data=rec, - set_name=test_case.set_name, + key_set=test_case.key_set, ) session_vector_client.wait_for_index_completion( - namespace=test_case.index_namespace, + namespace=test_case.search_namespace, name=test_case.index_name, ) results = session_vector_client.vector_search_by_key( - index_namespace=test_case.index_namespace, + search_namespace=test_case.search_namespace, index_name=test_case.index_name, key=test_case.key, key_namespace=test_case.key_namespace, vector_field=test_case.vector_field, limit=test_case.limit, - set_name=test_case.set_name, + key_set=test_case.key_set, include_fields=test_case.include_fields, exclude_fields=test_case.exclude_fields, ) @@ -309,6 +309,6 @@ def test_vector_search_by_key( ) session_admin_client.index_drop( - namespace=test_case.index_namespace, + namespace=test_case.search_namespace, name=test_case.index_name, )