docs: added opensearch-jvector plugin docs by kush992 · Pull Request #12866 · opensearch-project/documentation-website

kush992 · 2026-07-28T11:48:56Z

Description

Added opensearch-jvector plugin documentation.

Issues Resolved

Closes #[Replace this text, including the brackets, with the issue number. Leave "Closes #" so the issue is closed properly.]

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.

3.5 and above

Frontend features

opensearch-jvector_plugin_doc.mp4

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

github-actions · 2026-07-28T11:49:04Z

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).

--------- Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com> Co-authored-by: Kush Bhalodi <kush.bhalodi@ibm.com>

Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com>

kolchfa-aws

Thank you, @kush992! A couple of clarifying questions for you before I start rewriting.

kolchfa-aws · 2026-08-20T19:28:30Z

+| **Vector engines**       | `Nmslib`, `Faiss`, `lucene`              | `jvector` (primary), `lucene`                                             |
+| **Concurrent ingestion** | Supported by some vector engines         | `jvector` supports concurrent inserts, enabling high-throughput ingestion |
+| **Index update cost**    | Usually a full rebuild required on merge | Incremental merges — no full rebuilds for updates                         |
+| **Memory efficiency**    | In-memory indexing                       | DiskANN-style quantization                                                |


Is this line accurate? k-NN plugin supports disk-based vector search with binary quantization (on_disk mode) https://docs.opensearch.org/latest/vector-search/optimizing-storage/disk-based-vector-search/

This should be re-phrased. On opensearch-jvector, it is: diskAnn-style vector search with PQ (product quantization)

kolchfa-aws · 2026-08-20T19:36:58Z

+- **Incremental Index Updates** - `jvector` allows incremental insertion of vectors into existing indexes. This providing efficiency gains over full index rebuilds for workloads involving frequent updates, particularly for large graph-based indexes.
+- **Quantized DiskANN with Reranking** - `jvector` supports DiskANN-style quantization combined with reranking, delivering significant performance improvements for datasets larger than available memory. This approach is particularly effective for large-scale deployments where traditional in-memory indexing is not feasible.
+- **Product Quantization (PQ)** - PQ is implemented with high-performance SIMD optimizations and separate codebooks to enable fast vector searches with low memory usage.
+- **Advanced Quantization Techniques** - `jvector` includes advanced capabilities such as Non-Vector Quantization (NVQ), and Anisotropic PQ, enabling more efficient and accurate similarity computations beyond standard quantization approaches.


Does NVQ stand for non-uniform vector quantization and not non-vector quantization?

Thanks @kolchfa-aws . Good catch. I missed this. It should be non-uniform vector quantization.
Here is the source: https://arxiv.org/pdf/2509.18471

Yes, it should be Non-Uniform Vector Quantization (as per the feature proposal). Change is coming right away

kolchfa-aws · 2026-08-20T19:38:41Z

+bin/opensearch-plugin install opensearch-jvector
+```
+
+## OpenSearch compatible features


Does this mean k-NN features that jVector supports?

Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws

Thank you, @kush992! Doc review complete - I pushed my changes into your PR. Please review my changes and see my outstanding questions. Thank you!

kolchfa-aws · 2026-08-21T16:19:43Z

+
+Repeat the following steps on every node in the cluster:
+
+1. Stop OpenSearch on the node.


@kush992 Installing the plugin by name only didn't work for me. These are the steps that worked (installing from Maven Central, as specified in the plugin repo user guide). If you have any suggestions for these steps, please let me know.

Unfortunately, I was not able to have it done for 3.8.0 (see please opensearch-project/opensearch-build#6251), so we would need to follow this guide [1] (the plugin is published in Maven [2]):

bin/opensearch-plugin install org.opensearch.plugin:opensearch-jvector-plugin:3.8.0.0

@kush992 could you please update the instructions? thank you

[1] https://docs.opensearch.org/latest/install-and-configure/plugins/#core-plugins
[2] https://repo1.maven.org/maven2/org/opensearch/plugin/opensearch-jvector-plugin/

Thank you, @reta! Updated the steps in a new commit.

kolchfa-aws · 2026-08-21T16:21:48Z

+
+The `disk_ann` method supports the following parameters.
+
+Parameter name | Default | Description


This table doesn't have the "Required" and "Updatable" columns, as do the other parameter tables. Should we add these here?

All these values are 'updateable'.
If they're not set, they get set to the 'default' values. I'm not sure if these columns would help here.

The only place where 'required' is helpful would be in the table above this for 'disk_ann' property.

I added a sentence about them being optional. This assumes they get default values. The Supported methods table, which has Requires training, not Required, doesn't map onto an obvious edit. And I believe "Updatable" in the other tables refers to "can be changed after creating an index", so maybe we should add an "Updatable" column?

@kolchfa-aws - sorry, responded to this on slack with suggestions. Kush made changes to the PR before it got merged, so we should be good

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws

Thanks for making the updates, @kush992! LGTM

* docs: added opensearch-jvector plugin docs --------- * chore: corrected name in opensearch-jvector docs * docs: rephrased plugin installation * docs: updated dead link in performance-tuning * fix: typos in opensearch-jvector document * Doc review * Address comments * docs: added updatable and required columns for disk ann params * Update column name and add defaults for num pq spaces --------- (cherry picked from commit 0ca6d3b) Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: opensearch-ci-bot <opensearch-infra@amazon.com> Co-authored-by: Kush <85061303+kush992@users.noreply.github.com> Co-authored-by: Kush Bhalodi <kush.bhalodi@ibm.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>

github-actions Bot added the In progress Issue/PR: The issue or PR is in progress. label Jul 28, 2026

github-actions Bot assigned kolchfa-aws Jul 28, 2026

reta reviewed Jul 28, 2026

View reviewed changes

Comment thread _install-and-configure/additional-plugins/opensearch-jvector.md Outdated

kush992 marked this pull request as ready for review July 28, 2026 15:53

kush992 requested review from cwperks, dlvenable, epugh, kolchfa-aws, mgodwan, peterzhuamazon and sumobrian as code owners July 28, 2026 15:53

github-actions Bot added Tech review PR: Tech review in progress and removed In progress Issue/PR: The issue or PR is in progress. labels Jul 28, 2026

kolchfa-aws added release-notes PR: Include this PR in the automated release notes v3.8.0 labels Jul 30, 2026

kolchfa-aws reviewed Aug 2, 2026

View reviewed changes

Comment thread _install-and-configure/additional-plugins/index.md Outdated

kolchfa-aws added Awaiting response backport 3.7 backport 3.8 and removed release-notes PR: Include this PR in the automated release notes Awaiting response v3.8.0 backport 3.7 labels Aug 2, 2026

akash-shankaran reviewed Aug 6, 2026

View reviewed changes

Comment thread _mappings/supported-field-types/knn-methods-engines.md Outdated

kush992 and others added 4 commits August 13, 2026 16:00

docs: added opensearch-jvector plugin docs

8a5c121

--------- Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com> Co-authored-by: Kush Bhalodi <kush.bhalodi@ibm.com>

chore: corrected name in opensearch-jvector docs

81b7977

Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com>

docs: rephrased plugin installation

54fe136

Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com>

docs: updated dead link in performance-tuning

dd76baf

Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com>

kush992 force-pushed the opensearch-jvector-plugin-docs branch from 30b2a74 to dd76baf Compare August 13, 2026 14:01

kush992 requested a review from kolchfa-aws August 13, 2026 14:06

reta reviewed Aug 20, 2026

View reviewed changes

Comment thread _install-and-configure/additional-plugins/opensearch-jvector.md Outdated

akash-shankaran approved these changes Aug 20, 2026

View reviewed changes

reta approved these changes Aug 20, 2026

View reviewed changes

kolchfa-aws reviewed Aug 20, 2026

View reviewed changes

kolchfa-aws added Doc review PR: Doc review in progress Awaiting response and removed Tech review PR: Tech review in progress labels Aug 20, 2026

kush992 and others added 2 commits August 21, 2026 10:41

fix: typos in opensearch-jvector document

828b9f9

Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com>

Doc review

7e3d8d7

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws reviewed Aug 21, 2026

View reviewed changes

kolchfa-aws and others added 3 commits August 25, 2026 09:48

Address comments

d126919

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

docs: added updatable and required columns for disk ann params

8038fb3

Signed-off-by: Kush Bhalodi <kush.bhalodi@ibm.com>

Update column name and add defaults for num pq spaces

81ab170

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws approved these changes Aug 26, 2026

View reviewed changes

kolchfa-aws merged commit 0ca6d3b into opensearch-project:main Aug 26, 2026
4 checks passed

kolchfa-aws removed the Awaiting response label Aug 26, 2026

opensearch-ci-bot mentioned this pull request Aug 26, 2026

[Backport 3.8] docs: added opensearch-jvector plugin docs #12983

Merged

kush992 mentioned this pull request Aug 26, 2026

[DOCUMENTATION] Add the plugin documentation to OpenSearch official docs opensearch-project/opensearch-jvector#519

Closed


		Repeat the following steps on every node in the cluster:

		1. Stop OpenSearch on the node.


		The `disk_ann` method supports the following parameters.

		Parameter name \| Default \| Description

Uh oh!

Conversation

kush992 commented Jul 28, 2026 • edited by kolchfa-aws Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Version

Frontend features

Checklist

Uh oh!

github-actions Bot commented Jul 28, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kolchfa-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

akash-shankaran Aug 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kolchfa-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reta Aug 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kolchfa-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kush992 commented Jul 28, 2026 •

edited by kolchfa-aws

Loading

akash-shankaran Aug 20, 2026 •

edited

Loading

reta Aug 24, 2026 •

edited

Loading