f5b8ff79fd
* 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> |
||
|---|---|---|
| .github | ||
| _aggregations | ||
| _analyzers | ||
| _api-reference | ||
| _benchmark | ||
| _clients | ||
| _dashboards | ||
| _data | ||
| _data-prepper | ||
| _developer-documentation | ||
| _field-types | ||
| _im-plugin | ||
| _includes | ||
| _install-and-configure | ||
| _integrations | ||
| _layouts | ||
| _ml-commons-plugin | ||
| _monitoring-your-cluster | ||
| _observing-your-data | ||
| _plugins | ||
| _query-dsl | ||
| _reporting | ||
| _sass | ||
| _search-plugins | ||
| _security | ||
| _security-analytics | ||
| _tools | ||
| _troubleshoot | ||
| _tuning-your-cluster | ||
| _upgrade-to | ||
| assets | ||
| images | ||
| release-notes | ||
| templates | ||
| .gitignore | ||
| .vale.ini | ||
| 404.md | ||
| API_STYLE_GUIDE.md | ||
| CNAME | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| FORMATTING_GUIDE.md | ||
| Gemfile | ||
| LICENSE | ||
| MAINTAINERS.md | ||
| NOTICE | ||
| README.md | ||
| STYLE_GUIDE.md | ||
| TERMS.md | ||
| THIRD-PARTY | ||
| _config.yml | ||
| about.md | ||
| breaking-changes.md | ||
| build.sh | ||
| check-links.sh | ||
| favicon.ico | ||
| favicon.png | ||
| favicon.svg | ||
| index.md | ||
| quickstart.md | ||
| version-history.md | ||
README.md
About the OpenSearch documentation repo
The documentation-website repository contains the user documentation for OpenSearch. You can find the rendered documentation at opensearch.org/docs.
Contributing
Community contributions remain essential to keeping the documentation comprehensive, useful, well organized, and up to date. If you are interested in submitting an issue or contributing content, see CONTRIBUTING.
The following resources provide important guidance regarding contributions to the documentation:
- OpenSearch Project Style Guidelines -- The style guide covers the style standards to be observed when creating OpenSearch Project content.
- OpenSearch terms -- The terms list contains key OpenSearch terms and tips on how and when to use them.
- API Style Guide -- The API Style Guide provides the basic structure for creating OpenSearch API documentation.
- Formatting Guide -- The OpenSearch documentation uses a modified version of the just-the-docs Jekyll theme. The Formatting Guide provides an overview of the commonly used formatting elements and how to add a page to the website.
Points of contact
If you encounter problems or have questions when contributing to the documentation, these people can help:
Code of conduct
This project has adopted an Open Source Code of Conduct.
Security
If you discover a potential security issue in this project, we ask that you notify AWS/Amazon Security using our vulnerability reporting page. Do not create a public GitHub issue.
License
This project is licensed under the Apache 2.0 License.
Copyright
Copyright OpenSearch contributors.