Branch 3.0.0 v1

.github/workflows/integration_test.yml

@@ -673,7 +673,7 @@ jobs:
     - name: Build and install aerospike-vector-search
       run: |
         python -m build
-        pip install dist/aerospike_vector_search-2.1.0-py3-none-any.whl
+        pip install dist/aerospike_vector_search-3.0.0-py3-none-any.whl
 
     - name: Upload to Codecov
       uses: codecov/codecov-action@v4

proto/index.proto

@@ -12,6 +12,12 @@ import "types.proto";
 message IndexStatusResponse {
   // Number of unmerged index records.
   int64 unmergedRecordCount = 2;
+
+  // Number of vector records indexed (0 in case healer has not yet run).
+  int64 indexHealerVectorRecordsIndexed = 3;
+
+  // Number of vertices in the main index (0 in case healer has not yet run).
+  int64 indexHealerVerticesValid = 4;
 }
 
 message GcInvalidVerticesRequest {

proto/transact.proto

@@ -37,8 +37,8 @@ message PutRequest {
   // The key for the record to insert/update
   Key key = 1;
 
-  // The type of the put/write request.
-  WriteType writeType = 2;
+  // The type of the put/write request. Defaults to UPSERT.
+  optional WriteType writeType = 2;
 
   // The record fields.
   repeated Field fields = 3;
@@ -88,8 +88,8 @@ enum ProjectionType {
 
 // A projection filter.
 message ProjectionFilter {
-  // The type of the selector.
-  ProjectionType type = 1;
+  // The type of the selector. Defaults to ALL.
+  optional ProjectionType type = 1;
 
   // Names of desired fields / selectors.
   repeated string fields = 2;

proto/types.proto

@@ -202,6 +202,10 @@ message HnswParams {
 
   // Configures merge of batch indices to main index.
   HnswIndexMergeParams mergeParams = 8;
+
+  // Verify whether the underlying vector has changed before returning the kAnn
+  // result. Defaults to true.
+  optional bool enableVectorIntegrityCheck = 9;
 }
 
 // Params for the HNSW index search.
@@ -234,7 +238,7 @@ message HnswCachingParams {
   // A cache entry will expire after this time in milliseconds has
   // expired after the entry was added to cache.
   // Defaults to the global cache config configured for the VectorDB.
-  optional uint64 expiry = 2;
+  optional int64 expiry = 2;
 }
 
 // Params to configure Hnsw index cache
@@ -292,6 +296,10 @@ message HnswIndexUpdate {
 
   // Configures merge of batch indices to main index.
   optional HnswIndexMergeParams mergeParams = 5;
+
+  // Verify whether the underlying vector has changed before returning the kAnn
+  // result. Defaults to true.
+  optional bool enableVectorIntegrityCheck = 6;
 }
 
 // Index storage configuration
@@ -310,15 +318,15 @@ message IndexDefinition {
   // The index identifier.
   IndexId id = 1;
 
-  // The type of index.
-  IndexType type = 2;
+  // The type of index. Defaults to HNSW.
+  optional IndexType type = 2;
 
   // Number of dimensions in data.
   // Vectors not matching the dimension count will not be indexed.
   uint32 dimensions = 3;
 
-  // Optional The distance metric to use. Defaults to SQUARED_EUCLIDEAN
-  VectorDistanceMetric vectorDistanceMetric = 4;
+  // Optional The distance metric to use. Defaults to SQUARED_EUCLIDEAN.
+  optional VectorDistanceMetric vectorDistanceMetric = 4;
 
   // Name of the record vector field to index.
   string field = 5;

pyproject.toml

@@ -22,12 +22,12 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
     "Topic :: Database"
 ]
-version = "2.1.0"
+version = "3.0.0"
 requires-python = ">3.8"
 dependencies = [
-    "grpcio == 1.66.1",
-    "protobuf == 5.27.2",
-    "pyjwt == 2.8.0",
+    "grpcio == 1.67.0",
+    "protobuf == 5.28.2",
+    "pyjwt == 2.9.0",
     "numpy",
     "sphinx_rtd_theme"
 ]
@@ -54,4 +54,4 @@ exclude = '''
   | src/aerospike_vector_search/__pycache__/*
   | src/aerospike_vector_search.egg-info/*
 )/
-'''
+'''

src/aerospike_vector_search/admin.py

@@ -298,7 +298,7 @@ def index_get(
 
     def index_get_status(
         self, *, namespace: str, name: str, timeout: Optional[int] = None
-    ) -> int:
+    ) -> types.IndexStatusResponse:
         """
         Retrieve the number of records queued to be merged into an index.
 
@@ -311,7 +311,7 @@ def index_get_status(
         :param timeout: Time in seconds this operation will wait before raising an :class:`AVSServerError <aerospike_vector_search.types.AVSServerError>`. Defaults to None.
         :type timeout: int
 
-        Returns: int: Records queued to be merged into an index.
+        Returns: IndexStatusResponse: AVS response containing index status information.
 
         Raises:
             AVSServerError: Raised if an error occurs during the RPC communication with the server while attempting to get the index status.
@@ -337,7 +337,7 @@ def index_get_status(
             logger.error("Failed to get index status with error: %s", e)
             raise types.AVSServerError(rpc_error=e)
 
-        return self._respond_index_get_status(response)
+        return types.IndexStatusResponse.from_proto_response(response)
 
     def add_user(
         self,

src/aerospike_vector_search/aio/admin.py

@@ -7,6 +7,7 @@
 from .. import types
 from .internal import channel_provider
 from ..shared.admin_helpers import BaseClient
+from ..types import IndexStatusResponse
 
 logger = logging.getLogger(__name__)
 
@@ -308,7 +309,7 @@ async def index_get(
 
     async def index_get_status(
         self, *, namespace: str, name: str, timeout: Optional[int] = None
-    ) -> int:
+    ) -> types.IndexStatusResponse:
         """
         Retrieve the number of records queued to be merged into an index.
 
@@ -349,7 +350,7 @@ async def index_get_status(
             logger.error("Failed to get index status with error: %s", e)
             raise types.AVSServerError(rpc_error=e)
 
-        return self._respond_index_get_status(response)
+        return IndexStatusResponse.from_proto_response(response)
 
     async def add_user(
         self,

src/aerospike_vector_search/shared/admin_helpers.py

@@ -12,6 +12,7 @@
 from .proto_generated import types_pb2, user_admin_pb2, index_pb2
 from .. import types
 from . import conversions
+from ..types import AVSClientError
 
 logger = logging.getLogger(__name__)
 

src/aerospike_vector_search/shared/client_helpers.py

@@ -8,6 +8,7 @@
 from .. import types
 from .proto_generated import types_pb2
 from . import helpers
+from ..types import AVSClientError
 
 
 class BaseClient(object):

src/aerospike_vector_search/shared/proto_generated/auth_pb2_grpc.py

@@ -5,7 +5,7 @@
 
 from . import auth_pb2 as auth__pb2
 
-GRPC_GENERATED_VERSION = '1.66.1'
+GRPC_GENERATED_VERSION = '1.66.2'
 GRPC_VERSION = grpc.__version__
 _version_not_supported = False
 

src/aerospike_vector_search/shared/proto_generated/index_pb2_grpc.py

@@ -7,7 +7,7 @@
 from . import index_pb2 as index__pb2
 from . import types_pb2 as types__pb2
 
-GRPC_GENERATED_VERSION = '1.66.1'
+GRPC_GENERATED_VERSION = '1.66.2'
 GRPC_VERSION = grpc.__version__
 _version_not_supported = False