add standard tokenizer docs (#8490)

* add standard tokenizer docs 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]> * Update _analyzers/tokenizers/standard.md Signed-off-by: kolchfa-aws <[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 9, 2024 · dbc1496 · dbc1496
1 parent 5e338e6
commit dbc1496
Showing 1 changed file with 111 additions and 0 deletions.
diff --git a/_analyzers/tokenizers/standard.md b/_analyzers/tokenizers/standard.md
@@ -0,0 +1,111 @@
+---
+layout: default
+title: Standard
+parent: Tokenizers
+nav_order: 130
+---
+
+# Standard tokenizer
+
+The `standard` tokenizer is the default tokenizer in OpenSearch. It tokenizes text based on word boundaries using a grammar-based approach that recognizes letters, digits, and other characters like punctuation. It is highly versatile and suitable for many languages because it uses Unicode text segmentation rules ([UAX#29](https://unicode.org/reports/tr29/)) to break text into tokens.
+
+## Example usage
+
+The following example request creates a new index named `my_index` and configures an analyzer with a `standard` tokenizer:
+
+```json
+PUT /my_index
+{
+  "settings": {
+    "analysis": {
+      "analyzer": {
+        "my_standard_analyzer": {
+          "type": "standard"
+        }
+      }
+    }
+  },
+  "mappings": {
+    "properties": {
+      "content": {
+        "type": "text",
+        "analyzer": "my_standard_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_standard_analyzer",
+  "text": "OpenSearch is powerful, fast, 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": 11,
+      "end_offset": 13,
+      "type": "<ALPHANUM>",
+      "position": 1
+    },
+    {
+      "token": "powerful",
+      "start_offset": 14,
+      "end_offset": 22,
+      "type": "<ALPHANUM>",
+      "position": 2
+    },
+    {
+      "token": "fast",
+      "start_offset": 24,
+      "end_offset": 28,
+      "type": "<ALPHANUM>",
+      "position": 3
+    },
+    {
+      "token": "and",
+      "start_offset": 30,
+      "end_offset": 33,
+      "type": "<ALPHANUM>",
+      "position": 4
+    },
+    {
+      "token": "scalable",
+      "start_offset": 34,
+      "end_offset": 42,
+      "type": "<ALPHANUM>",
+      "position": 5
+    }
+  ]
+}
+```
+
+## Parameters
+
+The `standard` 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`.
+