Skip to content
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.

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

Remove model requirement from hybrid search documentation #7511

Merged
merged 5 commits into from
Jul 15, 2024
Merged

Conversation

kolchfa-aws
Copy link
Collaborator

Closes #7401

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@kolchfa-aws
Copy link
Collaborator Author

@navneet1v Could you review this PR please?

@@ -12,7 +12,7 @@ Introduced 2.11
Hybrid search combines keyword and neural search to improve search relevance. To implement hybrid search, you need to set up a [search pipeline]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/index/) that runs at search time. The search pipeline you'll configure intercepts search results at an intermediate stage and applies the [`normalization_processor`]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/normalization-processor/) to them. The `normalization_processor` normalizes and combines the document scores from multiple query clauses, rescoring the documents according to the chosen normalization and combination techniques.

**PREREQUISITE**<br>
Before using hybrid search, you must set up a text embedding model. For more information, see [Choosing a model]({{site.url}}{{site.baseurl}}/ml-commons-plugin/integrating-ml-models/#choosing-a-model).
To follow this example, you must set up a text embedding model. For more information, see [Choosing a model]({{site.url}}{{site.baseurl}}/ml-commons-plugin/integrating-ml-models/#choosing-a-model).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we mention that having a embedding model is not required if you already have the embeddings for the text

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, they can just directly set up hybrid search, correct? I added that sentence.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no actually thats not the case. What we need to tell them is if you already have the embeddings directly ingest the embeddings and skip the ingest pipeline creation step.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I revised the sentence.

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a minor addition 😄

_search-plugins/hybrid-search.md Outdated Show resolved Hide resolved
@kolchfa-aws kolchfa-aws merged commit 72713ab into main Jul 15, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 15, 2024
* Remove model requirement from hybrid search documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Review comment

Signed-off-by: Fanit Kolchina <[email protected]>

* Revised sentence

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _search-plugins/hybrid-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 72713ab)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Jul 24, 2024
…-project#7511)

* Remove model requirement from hybrid search documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Review comment

Signed-off-by: Fanit Kolchina <[email protected]>

* Revised sentence

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _search-plugins/hybrid-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: [email protected] <[email protected]>
sandervandegeijn pushed a commit to sandervandegeijn/documentation-website that referenced this pull request Jul 30, 2024
…-project#7511)

* Remove model requirement from hybrid search documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Review comment

Signed-off-by: Fanit Kolchina <[email protected]>

* Revised sentence

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _search-plugins/hybrid-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Sander van de Geijn <[email protected]>
@kolchfa-aws kolchfa-aws deleted the hybrid-fix branch November 21, 2024 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Incorrect Hybrid Search Documentation
3 participants