Commit Graph

43 Commits

Author SHA1 Message Date
Caroline 5d2deede9e
Update vector size in Approximate KNN doc (#3515)
* Updated vector size.

Signed-off-by: carolxob <carolxob@amazon.com>

* Incorporated feedback.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor update.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits for accuracy and clarity.

Signed-off-by: carolxob <carolxob@amazon.com>

* Update _search-plugins/knn/approximate-knn.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: carolxob <carolxob@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2023-03-20 10:34:21 -06:00
kolchfa-aws 0f44dc3a9e
Remove GPU reference from approximate k-NN (#3263)
* Remove GPU reference from approximate k-NN

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Incorporated tech review feedback

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-03-16 11:50:23 -04:00
kolchfa-aws 492c9ec732
Add reference to hybrid mmap extensions setting in k-NN (#3262)
* Add reference to hybrid mmap extensions setting in k-NN

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Removed extra line

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Reworded based on tech review

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _search-plugins/knn/performance-tuning.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-03-16 11:48:24 -04:00
Yi-Lin Tsai a2f3890754
format JSON. (#2870) 2023-02-23 10:36:45 -06:00
kolchfa-aws 3da7598c0c
Change sample to example (#2972)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-02-20 11:34:20 -05:00
kolchfa-aws 5abc22147c
Refactor the Query DSL section (#2904)
* for query dsl index page rewrites for proper index page

Signed-off-by: alicejw <alicejw@amazon.com>

* fix formatting in table

Signed-off-by: alicejw <alicejw@amazon.com>

* update query table intro

Signed-off-by: alicejw <alicejw@amazon.com>

* rmv proprietary from overview

Signed-off-by: alicejw <alicejw@amazon.com>

* awkward sentence fix

Signed-off-by: alicejw <alicejw@amazon.com>

* to add list of all query categories

Signed-off-by: alicejw <alicejw@amazon.com>

* for query category descriptions

Signed-off-by: alicejw <alicejw@amazon.com>

* remove commented note

Signed-off-by: alicejw <alicejw@amazon.com>

* update term-level query page

Signed-off-by: alicejw <alicejw@amazon.com>

* for clarity about term and full-text query use cases

Signed-off-by: alicejw <alicejw@amazon.com>

* for parallel bullet list of queries

Signed-off-by: alicejw <alicejw@amazon.com>

* remove redundant word

Signed-off-by: alicejw <alicejw@amazon.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/term.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/term.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* for tech review feedback

Signed-off-by: alicejw <alicejw@amazon.com>

* for entire list of query types we support, even though we don't have document topic pages for them yet.

Signed-off-by: alicejw <alicejw@amazon.com>

* to include full list of query types we support

Signed-off-by: alicejw <alicejw@amazon.com>

* change Boolean to  type for consistency in the section

Signed-off-by: alicejw <alicejw@amazon.com>

* update query type category list title

Signed-off-by: alicejw <alicejw@amazon.com>

* for compound query type definitions

Signed-off-by: alicejw <alicejw@amazon.com>

* for additional descriptions

Signed-off-by: alicejw <alicejw@amazon.com>

* for query context descriptions

Signed-off-by: alicejw <alicejw@amazon.com>

* for additional edits to query descriptions list

Signed-off-by: alicejw <alicejw@amazon.com>

* create span query category page and update bullet list on index to cross-reference to it.

Signed-off-by: alicejw <alicejw@amazon.com>

* add pages for geo and shape query category, and add cross-references

Signed-off-by: alicejw <alicejw@amazon.com>

* remove regex it is part of term-level queries

Signed-off-by: alicejw <alicejw@amazon.com>

* for bullet list granular edits

Signed-off-by: alicejw <alicejw@amazon.com>

* put bullet list in alphabetical order

Signed-off-by: alicejw <alicejw@amazon.com>

* for doc review updates

Signed-off-by: alicejw <alicejw@amazon.com>

* reword for reviewer feedback

Signed-off-by: alicejw <alicejw@amazon.com>

* small rewording

Signed-off-by: alicejw <alicejw@amazon.com>

* typo space

Signed-off-by: alicejw <alicejw@amazon.com>

* put topics in alphabetical order in left nav

Signed-off-by: alicejw <alicejw@amazon.com>

* additional reviewer's comment

Signed-off-by: alicejw <alicejw@amazon.com>

* for second doc reviewer's feedback updates

Signed-off-by: alicejw <alicejw@amazon.com>

* for doc reviewer comment that was hidden

Signed-off-by: alicejw <alicejw@amazon.com>

* Update _opensearch/query-dsl/geo-and-shape.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/span-query.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/span-query.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/term.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* updates from third doc review for tech accuracy requested by editorial

Signed-off-by: alicejw <alicejw@amazon.com>

* create compound query sub-page to move descriptions to make bullet list parallel

Signed-off-by: alicejw <alicejw@amazon.com>

* fix compound query page title

Signed-off-by: alicejw <alicejw@amazon.com>

* add fuzzy query definition

Signed-off-by: alicejw <alicejw@amazon.com>

* for editorial feedback updates

Signed-off-by: alicejw <alicejw@amazon.com>

* Update _opensearch/query-dsl/term.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Refactor Query DSL section

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds doc review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix typo

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Changed periods to colons when introducing code blocks

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: alicejw <alicejw@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: alicejw <alicejw@amazon.com>
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
2023-02-15 17:12:50 -05:00
Mauricio Scheffer 2320a4b281
Fix description of cosinesimil distance function (#2214)
Signed-off-by: Mauricio Scheffer <mauricioscheffer@gmail.com>

Signed-off-by: Mauricio Scheffer <mauricioscheffer@gmail.com>
2022-12-16 13:22:32 -06:00
Alice Williams 253ae34bd8
Search with k-NN filters (#1814)
* new file for knn filter searches

Signed-off-by: alicejw <alicejw@amazon.com>

* for knn filter queries

Signed-off-by: alicejw <alicejw@amazon.com>

* more details and include graphic

Signed-off-by: alicejw <alicejw@amazon.com>

* add graph of filtered doc set

Signed-off-by: alicejw <alicejw@amazon.com>

* add release label

Signed-off-by: alicejw <alicejw@amazon.com>

* filters are defined by Query DSL

Signed-off-by: alicejw <alicejw@amazon.com>

* more details about how the algorithm works and how to specify lucene as the search engine

Signed-off-by: alicejw <alicejw@amazon.com>

* more refining sentences

Signed-off-by: alicejw <alicejw@amazon.com>

* for response samples

Signed-off-by: alicejw <alicejw@amazon.com>

* reorg heading levels

Signed-off-by: alicejw <alicejw@amazon.com>

* more rewrites for clarity

Signed-off-by: alicejw <alicejw@amazon.com>

* to add the complex filter query

Signed-off-by: alicejw <alicejw@amazon.com>

* update response for complex query

Signed-off-by: alicejw <alicejw@amazon.com>

* for typo

Signed-off-by: alicejw <alicejw@amazon.com>

* for rewrites to overview

Signed-off-by: alicejw <alicejw@amazon.com>

* to add better request/response for the complex filter example

Signed-off-by: alicejw <alicejw@amazon.com>

* for eng review update

Signed-off-by: alicejw <alicejw@amazon.com>

* format fix for example

Signed-off-by: alicejw <alicejw@amazon.com>

* for filter selectiveness use case section

Signed-off-by: alicejw <alicejw@amazon.com>

* for new workflow diagram and description

Signed-off-by: alicejw <alicejw@amazon.com>

* update section headings

Signed-off-by: alicejw <alicejw@amazon.com>

* add image for algorithm workflow diagram

Signed-off-by: alicejw <alicejw@amazon.com>

* reorg sections to make more concise

Signed-off-by: alicejw <alicejw@amazon.com>

* explain selectiveness percentage

Signed-off-by: alicejw <alicejw@amazon.com>

* more rewrites to complex query description

Signed-off-by: alicejw <alicejw@amazon.com>

* define complex query

Signed-off-by: alicejw <alicejw@amazon.com>

* more rewrites

Signed-off-by: alicejw <alicejw@amazon.com>

* for tech review feedback and add new information

Signed-off-by: alicejw <alicejw@amazon.com>

* to blend new Boolean query example into filter approaches section

Signed-off-by: alicejw <alicejw@amazon.com>

* for complex query description clarity

Signed-off-by: alicejw <alicejw@amazon.com>

* more rewrites

Signed-off-by: alicejw <alicejw@amazon.com>

* typo

Signed-off-by: alicejw <alicejw@amazon.com>

* eng review updates

Signed-off-by: alicejw <alicejw@amazon.com>

* nit for grammar

Signed-off-by: alicejw <alicejw@amazon.com>

* to fix incorrect descriptions of restrictive filters

Signed-off-by: alicejw <alicejw@amazon.com>

* to fix incorrect descriptions of restrictive filters

Signed-off-by: alicejw <alicejw@amazon.com>

* for doc review feedback updates

Signed-off-by: alicejw <alicejw@amazon.com>

* minor grammar change

Signed-off-by: alicejw <alicejw@amazon.com>

* removed figure and table titles, per AWS Style Guide

Signed-off-by: alicejw <alicejw@amazon.com>

* remove table title per style guide

Signed-off-by: alicejw <alicejw@amazon.com>

* update nav orders for all pages to give space for new topics in multiples of 5, and add links to other knn topics where appropriate

Signed-off-by: alicejw <alicejw@amazon.com>

* small rewrite

Signed-off-by: alicejw <alicejw@amazon.com>

* for second doc review comments

Signed-off-by: alicejw <alicejw@amazon.com>

* Update _search-plugins/knn/filter-search-knn.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _search-plugins/knn/filter-search-knn.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* for editorial review updates

Signed-off-by: alicejw <alicejw@amazon.com>

* for editorial review updates

Signed-off-by: alicejw <alicejw@amazon.com>

* fix cross-ref link

Signed-off-by: alicejw <alicejw@amazon.com>

* fix undone commit suggestions

Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
2022-11-11 11:23:45 -08:00
kolchfa-aws 2c7494309a
Fixed KNN search formulas (#1447)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-10-05 16:40:50 -04:00
Naarcha-AWS d65b56fb33
Fix innerproduct function to match Dot Product (#1004)
* Fix innerproduct function to match Dot Product

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix formatting

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Use dot instead

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Remove parenthesies

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Remove space

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-09-01 13:45:08 -05:00
cwillum b6bcce916c
“fixfor#791_k-NN-ANN” (#837)
* “fixfor#791_k-NN-ANN”

Signed-off-by: cwillum <cwmmoore@amazon.com>

* “fixfor#791_k-NN-ANN”

Signed-off-by: cwillum <cwmmoore@amazon.com>

* “fixfor#791_k-NN-ANN”

Signed-off-by: cwillum <cwmmoore@amazon.com>

* “fix#829-PreAgg-field_doc_count”

Signed-off-by: cwillum <cwmmoore@amazon.com>

* “fix#829-PreAgg-field_doc_count”

Signed-off-by: cwillum <cwmmoore@amazon.com>

* “fixfor#791_k-NN-ANN”

Signed-off-by: cwillum <cwmmoore@amazon.com>

* “fixfor#791_k-NN-ANN”

Signed-off-by: cwillum <cwmmoore@amazon.com>

* “fixfor#791_k-NN-ANN”

Signed-off-by: cwillum <cwmmoore@amazon.com>

* “fixfor#791_k-NN-ANN”

Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>
2022-08-11 16:07:03 -04:00
John Mazanec 594efc0e11 Update link title to section title of doc
Signed-off-by: John Mazanec <jmazane@amazon.com>
2022-06-13 09:25:30 -07:00
John Mazanec c7cf80c975 Change nlists to nlist k-NN plugin
Fixes typo in ivf algorithm parameter. Correct value is nlist as appears
in
https://github.com/opensearch-project/k-NN/blob/2.0/src/main/java/org/opensearch/knn/common/KNNConstants.java.

Signed-off-by: John Mazanec <jmazane@amazon.com>
2022-06-09 22:07:55 -07:00
Naarcha-AWS 0a24fa2992 Remove from all API requests and responses
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-04-14 12:55:17 -05:00
keithhc2 10d0c8efbd Fixed endpoint
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-03-14 13:42:56 -07:00
keithhc2 789c1e921d Language tweaks
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-01-25 14:54:58 -08:00
John Mazanec e808d5274e Mistake in memory estimation for IVF k-NN
Signed-off-by: John Mazanec <jmazane@amazon.com>
2022-01-19 10:32:51 -08:00
Keith Chan eecaeab15f
Merge branch 'main' into index-apis 2022-01-06 11:28:06 -08:00
keithhc2 a6a6cf1965 Perhaps this will fix the conflict
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-01-06 11:23:30 -08:00
keithhc2 8177d12233 Fixed Lucene link
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-01-06 11:12:08 -08:00
John Mazanec 4646820ee6 Call out some issues with faiss hnsw pq
Signed-off-by: John Mazanec <jmazane@amazon.com>
2021-11-18 11:11:19 -08:00
John Mazanec 066efc1e15 Complete v1 of faiss feature docs
Signed-off-by: John Mazanec <jmazane@amazon.com>
2021-11-16 15:08:02 -08:00
John Mazanec 3755a3f8f5 Update performance tuning for faiss
Signed-off-by: John Mazanec <jmazane@amazon.com>
2021-11-16 12:52:05 -08:00
John Mazanec 3f97194542 Update apis for faiss feature
Signed-off-by: John Mazanec <jmazane@amazon.com>
2021-11-15 20:08:21 -08:00
John Mazanec f37576fc83 Update information about JNI library
Signed-off-by: John Mazanec <jmazane@amazon.com>
2021-11-15 18:00:10 -08:00
John Mazanec 13413429fa Update settings for faiss
Signed-off-by: John Mazanec <jmazane@amazon.com>
2021-11-15 17:50:17 -08:00
John Mazanec cf9e27ecfa Update index to include faiss feature
Signed-off-by: John Mazanec <jmazane@amazon.com>
2021-11-15 16:03:19 -08:00
aetter 211da242d6 Update approximate-knn.md 2021-10-19 11:42:46 -07:00
aetter ecea83707d Adds Lucene version variable, minor improvements to REST API and query DSL 2021-09-01 11:37:54 -07:00
aetter 6f32dce469 Merge branch 'main' into remove-redirects 2021-08-12 14:50:28 -07:00
Miki 634db90e9b Link checker plugin and some fixes to URLs
Signed-off-by: Miki <mehranb@amazon.com>
2021-08-12 14:45:04 -07:00
aetter 0d58bcf854 Remove outdated redirects 2021-08-12 14:34:31 -07:00
Miki ba5bfa429f Fix paths in `redirect_from` data
Signed-off-by: Miki <mehranb@amazon.com>
2021-08-04 11:16:37 -07:00
aetter 5f678cd814 Add "introduced" labels for APIs 2021-07-26 16:14:22 -07:00
aetter 51017f3bcc Perhaps I can redirect myself out of this long nightmare 2021-06-10 15:09:17 -07:00
aetter e14076bbd3 Fix anchor links 2021-06-10 12:26:41 -07:00
Liz Snyder fed7115baa Few small nits 2021-06-09 22:18:31 -07:00
aetter 9ea68d488a No more relative links 2021-06-09 19:15:41 -07:00
aetter ce0ebe1948 Redirects for the plugins 2021-05-28 15:20:24 -07:00
aetter fc998e3956 Merge branch 'main' into layout-changes 2021-05-28 13:54:29 -07:00
aetter 2c32397202 Minor KNN tweaks 2021-05-28 13:54:13 -07:00
aetter 2f8ef915a7 Merge KNN changes 2021-05-28 12:52:57 -07:00
aetter 264a950b6c More top-level sections 2021-05-28 12:43:12 -07:00