Adds near-real-time knn parameter and vectordb_document index mode to conceptual docs - #7685
Adds near-real-time knn parameter and vectordb_document index mode to conceptual docs#7685kosabogi wants to merge 4 commits into
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
🔍 Preview links for changed docs |
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
kosabogi
changed the title
There was a problem hiding this comment.
This section duplicates the parameter reference (true/false behavior, defaults, code example). Consider focusing on when and why in the introduction — the reference page already covers the what.
nit: I noticed that the same background process is described three different ways across this section: "prepared for search" , "optimizing" , and "preparing" . I'd suggest naming it once up front and reusing it consistently. I'd lean towards "optimize" as the consistent term.
For example:
Use the `near_real_time` parameter in the top-level `knn` object to control whether approximate kNN search includes vectors that have not yet been optimized for search.
We need to ensure cross-links with the index mode reference page too.
|
|
||
| ### Near-real-time kNN [near-real-time-knn] | ||
| ```{applies_to} | ||
| stack: ga 9.5 |
There was a problem hiding this comment.
does it merit an explanation why this isn't tagged for serverless?
There was a problem hiding this comment.
As far as I know, our convention is to call out deployment types and version availability only when they differ from what is stated at the top of the main page.
Since Serverless is already listed as supported on this page, I don’t think we need to mention it again here. Otherwise, we would probably need to add the same callout in other sections as well.
For example, this section is specifically tagged as Serverless: unavailable, so my understanding is that only exceptions like this need a Serverless tag.
There was a problem hiding this comment.
true! and I've been following this myself, but for some reason my brain thought otherwise when reviewing 😄
not for this PR, but I don't think all docs have been taking the same approach 😢 (I think this is because the reader experience is slightly confusing about the cascading nature from page-level)
Thanks for your review, @leemthompo !
|
2 participants
DO NOT MERGE BEFORE THE 9.5 RELEASE
Summary
This PR adds documentation for the
vectordb_documentindex mode andnear-real-timeknn parameter that will be introduced in the 9.5 release.Generative AI disclosure
Cursor agents