add unique token filter docs #8451 (#8463)

* add unique token filter docs #8451 Signed-off-by: Anton Rubin <[email protected]> * updating parameter table Signed-off-by: Anton Rubin <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Anton Rubin <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Dec 3, 2024 · 064a2b5 · 064a2b5
1 parent 9bd4c42
commit 064a2b5
Show file tree

Hide file tree

Showing 2 changed files with 107 additions and 1 deletion.
diff --git a/_analyzers/token-filters/index.md b/_analyzers/token-filters/index.md
@@ -61,7 +61,7 @@ Token filter | Underlying Lucene token filter|  Description
 [`synonym_graph`]({{site.url}}{{site.baseurl}}/analyzers/token-filters/synonym-graph/) | N/A | Supplies a synonym list, including multiword synonyms, for the analysis process.
 [`trim`]({{site.url}}{{site.baseurl}}/analyzers/token-filters/trim/) | [TrimFilter](https://lucene.apache.org/core/9_10_0/analysis/common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html) | Trims leading and trailing white space characters from each token in a stream. 
 [`truncate`]({{site.url}}{{site.baseurl}}/analyzers/token-filters/truncate/) | [TruncateTokenFilter](https://lucene.apache.org/core/9_10_0/analysis/common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html) | Truncates tokens with lengths exceeding the specified character limit. 
-`unique` | N/A | Ensures each token is unique by removing duplicate tokens from a stream. 
+[`unique`]({{site.url}}{{site.baseurl}}/analyzers/token-filters/unique/) | N/A | Ensures that each token is unique by removing duplicate tokens from a stream. 
 [`uppercase`]({{site.url}}{{site.baseurl}}/analyzers/token-filters/uppercase/) | [UpperCaseFilter](https://lucene.apache.org/core/9_10_0/analysis/common/org/apache/lucene/analysis/core/LowerCaseFilter.html) | Converts tokens to uppercase. 
 `word_delimiter` | [WordDelimiterFilter](https://lucene.apache.org/core/9_10_0/analysis/common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html) | Splits tokens at non-alphanumeric characters and performs normalization based on the specified rules. 
 [`word_delimiter_graph`]({{site.url}}{{site.baseurl}}/analyzers/token-filters/word-delimiter-graph/) | [WordDelimiterGraphFilter](https://lucene.apache.org/core/9_10_0/analysis/common/org/apache/lucene/analysis/miscellaneous/WordDelimiterGraphFilter.html) | Splits tokens at non-alphanumeric characters and performs normalization based on the specified rules. Assigns a `positionLength` attribute to multi-position tokens.
diff --git a/_analyzers/token-filters/unique.md b/_analyzers/token-filters/unique.md
@@ -0,0 +1,106 @@
+---
+layout: default
+title: Unique
+parent: Token filters
+nav_order: 450
+---
+
+# Unique token filter
+
+The `unique` token filter ensures that only unique tokens are kept during the analysis process, removing duplicate tokens that appear within a single field or text block. 
+
+## Parameters
+
+The `unique` token filter can be configured with the following parameter.
+
+Parameter | Required/Optional | Data type | Description
+:--- | :--- | :--- | :--- 
+`only_on_same_position` | Optional | Boolean | If `true`, the token filter acts as a `remove_duplicates` token filter and only removes tokens that are in the same position. Default is `false`.
+
+## Example
+
+The following example request creates a new index named `unique_example` and configures an analyzer with a `unique` filter:
+
+```json
+PUT /unique_example
+{
+  "settings": {
+    "analysis": {
+      "filter": {
+        "unique_filter": {
+          "type": "unique",
+          "only_on_same_position": false
+        }
+      },
+      "analyzer": {
+        "unique_analyzer": {
+          "type": "custom",
+          "tokenizer": "standard",
+          "filter": [
+            "lowercase",
+            "unique_filter"
+          ]
+        }
+      }
+    }
+  }
+}
+```
+{% include copy-curl.html %}
+
+## Generated tokens
+
+Use the following request to examine the tokens generated using the analyzer:
+
+```json
+GET /unique_example/_analyze
+{
+  "analyzer": "unique_analyzer",
+  "text": "OpenSearch OpenSearch is powerful powerful and scalable"
+}
+```
+{% include copy-curl.html %}
+
+The response contains the generated tokens:
+
+```json
+{
+  "tokens": [
+    {
+      "token": "opensearch",
+      "start_offset": 0,
+      "end_offset": 10,
+      "type": "<ALPHANUM>",
+      "position": 0
+    },
+    {
+      "token": "is",
+      "start_offset": 22,
+      "end_offset": 24,
+      "type": "<ALPHANUM>",
+      "position": 1
+    },
+    {
+      "token": "powerful",
+      "start_offset": 25,
+      "end_offset": 33,
+      "type": "<ALPHANUM>",
+      "position": 2
+    },
+    {
+      "token": "and",
+      "start_offset": 43,
+      "end_offset": 46,
+      "type": "<ALPHANUM>",
+      "position": 3
+    },
+    {
+      "token": "scalable",
+      "start_offset": 47,
+      "end_offset": 55,
+      "type": "<ALPHANUM>",
+      "position": 4
+    }
+  ]
+}
+```