Update the mmr doc for the new flag explain#12201
Update the mmr doc for the new flag explain#12201kolchfa-aws merged 4 commits intoopensearch-project:mainfrom
Conversation
Signed-off-by: Bo Zhang <bzhangam@amazon.com>
bzhangam
requested review from
cwperks,
dlvenable,
epugh,
kolchfa-aws,
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
added
Doc review
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, @bzhangam! Doc review complete. Please answer one question so we can provide all supported values for the parameter, and we'll be ready to merge.
| | `vector_field_path` | String | Optional (required for remote indexes) | The path to the vector field used for MMR reranking. If not provided, OpenSearch resolves it automatically from the search request. | | ||
| | `vector_field_data_type` | String | Optional (required for remote indexes) | The data type of the vector field. Used to parse the field and calculate similarity. If not provided, OpenSearch resolves it from the index mapping. | | ||
| | `vector_field_space_type` | String | Optional (required for remote indexes) | Used to determine the similarity function for the vector field, such as cosine similarity or Euclidean distance. If not provided, OpenSearch resolves it from the index mapping. | | ||
| | `vector_field_space_type` | String | Optional (required for remote indexes) | Used to determine the similarity function for the vector field, such as cosine similarity or Euclidean distance. If not provided, OpenSearch resolves it from the index mapping. | |
There was a problem hiding this comment.
Does this parameter support all values in this table? https://docs.opensearch.org/latest/mappings/supported-field-types/knn-spaces/#distance-calculation
There was a problem hiding this comment.
Yes. This is an existing parameter. For my change I just added the explain flag.
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2 participants
Description
Update the mmr doc for the new flag explain - feature commit
Issues Resolved
No existing issue. It's a small update
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.