Adds new parameters and request examples for chunking settings object

Author: kosabogi

specification/_types/mapping/ChunkingSettings.ts

@@ -24,6 +24,10 @@ import { OverloadOf } from '@spec_utils/behaviors'
 export class ChunkingSettings implements OverloadOf<InferenceChunkingSettings> {
   strategy: string
 
+  separator_group: string
+
+  separators: string[]
+
   max_chunk_size: integer
 
   overlap?: integer

specification/inference/_types/Services.ts

@@ -288,7 +288,33 @@ export class InferenceChunkingSettings {
    */
   sentence_overlap?: integer
   /**
-   * The chunking strategy: `sentence`, `word`, `none` or `recursive`. Learn more about chunking strategies in the External documentation.
+   * This parameter is only applicable when using the `recursive` chunking strategy.
+   *
+   * Sets a predefined list of separators in the saved chunking settings based on the selected text type.
+   * Values can be `markdown` or `plaintext`.
+   *
+   * Using this parameter is an alternative to manually specifying a custom `separators` list.
+   */
+  separator_group: string
+  /**
+   * A list of strings used as possible split points when chunking text with the `recursive` strategy.
+   *
+   * Each string can be a plain string or a regular expression (regex) pattern.
+   * The system tries each separator in order to split the text, starting from the first item in the list.
+   *
+   * After splitting, it attempts to recombine smaller pieces into larger chunks that stay within
+   * the `max_chunk_size` limit, to reduce the total number of chunks generated.
+   */
+  separators: string[]
+  /**
+   * The chunking strategy: `sentence`, `word`, `none` or `recursive`.
+   *
+   *  * If `strategy` is set to `recursive`, you must also specify:
+   *
+   * - `max_chunk_size`
+   * - either `separators` or`separator_group`
+   *
+   * Learn more about different chunking strategies in the External documentation.
    * @server_default sentence
    * @ext_doc_id chunking-strategies
    */

specification/inference/put/examples/request/InferencePutExample1.yaml

@@ -7,6 +7,10 @@ value: |-
      "model_id": "rerank-english-v3.0",
      "api_key": "{{COHERE_API_KEY}}"
    }
+   "chunking_settings": {
+     "strategy": "recursive",
+     "max_chunk_size": 200,
+     "separator_group": "markdown"
   }
 alternatives:
   - language: Python
@@ -19,6 +23,11 @@ alternatives:
               "service_settings": {
                   "model_id": "rerank-english-v3.0",
                   "api_key": "{{COHERE_API_KEY}}"
+              },
+              "chunking_settings": {
+                "strategy": "recursive",
+                "max_chunk_size": 200,
+                "separator_group": "markdown"
               }
           },
       )
@@ -33,6 +42,11 @@ alternatives:
             model_id: "rerank-english-v3.0",
             api_key: "{{COHERE_API_KEY}}",
           },
+          chunking_settings: {
+            strategy: "recursive",
+            max_chunk_size: 200,
+            separator_group: "markdown"
+          }
         },
       });
   - language: Ruby
@@ -45,6 +59,11 @@ alternatives:
           "service_settings": {
             "model_id": "rerank-english-v3.0",
             "api_key": "{{COHERE_API_KEY}}"
+          },
+          "chunking_settings": {
+            "strategy": "recursive",
+            "max_chunk_size": 200,
+            "separator_group": "markdown"
           }
         }
       )
@@ -59,12 +78,17 @@ alternatives:
                   "model_id" => "rerank-english-v3.0",
                   "api_key" => "{{COHERE_API_KEY}}",
               ],
+              "chunking_settings" => [
+                "strategy" => "recursive",
+                "max_chunk_size" => 200,
+                "separator_group" => "markdown"
+              ]
           ],
       ]);
   - language: curl
     code:
       'curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d
-      ''{"service":"cohere","service_settings":{"model_id":"rerank-english-v3.0","api_key":"{{COHERE_API_KEY}}"}}''
+      ''{"service":"cohere","service_settings":{"model_id":"rerank-english-v3.0","api_key":"{{COHERE_API_KEY}}"},"chunking_settings":{"strategy":"recursive","max_chunk_size":200,"separator_group":"markdown"}}''
       "$ELASTICSEARCH_URL/_inference/rerank/my-rerank-model"'
   - language: Java
     code: |
@@ -75,4 +99,7 @@ alternatives:
               .service("cohere")
               .serviceSettings(JsonData.fromJson("{\"model_id\":\"rerank-english-v3.0\",\"api_key\":\"{{COHERE_API_KEY}}\"}"))
           )
+          .chunkingSettings(JsonData.fromJson(
+              "{\"strategy\":\"recursive\",\"max_chunk_size\":200,\"separator_group\":\"markdown\"}"
+          ))
       );