aruggero opened a new pull request, #5246: URL: https://github.com/apache/solr/pull/5246
# Description There were some stale, incorrect, incomplete points in the vector search documentation. # Solution Fixed the following points in the vector search field type documentation: 1. Fixed the statement on the usage of the `similarityFunction` for `BinaryQuantizedDenseVectorField`. It actually uses this parameter. [Here is the commit](https://github.com/apache/solr/commit/9aba6f041b110d9dd01fa95ec5a1428acdaac237). 2. Clearly declared the range limit for `hnswM` and `hnswEfConstruction` (no "any integer"). Moved the `buildKnnVectorsFormat()` check in org.apache.solr.schema.DenseVectorField#checkSchemaField to fail at schema loading instead of during indexing. [Here is the commit](https://github.com/apache/solr/commit/884f3480d9bd694dfc849181c607e95142f01e52). Changed the error message from Lucene to correctly reflect the Solr parameters' names. [Here is the commit](https://github.com/apache/solr/commit/db5bfeb8c1cbc964f3f8c4fa401d569f3f469ba9). Also moved the test to the right class. Binary and Scalar now inherit this behavior. [Here is the commit](https://github.com/apache/solr/commit/8546bc28d89058b39c46003de0d4680bd383ce29). 3. Added `cuvs codec factory` to the Codec Factory page since it was missing. [Here is the commit](https://github.com/apache/solr/commit/714912c64de4576c4d27d297d7e34e02cb9db547). 4. Clearly declared that values over 1024 for the `vectorDimension` are supported only with the `SchemaCodecFactory` and raise a warning. [Here is the commit](https://github.com/apache/solr/commit/261a0b6327d84798c378cc7d130603703a2a5e36). 5. Added `maximum_inner_product` as a supported value for `similarityFunction` since it is present in Lucene. [Here is the commit](https://github.com/apache/solr/commit/56c3ff885d9f39958111db22d3c0353a0f6e689f). 6. Specified that Binary Quantization only works with the `SchemaCodecFactory`. [Here is the commit](https://github.com/apache/solr/commit/e485acc434d82a73362aa002136ad281f3faa63b). 7. Added 1,2,8 as supported values for `bits`. These are now present in Lucene. [Here is the commit](https://github.com/apache/solr/commit/3c8dda1b367b447bda6d3d97c043500357101640#diff-ce7a1dd6eebeef96cd0395687bbf7f1c6a1565536df43ae6d2b38ed5de10e7f5). **Lucene default is now 8 bits, should we also update this in Solr?** 8. Specified that Binary Quantization only works with `FLOAT32` vectors. [Here is the commit](https://github.com/apache/solr/commit/92239b82ee7dbe544e17831dbd8046fef4b12388). 9. Specified that a vector field can only be copied into another `DenseVectorField`. [Here is the commit](https://github.com/apache/solr/commit/4f041fb187b11797c1d1bcaace287c391d0e2455). 10. Added `BinaryQuantizedDenseVectorField` and `ScalarQuantizedDenseVectorField` to the "Field Types included with Solr" page. Also specified that a dense vector field can contain byte elements. [Here is the commit](https://github.com/apache/solr/commit/2c82f82c47773ce76c63ae82e0b2663508fc0ac2). AI has been used as support for this contribution, but everything has been manually reviewed by me. # Tests Added tests for points 2 and 7 of the Solution. # Checklist Please review the following and check all that apply: - [X] I have reviewed the guidelines for [How to Contribute](https://github.com/apache/solr/blob/main/CONTRIBUTING.md) and my code conforms to the standards described there to the best of my ability. - [ ] I have created a Jira issue and added the issue ID to my pull request title. - [X] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation) - [X] I have developed this patch against the `main` branch. - [X] I have run `./gradlew check`. - [X] I have added tests for my changes. - [X] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide) - [ ] I have added a [changelog entry](https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc) for my change -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
