add whitespace tokenizer docs (#8484) (#8901)

* add whitespace tokenizer docs * Update whitespace.md * Update whitespace.md * Update whitespace.md * updating parameter table * Doc review * Update _analyzers/tokenizers/whitespace.md * Apply suggestions from code review --------- (cherry picked from commit a32933a) Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@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>
opensearch-project · Dec 9, 2024 · be2f9a5 · be2f9a5
1 parent 1d17583
commit be2f9a5
Show file tree

Hide file tree

Showing 2 changed files with 111 additions and 1 deletion.
diff --git a/_analyzers/tokenizers/index.md b/_analyzers/tokenizers/index.md
@@ -2,7 +2,7 @@
 layout: default
 title: Tokenizers
 nav_order: 60
-has_children: false
+has_children: true
 has_toc: false
 redirect_from:
     - /analyzers/tokenizers/index/

diff --git a/_analyzers/tokenizers/whitespace.md b/_analyzers/tokenizers/whitespace.md
@@ -0,0 +1,110 @@
+---
+layout: default
+title: Whitespace
+parent: Tokenizers
+nav_order: 160
+---
+
+# Whitespace tokenizer
+
+The `whitespace` tokenizer splits text at white space characters, such as spaces, tabs, and new lines. It treats each word separated by white space as a token and does not perform any additional analysis or normalization like lowercasing or punctuation removal.
+
+## Example usage
+
+The following example request creates a new index named `my_index` and configures an analyzer with a `whitespace` tokenizer:
+
+```json
+PUT /my_index
+{
+  "settings": {
+    "analysis": {
+      "tokenizer": {
+        "whitespace_tokenizer": {
+          "type": "whitespace"
+        }
+      },
+      "analyzer": {
+        "my_whitespace_analyzer": {
+          "type": "custom",
+          "tokenizer": "whitespace_tokenizer"
+        }
+      }
+    }
+  },
+  "mappings": {
+    "properties": {
+      "content": {
+        "type": "text",
+        "analyzer": "my_whitespace_analyzer"
+      }
+    }
+  }
+}
+```
+{% include copy-curl.html %}
+
+## Generated tokens
+
+Use the following request to examine the tokens generated using the analyzer:
+
+```json
+POST /my_index/_analyze
+{
+  "analyzer": "my_whitespace_analyzer",
+  "text": "OpenSearch is fast! Really fast."
+}
+```
+{% include copy-curl.html %}
+
+The response contains the generated tokens:
+
+```json
+{
+  "tokens": [
+    {
+      "token": "OpenSearch",
+      "start_offset": 0,
+      "end_offset": 10,
+      "type": "word",
+      "position": 0
+    },
+    {
+      "token": "is",
+      "start_offset": 11,
+      "end_offset": 13,
+      "type": "word",
+      "position": 1
+    },
+    {
+      "token": "fast!",
+      "start_offset": 14,
+      "end_offset": 19,
+      "type": "word",
+      "position": 2
+    },
+    {
+      "token": "Really",
+      "start_offset": 20,
+      "end_offset": 26,
+      "type": "word",
+      "position": 3
+    },
+    {
+      "token": "fast.",
+      "start_offset": 27,
+      "end_offset": 32,
+      "type": "word",
+      "position": 4
+    }
+  ]
+}
+```
+
+## Parameters
+
+The `whitespace` tokenizer can be configured with the following parameter.
+
+Parameter | Required/Optional | Data type | Description
+:--- | :--- | :--- | :--- 
+`max_token_length` | Optional | Integer |  Sets the maximum length of the produced token. If this length is exceeded, the token is split into multiple tokens at the length configured in `max_token_length`. Default is `255`.
+