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

Add "query_response_hit_ids" to query.request schema #33

Open
epugh opened this issue Dec 5, 2024 · 0 comments
Open

Add "query_response_hit_ids" to query.request schema #33

epugh opened this issue Dec 5, 2024 · 0 comments
Labels
RFC Request for Comment

Comments

@epugh
Copy link
Member

epugh commented Dec 5, 2024

Currently, behind the covers, the OS UBI plugin tracks when you make a query request all the document id's that have been matched for the query that will be sent to the user. We store this like:

image

This is from the OpenSearch ubi_queries index!

However, when we wrote the pure JavaScript client, ubi.js, we did not implement that because those two fields are not in the query.request.schema.json. Indeed, it tracks slightly different:

image

Also from OpenSearch ubi_queries index.

So, one more wrinkle. Our mappings and demo dashboards all use "query_response_hit_ids" instead of "query_response_object_ids", as it's highlighting these are hits from the query. To get things aligned, we are going to use that terminology everywhere.

This would an optional property....

@epugh epugh added the RFC Request for Comment label Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFC Request for Comment
Projects
None yet
Development

No branches or pull requests

1 participant