2.1.0

Release notes

The AVS Python client 2.1.0 is compatible only with AVS server versions 0.10.0 and later.

New in this version

This version adds search by key and field exclusion functionality.

Deprecated methods

The field_names argument to the client get and vector_search methods has been deprecated. Use include_fields instead.

New features

• Add the exclude_fields argument to client get and vector_search methods to explicitly exclude fields from the results. [VEC-327]
• Add the vector_search_by_key method to search by Aerospike primary record keys instead of vectors. [VEC-330]

Issues fixed

• An empty list used as the include_fields argument in the client get and vector_search methods includes all result fields when it should filter out all fields. This issue existed on previous versions for field_names, which was renamed in this release. [VEC-372]

More information

https://pypi.org/project/aerospike-vector-search/2.1.0/
https://aerospike-vector-search-python-client.readthedocs.io/en/latest/

Full Changelog: 2.0.0...2.1.0

2.0.0

Release notes

This AVS client is only compatible with AVS server versions 0.10.0 and newer.

New in this version

This version implements a variety of fixes and improvements to enhance usability and reliability.

Breaking changes

• Renamed HnswHealerParams.schedule_delay (int) to schedule (str) and quartz cron expressions are now accepted for configuring the index healer schedule. [VEC-275]
• Renamed HnswIndexMergeParams.parallelism to index_parallelism and added reindex_parallelism. [VEC-275]

New features

• Added the ssl_target_name_override configuration option. [CLIENT-3079]
• Added the apply_defaults parameter to index_get and index_list for returning index info with default values. [VEC-241]

Issues fixed

• The max_mem_queue_size field was not being set properly in fromIndexDefinition and it was not being returned when indexes were retrieved.

Resources

https://pypi.org/project/aerospike-vector-search/2.0.0/
https://aerospike-vector-search-python-client.readthedocs.io/en/latest/

Full Changelog: 1.0.2...2.0.0

1.0.2

Release notes

This AVS client version is only compatible with AVS server version 0.9.0.

Bug Fixes

• [CLIENT-3077] - A none result while tending was causing the program to exit with an error.
• [CLIENT-3078] - AVSServerError was not defined in channel_provider.py.

Resources

• https://pypi.org/project/aerospike-vector-search/1.0.2/
• https://aerospike-vector-search-python-client.readthedocs.io/en/latest/

1.0.1

Release notes

This AVS client version is only compatible with AVS server version 0.9.0.

New Features

• [CLIENT-3064] - Added additional parameters to types.IndexDefinition.

Improvements

• [CLIENT-2920] - Improved tending performance in the aio clients.
• [CLIENT-3065] - Refactored tending and simplified existing code.

Bug Fixes

• [CLIENT-3036] - Fixed bug in which timeout was ignored in client.wait_for_completion.
• [CLIENT-3066] - Fixed bug in which authentication would not refresh when load_balancer is true.
• [CLIENT-3067] - Fixed bug in which tend errors would not propagate to the user in the aio clients.

Resources

• https://pypi.org/project/aerospike-vector-search/1.0.1/
• https://aerospike-vector-search-python-client.readthedocs.io/en/latest/

1.0.0

This AVS client version is only compatible with AVS server version 0.9.0.

This is the initial release of the Aerospike Vector Search Python Client.

0.6.1

This AVS client version is only compatible with AVS server version 0.4.0.

Bug Fixes

• [CLIENT-2956] - VectorSearch no longer throws RpcError. AVSServerError is now thrown instead.

https://pypi.org/project/aerospike-vector-search/0.6.1/
https://aerospike-vector-search-python-client.readthedocs.io/en/latest/

0.6.0

This AVS client version is only compatible with AVS server version 0.4.0.

New Features

• [CLIENT-2927] - Added insert, update, upsert. Removed put.
• [CLIENT-2928] - Added delete.
• [CLIENT-2895] - Added numpy array support for vector parameters in the following methods:
  • vector_search
  • insert
  • update
  • upsert
• [CLIENT-2949] - Added “validation_checks” parameter to wait_for_index_completion.
• [CLIENT-2950] - Added AVSServerError and AVSError. Client methods will now raise AVSError rather than RpcError.

Improvements

• [CLIENT-2945] - Replaced any usage of “bin” with “field”.
• [CLIENT-2946] - Removed any usage of “digest”.

Bug Fixes

• [CLIENT-2947] - Fixed tending bug related to deleting endpoints.

https://pypi.org/project/aerospike-vector-search/0.6.0/
https://aerospike-vector-search-python-client.readthedocs.io/en/latest/

0.5.1

New Features

• [CLIENT-2935] - Added wait_interval as a parameter to wait_for_index_completion
• [CLIENT-2939] - Added access to admin client and types classes through the aerospike_vector_search module directly.

Improvements

• [CLIENT-2936] - Added event mechanisms to ensure tending has stopped before closing client.
• [CLIENT-2937] - Improved tending performance in the "aio" module.
• [CLIENT-2938] - Added underscores to several methods and variables to improve IntelliSense.

https://pypi.org/project/aerospike-vector-search/0.5.1/
https://aerospike-vector-search-python-client.readthedocs.io/en/latest/

0.5.0

New Features

• [CLIENT-2893] - Added sync client module and moved async client to aio module.
• [CLIENT-2940] - Refactored client to minimize code duplication between async and sync modules.

Improvements

• [CLIENT-2940] - Refactored client to minimize code duplication between async and sync modules.
• [CLIENT-2941] - Added sync testing and moved async testing to aio module
• [CLIENT-2942] - Renamed VectorDbClient and VectorDbAdminClient to Client.

https://pypi.org/project/aerospike-vector-search/0.5.0/
https://aerospike-vector-search-python-client.readthedocs.io/en/latest/

0.4.0

New Features

• [CLIENT-2879] - Converted client methods to coroutines to support asynchronous programming.
• [CLIENT-2918] - Added basic support for Logging.

Improvements

• [CLIENT-2875] - Reviewed adherence to PEP-8 standards and made improvements in accordance to the review.
• [CLIENT-2877] - Formatted code using Black. Future code improvements will also be formatted using Black.
• [CLIENT-2882] - Changed VectorDbClient.index_create:
  • Changed name from createIndex to index_create
  • Changed parameters names. New parameter names include:
    • sets
    • vector_bin_names
    • index_meta_data
  • Changed HnswParams to accept a types.HnswParams class rather than a protobuf object.
  • Changed VectorDistanceMetric into a types.VectorDistanceMetric class rather than a protobuf object.
• [CLIENT-2876] - Added integration test suite using the pytest-aio framework
• [CLIENT-2874] - Changed public API's to require keyword arguments.
• [CLIENT-2880] - Removed types_pb2 from the public API. Instead, use the types module.
• [CLIENT-2872] - Changed index_drop to only return success when the index status can no longer be found on the server.
• [CLIENT-2913] - Changed wait_for_index_completion:
  • wait_interval decreased from 10 seconds to 1 second
  • improved heuristic for estimating index_completion
• [CLIENT-2914] - Methods returning protobuf types now return python native types.
  • protobuf objects with non PEP-8 compliant names are made PEP-8 compliant when translated to a python native type
• [CLIENT-2915] - Added __str__ magic method support for the following classes:
  • types.Key
  • types.RecordWithKey
  • types.Neighbor
• [CLIENT-2916] - Created API documentation
  • Available here: API documentation website
• [CLIENT-2917] - Created PyPI repository
  • Avaiable here: PyPI repository website