Updating retriever-examples documentation to run validation tests on the provided snippets #116643
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pmpailis
added
>docs
|
Documentation preview: |
leemthompo
reviewed
Nov 12, 2024
pmpailis
commented
Nov 12, 2024
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
|
Pinging @elastic/es-docs (Team:Docs) |
|
@elasticmachine update branch |
|
Will update to add an example using highlighting and inner-hits as well ( + update these references in the RRF retriever page). |
leemthompo
reviewed
Nov 27, 2024
There was a problem hiding this comment.
Thanks @pmpailis Just some cleanup suggestions, should be good to merge after this, will give a final look at preview :)
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
leemthompo
approved these changes
Nov 29, 2024
There was a problem hiding this comment.
Just some final wording and formatting tweaks. Thanks @pmpailis!
I had one question about indentation in the retriever queries. Because they have so many parentheses, I would just double check that they're as left-aligned as possible :)
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/search/search-your-data/retrievers-examples.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Liam Thompson <[email protected]>
…iidoc Co-authored-by: Liam Thompson <[email protected]>
|
Thank you a lot @leemthompo for all the iterations and the thorough review! :) |
pmpailis
added a commit
to pmpailis/elasticsearch
that referenced
this pull request
Nov 29, 2024
…the provided snippets (elastic#116643)
pmpailis
added a commit
to pmpailis/elasticsearch
that referenced
this pull request
Nov 29, 2024
…the provided snippets (elastic#116643)
pmpailis
added a commit
to pmpailis/elasticsearch
that referenced
this pull request
Nov 29, 2024
…the provided snippets (elastic#116643)
craigtaverner
pushed a commit
to craigtaverner/elasticsearch
that referenced
this pull request
Dec 2, 2024
…the provided snippets (elastic#116643)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to #116196 ; changing
jssnippets toconsoleones so that we can actually run validation for each provided query.cc @leemthompo