SplitSkill interface

  • Reference
Package:
@azure/search-documents

A skill to split a string into chunks of text.

Extends
BaseSearchIndexerSkill

Properties

defaultLanguageCode

A value indicating which language code to use. Default is en.
maxPageLength

The desired maximum page length. Default is 10000.
odatatype

Polymorphic discriminator, which specifies the different types this object can be
textSplitMode

A value indicating which split mode to perform.

Inherited Properties

context

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.
description

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

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

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 #.
outputs

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.

Property Details

defaultLanguageCode

A value indicating which language code to use. Default is en.

defaultLanguageCode?: SplitSkillLanguage

Property Value

SplitSkillLanguage

maxPageLength

The desired maximum page length. Default is 10000.

maxPageLength?: number

Property Value

number

odatatype

Polymorphic discriminator, which specifies the different types this object can be

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

Property Value

"#Microsoft.Skills.Text.SplitSkill"

textSplitMode

A value indicating which split mode to perform.

textSplitMode?: TextSplitMode

Property Value

TextSplitMode

Inherited Property Details

context

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.

context?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.context

description

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

description?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.description

inputs

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

inputs: InputFieldMappingEntry[]

Property Value

InputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.inputs

name

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 #.

name?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.name

outputs

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.

outputs: OutputFieldMappingEntry[]

Property Value

OutputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.outputs