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.

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

Jump to bottom

[DOCS] Add retriever examples, semantic reranking step-by-step guide #111793

Merged
merged 8 commits into from
Aug 12, 2024
Merged

[DOCS] Add retriever examples, semantic reranking step-by-step guide #111793

merged 8 commits into from
Aug 12, 2024

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Aug 12, 2024 •
edited
Loading

✨ URL preview

Updates documentation on search retrievers and semantic reranking. Major changes include:

  • Modification of example queries and descriptions in the "standard retriever" section to illustrate how to use basic and more complex boolean queries.
  • Introduction of explanatory notes for query elements, improving documentation readability and understanding.
  • Inclusion of a new "hybrid search" example that combines lexical and vector searches using RRF
  • Enhancement of the "text similarity reranker retriever" section
  • An extended example of setting up semantic reranking with a Hugging Face model using Eland
  • Clarify supported 3rd party similarity models

@leemthompo leemthompo self-assigned this Aug 12, 2024
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@leemthompo leemthompo marked this pull request as ready for review August 12, 2024 13:21
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Aug 12, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

demjened
demjened approved these changes Aug 12, 2024
View reviewed changes
Copy link
Contributor

@demjened demjened left a comment

Choose a reason for hiding this comment

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

LGTM, few minor comments.

docs/reference/search/retriever.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/retriever.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/retriever.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/retriever.asciidoc Outdated
--cloud-id $CLOUD_ID \
--es-api-key $ES_API_KEY \
--hub-model-id cross-encoder/ms-marco-MiniLM-L-6-v2 \
--task-type c \
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this work like this? I think it has to be an exact value from an enum, in this case text_similarity.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

that's a fat-fingered typo :)

@leemthompo @demjened
Fixes per review
785b036 
Co-authored-by: Adam Demjen <[email protected]>
@leemthompo leemthompo merged commit 06e24a1 into elastic:main Aug 12, 2024
5 checks passed
@leemthompo leemthompo mentioned this pull request Aug 12, 2024
Merged
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Aug 12, 2024
@leemthompo
[DOCS] Add retriever examples, semantic reranking step-by-step guide (e…
d0a1675 
…lastic#111793)
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
✅ 8.15

elasticsearchmachine pushed a commit that referenced this pull request Aug 12, 2024
@leemthompo
[DOCS] Add retriever examples, semantic reranking step-by-step guide (#…
59d7d95 
…111793) (#111805)
@lkts lkts mentioned this pull request Aug 13, 2024
Closed
cbuescher pushed a commit to cbuescher/elasticsearch that referenced this pull request Sep 4, 2024
@leemthompo @cbuescher
[DOCS] Add retriever examples, semantic reranking step-by-step guide (e…
fd7c214 
…lastic#111793)
davidkyle pushed a commit to davidkyle/elasticsearch that referenced this pull request Sep 5, 2024
@leemthompo @davidkyle
[DOCS] Add retriever examples, semantic reranking step-by-step guide (e…
1655142 
…lastic#111793)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@demjened demjened demjened approved these changes

Assignees

@leemthompo leemthompo

Labels
>docs General docs changes Team:Docs Meta label for docs team v8.15.0 v8.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@leemthompo @elasticsearchmachine @demjened