• Public
  • Public/Protected
  • All

Interface SplitSkill

Package version

A skill to split a string into chunks of text.


  • SplitSkill



Optional context

context: undefined | string

Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

Optional defaultLanguageCode

defaultLanguageCode: SplitSkillLanguage

A value indicating which language code to use. Default is en. Possible values include: 'da', 'de', 'en', 'es', 'fi', 'fr', 'it', 'ko', 'pt'

Optional description

description: undefined | string

The description of the skill which describes the inputs, outputs, and usage of the skill.


Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

Optional maximumPageLength

maximumPageLength: undefined | number

The desired maximum page length. Default is 10000.

Optional name

name: undefined | string

The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.


odatatype: "#Microsoft.Skills.Text.SplitSkill"

Polymorphic Discriminator


The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

Optional textSplitMode

textSplitMode: TextSplitMode

A value indicating which split mode to perform. Possible values include: 'pages', 'sentences'

Generated using TypeDoc