Share via

SplitSkill Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SplitSkill.cs
Source:
SplitSkill.cs

A skill to split a string into chunks of text.

public class SplitSkill : Azure.Search.Documents.Indexes.Models.SearchIndexerSkill
type SplitSkill = class
    inherit SearchIndexerSkill
Public Class SplitSkill
Inherits SearchIndexerSkill
Inheritance
Object
SearchIndexerSkill
SplitSkill

Constructors

SplitSkill(IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>)

Initializes a new instance of SplitSkill.

Properties

AzureOpenAITokenizerParameters

Only applies if the unit is set to azureOpenAITokens. If specified, the splitSkill will use these parameters when performing the tokenization. The parameters are a valid 'encoderModelName' and an optional 'allowedSpecialTokens' property.
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.

(Inherited from SearchIndexerSkill)
DefaultLanguageCode

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

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

(Inherited from SearchIndexerSkill)
Inputs

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

(Inherited from SearchIndexerSkill)
MaximumPageLength

The desired maximum page length. Default is 10000.
MaximumPagesToTake

Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to improve performance when only a few initial pages are needed from each document.
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 prefaced with the character "#" in debug sessions and error messages.

(Inherited from SearchIndexerSkill)
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.

(Inherited from SearchIndexerSkill)
PageOverlapLength

Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with this number of characters/tokens from the end of the nth chunk.
TextSplitMode

A value indicating which split mode to perform.
Unit

Only applies if textSplitMode is set to pages. There are two possible values. The choice of the values will decide the length (maximumPageLength and pageOverlapLength) measurement. The default is 'characters', which means the length will be measured by character.

Applies to