add fingerprint analyzer docs #8537
Conversation
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
AntonEliatra
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
|
@udabhas @varun-lodaya Please provide tech review approval to move this PR forward in the documentation process. Please review this week or provide a peer who can review it. Thank you. |
vagimeli
added
3 - Tech review
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
kolchfa-aws
added
5 - Editorial review
_analyzers/fingerprint.md
Outdated
| `separator` | Optional | String | Specifies the character used to concatenate the terms after they have been tokenized, sorted, and deduplicated. Default is empty space (` `). | ||
| `max_output_size` | Optional | Integer | Defines the maximum size of the output token. If the concatenated fingerprint exceeds this size, it will be truncated. Default is `255`. | ||
| `stopwords` | Optional | String or list of strings | A custom list or predefined list of stopwords. Default is `_none_`. | ||
| `stopwords_path` | Optional | String | The path (absolute of relative to the config directory) to the list of stopwords. |
There was a problem hiding this comment.
Should this match the phrasing used in the other files?: "The path (absolute or relative to the config directory) to the file containing a list of stopwords."
_analyzers/fingerprint.md
Outdated
|
|
||
| ## Further customization | ||
|
|
||
| If further customization is needed, you can define an analyzer with additional components that make up the `fingerprint` analyzer: |
There was a problem hiding this comment.
Second phrase: "you can define an analyzer containing additional fingerprint analyzer components:"?
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
* add fingerprint analyzer docs Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * updating parameter table Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * Doc review 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> --------- Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit bc30bbd) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Description
add fingerprint analyzer docs
Issues Resolved
Part of #1483 addressed in this PR.
Version
all
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.