Add example to text chunking processor documentation #6794
Merged
Conversation
This file contains 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
Signed-off-by: yuye-aws <[email protected]>
Signed-off-by: yuye-aws <[email protected]>
yuye-aws
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
stephen-crawford
as code owners
hdhalter
added
release-notes
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: yuye-aws <[email protected]>
natebower
reviewed
Mar 29, 2024
There was a problem hiding this comment.
@yuye-aws @kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!
| } | ||
| ``` | ||
| {% include copy-curl.html %} | ||
| Once you have created an ingest pipeline, you need to create an index for ingestion and ingest documents into the index. To learn more, see [Text chunking]({{site.url}}{{site.baseurl}}/search-plugins/text-chunking/). |
There was a problem hiding this comment.
The text after the comma in the first sentence is a bit redundant. Can we simplify?
There was a problem hiding this comment.
Shall we also change the sentence from other files like text-image-embedding.md?
There was a problem hiding this comment.
Creating an index is a separate step so I think separating the two makes sense, even though "ingest" appears in both parts of the sentence.
_search-plugins/text-chunking.md
Outdated
|
|
||
| ## Step 2: Create an index for ingestion | ||
|
|
||
| In order to use the ingest pipeline, you need to create a k-NN index. The `passage_chunk_embedding` field must be of a `nested` type. The `knn.dimension` field must contain the number of dimensions for your model: |
_search-plugins/text-chunking.md
Outdated
|
|
||
| ## Step 4: Search the index using neural search | ||
|
|
||
| You can use a `nested` query to perform vector search on your index. We recommend setting `score_mode` to `max`, where the document score is set to the maximum of the scores from all passage embeddings: |
There was a problem hiding this comment.
Is "maximum" the right word here, or do we mean "highest"?
There was a problem hiding this comment.
Either way. Changed to "highest".
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Yuye Zhu <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Yuye Zhu <[email protected]>
Signed-off-by: yuye-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
kolchfa-aws
approved these changes
Mar 29, 2024
hdhalter
added
3 - Tech review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Add example to text chunking processor documentation
Issues Resolved
Add example to text chunking processor documentation #6707
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.