Release Note

This release contains 4 new features, 0 performance improvements, 5 bug fixes and 3 Documentation improvements.

It is recommended to upgrade to this version as it contains security updates.

💥 Security Updates

🆕 Features

Save and load inmemory index (#1534)

We added a persist method to the InMemoryExactNNIndex class to save the index to disk.

# Save your existing index as a binary file
doc_index.persist('docs.bin')
# Initialize a new document index using the saved binary file
new_doc_index = InMemoryExactNNIndex[MyDoc](index_file_path='docs.bin')

Subindex for Document index (#1428)

Openapi tensor shapes (#1510)

We enabled shaped tensors to be properly represented in OpenAPI/SwaggerUI, both in examples and in the schema.

🐞 Bug Fixes

search_field should be optional in hybrid text search (#1516)

We added a sane default to text_search() for the search_field argument that is now Optional.

Check if filepath exists for inmemory index (#1537)

We added an internal check to see if index_file_path exists when passed to InMemoryExactNNIndex.

Add empty judgement to index search (#1533)

We made sure that empty indices do not fail when find is called.

Detach the torch tensors (#1526)

Serializing tensors with gradients does not fail anymore.

Docvec display (#1522)

Docvec display issues are resolved.

Docs link (#1518)

Documentation links are corrected.

• The bug was causing [explain what the bug was causing].
• The new version fixes the bug and [explain what the new version does].

📗 Documentation Improvements

• Remove wrong info (docs(store_jac): remove wrong info #1531)
• Fix link to Documentation in readme (docs: fix link to documentation in readme #1525)
• Flatten structure (docs: flatten structure #1520)

🤟 Contributors

We would like to thank all contributors to this release:

• Mohammad Kalim Akram (@makram93)
• Johannes Messner (@JohannesMessner)
• Anne Yang (@AnneYang720)
• Zhaofeng Miao (@mapleeit)
• Joan Fontanals (@JoanFM)
• Kacper Łukawski (@kacperlukawski)
• IyadhKhalfallah (@IyadhKhalfallah)
• Saba Sturua (@jupyterjazz)