opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
75 stars 495 forks source link

[DOC] Correction to Binary Quantization #8769

Open shashankviswanadha opened 6 days ago

shashankviswanadha commented 6 days ago

What do you want to do?

Tell us about your request. Provide a summary of the request. In the last example in the section on Binary Quantization https://opensearch.org/docs/2.17/search-plugins/knn/knn-vector-quantization/#using-bq the field params should have been parameters. This is the corrected example that works on 2.17:

PUT my-vector-index
{
  "mappings": {
    "properties": {
      "my_vector_field": {
        "type": "knn_vector",
        "dimension": 8,
        "space_type": "l2",
        "data_type": "float",
        "mode": "on_disk",
        "compression_level": "16x",
        "method": {
            "params": {
                "ef_construction": 16
            }
        }
      }
    }
  }
}

Version: 2.17

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

Naarcha-AWS commented 2 days ago

@shashankviswanadha: Do you want to go ahead and submit a PR for this one?