f999e0a8a8
Add an overview of search methods and pages for each search method ( #5636 )
...
* Restructuring TOC
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Resolve merge conflicts
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* More foundational rewrites of ML
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* TOC restructure
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Rename and rewrite search pages and add keyword search
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Small wording change
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Small wording change
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Updated response
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Small rewording
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Move neural search to top of vector search list
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Change terminology
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Reorganize search methods list
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Rename links
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* More link renames
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Implemented editorial comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-11-29 15:28:20 -05:00
826e6771ed
Refactor ML section - local and remote models ( #5609 )
...
* Refactor ML section - local and remote models
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Added command to calculate checksum
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add ONNX format to register API
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add sparse encoding predict example
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add API section
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Refactor the API section
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Typo
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Implemented Vale comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add get connector API
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Reword heading
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Addressed tech review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
2023-11-17 15:59:27 -05:00
bb269db70b
Change name of normalization processor in text ( #5611 )
...
* Change name of normalization processor in text
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Fix link
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-11-16 11:25:44 -05:00
d8b6f66505
Corrected example for temporary pipeline ( #5555 )
...
The temporary pipeline has to be referenced with `search_pipeline` instead of `pipeline` in the JSON.
Otherwise, you get the error `{"error":{"root_cause":[{"type":"parsing_exception","reason":"Unknown key for a START_OBJECT in [pipeline].","line":8,"col":16}],"type":"parsing_exception","reason":"Unknown key for a START_OBJECT in [pipeline].","line":8,"col":16},"status":400}`.
Tested with Docker image `opensearchproject/opensearch:2.11.0`.
Signed-off-by: Tim Vossen <61426691+upwards-gravity@users.noreply.github.com>
2023-11-09 10:04:43 -05:00
a97c719591
Add multimodal search/sparse search/pre- and post-processing function documentation ( #5168 )
...
* Add multimodal search documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Text image embedding processor
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add prerequisite
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Change query text
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Added bedrock connector tutorial and renamed ML TOC
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Name changes and rewording
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Change connector link
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Change link
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Implemented tech review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Link fix and field name fix
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add default text embedding preprocessing and post-processing functions
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add sparse search documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Fix links
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Pre/post processing function tech review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Fix link
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Sparse search tech review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Implemented doc review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add actual test sparse pipeline response
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Added tested examples
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Added model choice for sparse search
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Remove Bedrock connector
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Implemented tech review feedback
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add that the model must be deployed to neural search
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Link fix
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add session token to sagemaker blueprint
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Formatted bullet points the same way
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Specified both model types in neural sparse query
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Added more explanation for default pre/post-processing functions
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Remove framework and extensibility references
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Minor rewording
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-10-16 10:45:35 -04:00
06527a2772
Add documentation about setting a default model for neural search ( #5121 )
...
* Add documentation about setting a default model for neural search
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add new processor to the processor list
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* More tweaks
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Refactor search pipeline documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Refactor retrieving search pipelines
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add working examples
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Implement tech review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add responses to documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Update _search-plugins/search-pipelines/neural-query-enricher.md
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Apply suggestions from code review
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-10-04 13:35:37 -04:00
f5b8ff79fd
Add score normalization and combination documentation ( #4985 )
...
* Add search phase results processor
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add hybrid query
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Normalization processor additions
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add more details
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Continue writing
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add more query then fetch details and diagram
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Small rewording
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Leaner left nav headers
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Tech review feedback
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add semantic search tutorial
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Reworded prerequisites
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Removed comma
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Rewording advanced prerequisites
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Changed searching for ML model to shorter request
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Update task type in register model response
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Changing example
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Added huggingface prefix to model names
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Change example responses
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Added note about huggingface prefix
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Update _ml-commons-plugin/semantic-search.md
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Implemented doc review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* List weights under parameters
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Remove one-shard warning for normalization processor
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Implemented editorial comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Change links
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* More editorial feedback
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Change model-serving framework to ML framework
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Use get model API to check model status
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Implemented tech review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Added neural search description and diagram
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* More editorial comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add link to profile API
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Addressed more tech review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Implemented editorial comments on changes
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-09-22 17:29:58 -04:00
87ed0af851
Refactor search pipeline documentation ( #4908 )
...
* Refactor search pipeline documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-28 11:56:11 -04:00
6badff1b33
Fix links for Personalize documentation ( #4641 )
...
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-07-26 17:37:13 -04:00
6d7d7d7c3d
Personalize Search Ranking documentation ( #4572 )
...
* Add Personalize search ranking documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add personalize search ranking processor
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Table format
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Fix link
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add link to processor
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Change index name
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Implemented review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Update personalize-search-ranking.md
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Move Personalize up one section
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Changes example
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-25 12:49:43 -04:00
480589cda1
Search pipeline GA documentation ( #4553 )
...
* Search pipeline GA documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add ad-hoc pipelines and ignore failure flag
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Rewording
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Update script-processor.md
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Update _search-plugins/search-pipelines/index.md
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Update _search-plugins/search-pipelines/index.md
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-14 16:28:27 -04:00
492cdddd4e
Add info to enable search pipelines ( #4297 )
...
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-06-09 13:28:21 -04:00
d0242fd6fa
Change GitHub issue to forum link ( #4259 )
...
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-06-06 16:16:53 -04:00
1ae4a86f0c
Add search pipeline documentation ( #4204 )
...
* Add search pipeline documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add search pipeline documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add search pipeline documentation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add experimental label
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Update script processor
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Implemented tech review comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add wildcard and pipeline path parameter
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Reworded get pipeline responses
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Add we do not recommend to use the feature in prod
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Add header to table
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
* Apply suggestions from code review
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* Implemented tech review and editorial comments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
---------
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-06-06 11:11:52 -04:00
kolchfa-aws
Tim Vossen