Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Correction to Binary Quantization #8769

Open
1 of 4 tasks
shashankviswanadha opened this issue Nov 15, 2024 · 2 comments
Open
1 of 4 tasks

[DOC] Correction to Binary Quantization #8769

shashankviswanadha opened this issue Nov 15, 2024 · 2 comments
Assignees
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR.

Comments

@shashankviswanadha
Copy link

shashankviswanadha commented Nov 15, 2024

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

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 Naarcha-AWS added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. and removed untriaged labels Nov 19, 2024
@Naarcha-AWS
Copy link
Collaborator

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

@shashankviswanadha
Copy link
Author

@Naarcha-AWS Sure,
#8985

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR.
Projects
None yet
Development

No branches or pull requests

2 participants