Skip to content

DOC-12565 vector search concepts #325

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.

Sign up for GitHub

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

Merged
merged 43 commits into from
Sep 10, 2025
Merged

DOC-12565 vector search concepts #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
4745d2c
Adding initial rough draft
ggray-cb Oct 1, 2024
7201ce6
Interim checkin. Lots of work on the overview. Added a diagram. Added…
ggray-cb Oct 8, 2024
4d84c14
In-progress checkin.
ggray-cb Oct 10, 2024
fb75cd3
Working on examples. Moved some to their own example file.
ggray-cb Oct 11, 2024
1cbc687
Checkin current state of docs before vacation.
ggray-cb Oct 14, 2024
d9656c5
Misc fixes
ggray-cb Oct 14, 2024
0ea9113
In progress checkin:
ggray-cb Jan 13, 2025
643badc
Interim checkin. More edits. More diagrams
ggray-cb Jan 16, 2025
5dc1704
Adding code for several diagrams and a few diagrams hand-drawn in Ink…
ggray-cb Jan 22, 2025
92f6fe2
Added SQ diagram.
ggray-cb Jan 23, 2025
5a4b4d8
Added vector embedding diagram
ggray-cb Jan 23, 2025
91dc41f
Some last minute edits
ggray-cb Jan 24, 2025
dbe473d
Remove stray plus.
ggray-cb Jan 24, 2025
8d0a0bf
Updated that the distance function has to match the embedding.
ggray-cb Jan 24, 2025
9ab48d4
Adding some additional details based on the arguments we can pass int…
ggray-cb Jan 27, 2025
e4ea241
Few more clarifications and edits.
ggray-cb Jan 28, 2025
bc985ce
Complete revised rough draft
ggray-cb Jan 31, 2025
d65058e
Last-minute fixes
ggray-cb Jan 31, 2025
c96e55f
Edits based on Ankush's feedback.
ggray-cb Feb 26, 2025
d3c40e3
More or less complete draft after incorporqating Ankush's feedback an…
ggray-cb Mar 4, 2025
b74ae0b
Added cross-ref to new Vector index topic
ggray-cb Mar 4, 2025
7767a0c
Checking in update to antora.yml so branch acts like it's 8.0
ggray-cb Apr 7, 2025
1c34c78
Minor fixes
ggray-cb May 27, 2025
77ffce2
Fixing nav issue
ggray-cb May 30, 2025
863b417
Grammar edits.
ggray-cb Jun 2, 2025
2e3623e
Added local build config
ggray-cb Jun 11, 2025
c8b193e
Rough draft of the Hypervector demo done.
ggray-cb Jun 25, 2025
9481075
Added best practices draft
ggray-cb Jun 26, 2025
148fab9
Checkin before holday/vacation and sending out to reviewers.
ggray-cb Jul 2, 2025
80bbd8e
Adding anchor to quantization section
ggray-cb Jul 15, 2025
182f126
Various cleanups I missed before rushing off on vacation.
ggray-cb Jul 15, 2025
e45cede
Some updates based on Ankush's feedback. Went down a rabbithole on L2…
ggray-cb Jul 23, 2025
3c1ae6e
Interim checkin based on Ankush's feedback.
ggray-cb Jul 25, 2025
fd57070
Wrapped up Ankush's feedback. Also added section on determining recal…
ggray-cb Jul 29, 2025
2b2dc52
* Added in includes for the Capella UI create index instructions (I h…
ggray-cb Jul 29, 2025
3c30227
Minor edit
ggray-cb Jul 29, 2025
c456dea
Typo fix
ggray-cb Jul 29, 2025
13a187c
Typo fix in modules/vector-index/examples/find-reranking-cases.py
ggray-cb Aug 25, 2025
734e5fe
Merge branch 'DOC-12294-GSI-vector-index' into DOC-12565_vector_searc…
simon-dew Aug 26, 2025
35f16c1
Merge branch 'DOC-12294-GSI-vector-index' into DOC-12565_vector_searc…
simon-dew Aug 29, 2025
a3c9a2c
Wrapping us most of the textual changes from John, Simon, and Deppkar…
ggray-cb Sep 2, 2025
b97ae45
Bit more tidying up in the text.
ggray-cb Sep 3, 2025
ae86657
* Moved Python code to draw base of some diagrams to a source directo…
ggray-cb Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 69 additions & 69 deletions modules/search/partials/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,69 +1,69 @@
* xref:8.0@server:search:search.adoc[]
** xref:8.0@server:search:create-search-indexes.adoc[]
*** xref:8.0@server:search:create-search-index-ui.adoc[]
*** xref:8.0@server:search:create-search-index-rest-api.adoc[]
**** xref:8.0@server:search:search-index-params.adoc[]
*** xref:8.0@server:search:create-quick-index.adoc[]
**** xref:8.0@server:search:quick-index-field-options.adoc[]
**** xref:8.0@server:search:field-data-types-reference.adoc[]
**** xref:8.0@server:search:quick-index-supported-languages.adoc[]
**** xref:8.0@server:search:synonyms/synonyms-search-quick.adoc[]
***** xref:8.0@server:search:synonyms/create-synonym-collection-docs-quick.adoc[]
***** xref:8.0@server:search:synonyms/add-synonym-source-quick.adoc[]
*** xref:8.0@server:search:import-search-index.adoc[]
** xref:8.0@server:search:view-index-details.adoc[]
** xref:8.0@server:search:run-searches.adoc[]
*** xref:8.0@server:search:simple-search-ui.adoc[]
*** xref:8.0@server:search:geo-search-ui.adoc[]
*** xref:8.0@server:search:simple-search-rest-api.adoc[]
**** xref:8.0@server:search:search-request-params.adoc[]
**** xref:8.0@server:fts:fts-search-response.adoc[Search Response]
*** xref:8.0@server:search:geo-search-rest-api.adoc[]
** xref:8.0@server:search:search-query-auto-complete.adoc[]
*** xref:8.0@server:search:search-query-auto-complete-ui.adoc[]
*** xref:8.0@server:search:search-query-auto-complete-code.adoc[]
** xref:8.0@server:search:index-aliases.adoc[]
*** xref:8.0@server:search:create-search-index-alias.adoc[]
*** xref:8.0@server:search:create-search-index-alias-rest-api.adoc[]
** xref:8.0@server:search:customize-index.adoc[]
*** xref:8.0@server:search:set-type-identifier.adoc[]
*** xref:8.0@server:search:create-type-mapping.adoc[]
*** xref:8.0@server:search:create-child-field.adoc[]
**** xref:8.0@server:search:child-field-options-reference.adoc[]
*** xref:8.0@server:search:create-child-mapping.adoc[]
*** xref:8.0@server:search:create-xattrs-mapping.adoc[]
*** xref:8.0@server:search:create-custom-analyzer.adoc[]
*** xref:8.0@server:search:create-custom-character-filter.adoc[]
*** xref:8.0@server:search:create-custom-tokenizer.adoc[]
*** xref:8.0@server:search:create-custom-token-filter.adoc[]
*** xref:8.0@server:search:create-custom-wordlist.adoc[]
*** xref:8.0@server:search:create-custom-date-time-parser.adoc[]
*** xref:8.0@server:search:synonyms/synonyms-search.adoc[]
**** xref:8.0@server:search:synonyms/create-synonym-collection-docs.adoc[]
**** xref:8.0@server:search:synonyms/add-synonym-source.adoc[]
*** xref:8.0@server:search:set-advanced-settings.adoc[]
*** xref:8.0@server:search:default-analyzers-reference.adoc[]
*** xref:8.0@server:search:default-character-filters-reference.adoc[]
*** xref:8.0@server:search:default-date-time-parsers-reference.adoc[]
*** xref:8.0@server:search:default-token-filters-reference.adoc[]
*** xref:8.0@server:search:default-tokenizers-reference.adoc[]
*** xref:8.0@server:search:default-wordlists-reference.adoc[]
*** xref:8.0@server:search:field-data-types-reference.adoc[]
*** xref:8.0@server:search:date-time-parser-layout-styles.adoc[]
** xref:8.0@server:fts:fts-high-availability-for-search.adoc[High Availability for Search]
** xref:8.0@server:fts:fts-architecture.adoc[Search Service Architecture]
*** xref:8.0@server:fts:fts-architecture-scatter-gather.adoc[Scatter Gather]
*** xref:8.0@server:fts:fts-architecture-ports-used.adoc[Ports Used By FTS]
*** xref:8.0@server:fts:fts-rebalance-failover.adoc[Rebalance/Failover]
** xref:8.0@server:fts:fts-cluster-options.adoc[Cluster Level Options]
*** xref:8.0@server:fts:fts-advanced-settings-bleveMaxResultWindow.adoc[bleveMaxResultWindow]
*** xref:8.0@server:fts:fts-advanced-settings-bleveMaxClauseCount.adoc[bleveMaxClauseCount]
*** xref:8.0@server:fts:fts-advanced-settings-maxFeedsPerDCPAgent.adoc[maxFeedsPerDCPAgent]
*** xref:8.0@server:fts:fts-advance-settings-maxConcurrentPartitionMovesPerNode.adoc[maxConcurrentPartitionMovesPerNode]
*** xref:8.0@server:fts:fts-advanced-settings-enableVerboseLogging.adoc[enableVerboseLogging]
*** xref:8.0@server:fts:fts-advanced-settings-ftsMemoryQuota.adoc[ftsMemoryQuota]
*** xref:8.0@server:fts:fts-advanced-settings-maxReplicasAllowed.adoc[maxReplicasAllowed]
*** xref:8.0@server:fts:fts-advanced-settings-slowQueryLogTimeout.adoc[slowQueryLogTimeout]
*** xref:8.0@server:fts:fts-advanced-settings-CBFT-ENV-OPTIONS.adoc[CBFT_ENV_OPTIONS]
** xref:8.0@server:fts:fts-monitor.adoc[Statistics and Monitoring]
** xref:8.0@server:fts:fts-troubleshooting.adoc[Troubleshooting and FAQs]
* xref:search:search.adoc[]
** xref:search:create-search-indexes.adoc[]
*** xref:search:create-search-index-ui.adoc[]
*** xref:search:create-search-index-rest-api.adoc[]
**** xref:search:search-index-params.adoc[]
*** xref:search:create-quick-index.adoc[]
**** xref:search:quick-index-field-options.adoc[]
**** xref:search:field-data-types-reference.adoc[]
**** xref:search:quick-index-supported-languages.adoc[]
**** xref:search:synonyms/synonyms-search-quick.adoc[]
***** xref:search:synonyms/create-synonym-collection-docs-quick.adoc[]
***** xref:search:synonyms/add-synonym-source-quick.adoc[]
*** xref:search:import-search-index.adoc[]
** xref:search:view-index-details.adoc[]
** xref:search:run-searches.adoc[]
*** xref:search:simple-search-ui.adoc[]
*** xref:search:geo-search-ui.adoc[]
*** xref:search:simple-search-rest-api.adoc[]
**** xref:search:search-request-params.adoc[]
**** xref:fts:fts-search-response.adoc[Search Response]
*** xref:search:geo-search-rest-api.adoc[]
** xref:search:search-query-auto-complete.adoc[]
*** xref:search:search-query-auto-complete-ui.adoc[]
*** xref:search:search-query-auto-complete-code.adoc[]
** xref:search:index-aliases.adoc[]
*** xref:search:create-search-index-alias.adoc[]
*** xref:search:create-search-index-alias-rest-api.adoc[]
** xref:search:customize-index.adoc[]
*** xref:search:set-type-identifier.adoc[]
*** xref:search:create-type-mapping.adoc[]
*** xref:search:create-child-field.adoc[]
**** xref:search:child-field-options-reference.adoc[]
*** xref:search:create-child-mapping.adoc[]
*** xref:search:create-xattrs-mapping.adoc[]
*** xref:search:create-custom-analyzer.adoc[]
*** xref:search:create-custom-character-filter.adoc[]
*** xref:search:create-custom-tokenizer.adoc[]
*** xref:search:create-custom-token-filter.adoc[]
*** xref:search:create-custom-wordlist.adoc[]
*** xref:search:create-custom-date-time-parser.adoc[]
*** xref:search:synonyms/synonyms-search.adoc[]
**** xref:search:synonyms/create-synonym-collection-docs.adoc[]
**** xref:search:synonyms/add-synonym-source.adoc[]
*** xref:search:set-advanced-settings.adoc[]
*** xref:search:default-analyzers-reference.adoc[]
*** xref:search:default-character-filters-reference.adoc[]
*** xref:search:default-date-time-parsers-reference.adoc[]
*** xref:search:default-token-filters-reference.adoc[]
*** xref:search:default-tokenizers-reference.adoc[]
*** xref:search:default-wordlists-reference.adoc[]
*** xref:search:field-data-types-reference.adoc[]
*** xref:search:date-time-parser-layout-styles.adoc[]
** xref:fts:fts-high-availability-for-search.adoc[High Availability for Search]
** xref:fts:fts-architecture.adoc[Search Service Architecture]
*** xref:fts:fts-architecture-scatter-gather.adoc[Scatter Gather]
*** xref:fts:fts-architecture-ports-used.adoc[Ports Used By FTS]
*** xref:fts:fts-rebalance-failover.adoc[Rebalance/Failover]
** xref:fts:fts-cluster-options.adoc[Cluster Level Options]
*** xref:fts:fts-advanced-settings-bleveMaxResultWindow.adoc[bleveMaxResultWindow]
*** xref:fts:fts-advanced-settings-bleveMaxClauseCount.adoc[bleveMaxClauseCount]
*** xref:fts:fts-advanced-settings-maxFeedsPerDCPAgent.adoc[maxFeedsPerDCPAgent]
*** xref:fts:fts-advance-settings-maxConcurrentPartitionMovesPerNode.adoc[maxConcurrentPartitionMovesPerNode]
*** xref:fts:fts-advanced-settings-enableVerboseLogging.adoc[enableVerboseLogging]
*** xref:fts:fts-advanced-settings-ftsMemoryQuota.adoc[ftsMemoryQuota]
*** xref:fts:fts-advanced-settings-maxReplicasAllowed.adoc[maxReplicasAllowed]
*** xref:fts:fts-advanced-settings-slowQueryLogTimeout.adoc[slowQueryLogTimeout]
*** xref:fts:fts-advanced-settings-CBFT-ENV-OPTIONS.adoc[CBFT_ENV_OPTIONS]
** xref:fts:fts-monitor.adoc[Statistics and Monitoring]
** xref:fts:fts-troubleshooting.adoc[Troubleshooting and FAQs]
Loading