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] knn-index space-type parameter docs don't match functionality #8540

Open
2 tasks
SohaibKatariwala opened this issue Oct 15, 2024 · 0 comments
Open
2 tasks
Labels
1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. Sev2 High-medium priority. Upcoming release or incorrect information.

Comments

@SohaibKatariwala
Copy link

What do you want to do?
To create a knn-index I'm trying to specify space-type inside the top level of the mapping like in this example from the docs:
PUT /test-index { "settings": { "index": { "knn": true } }, "mappings": { "properties": { "my_vector1": { "type": "knn_vector", "dimension": 3, "space_type": "l2", "method": { "name": "hnsw", "engine": "lucene", "parameters": { "ef_construction": 128, "m": 24 } } } } } }

This fails with the error: "unknown parameter [space_type] on mapper [my_vector1] of type [knn_vector]". (on v2.15 and v2.13 at least)

This documentation says "Note: This value can also be specified at the top level of the mapping."

Either this is a bug in OpenSearch or the documentation is wrong.

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

*Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
v2.13 and v2.15

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

@Naarcha-AWS Naarcha-AWS added 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. Sev2 High-medium priority. Upcoming release or incorrect information. and removed untriaged labels Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. Sev2 High-medium priority. Upcoming release or incorrect information.
Projects
None yet
Development

No branches or pull requests

2 participants