Add docvalue_fields support documentation for knn_vector fields#12471
Conversation
navneet1v
requested review from
cwperks,
dlvenable,
epugh,
kolchfa-aws,
mgodwan,
peterzhuamazon and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
|
@kolchfa-aws can you please review the PR. |
kolchfa-aws
added
the
release-notes
|
@navneet1v Could you please address tech review comments first? I'll review after the tech review is finished. Thanks! |
navneet1v
force-pushed
the
main
branch
2 times, most recently
from
1465de8 to
ca3df4f
Compare
|
@vamshin resolved your comments. can you please review? |
Add documentation for retrieving knn_vector fields using docvalue_fields,
introduced in OpenSearch 3.7. This feature reads vectors directly from
doc values instead of _source, providing up to 2x throughput improvement
for JSON transport. Supports binary (base64, default) and array formats
across all k-NN engines, data types, and compression levels with no
reindexing required.
- Add "Retrieve vectors using doc values" section to performance tuning
- Add "Retrieving vector fields using docvalue_fields" section to
retrieve specific fields guide
- Update search API and gRPC search API references with knn_vector
format details
Signed-off-by: Navneet Verma <navneev@amazon.com>
|
@kolchfa-aws can you please review now? |
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
kolchfa-aws
left a comment
kolchfa-aws
left a comment
There was a problem hiding this comment.
Thank you, @navneet1v! Doc review complete and changes applied.
3 participants
Description
Add documentation for retrieving knn_vector fields using docvalue_fields,
introduced in OpenSearch 3.7. This feature reads vectors directly from
doc values instead of _source, providing up to 2x throughput improvement
for JSON transport. Supports binary (base64, default) and array formats
across all k-NN engines, data types, and compression levels with no
reindexing required.
Issues Resolved
opensearch-project/k-NN#3315
Version
3.7 and above
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.