SearchModelFactory.SplitSkill Method

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Source:
SearchModelFactory.cs

A skill to split a string into chunks of text.

public static Azure.Search.Documents.Indexes.Models.SplitSkill SplitSkill(string name = default, string description = default, string context = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs = default, Azure.Search.Documents.Indexes.Models.SplitSkillLanguage? defaultLanguageCode = default, Azure.Search.Documents.Indexes.Models.TextSplitMode? textSplitMode = default, int? maximumPageLength = default, int? pageOverlapLength = default, int? maximumPagesToTake = default);
static member SplitSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * Nullable<Azure.Search.Documents.Indexes.Models.SplitSkillLanguage> * Nullable<Azure.Search.Documents.Indexes.Models.TextSplitMode> * Nullable<int> * Nullable<int> * Nullable<int> -> Azure.Search.Documents.Indexes.Models.SplitSkill
Public Shared Function SplitSkill (Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional inputs As IEnumerable(Of InputFieldMappingEntry) = Nothing, Optional outputs As IEnumerable(Of OutputFieldMappingEntry) = Nothing, Optional defaultLanguageCode As Nullable(Of SplitSkillLanguage) = Nothing, Optional textSplitMode As Nullable(Of TextSplitMode) = Nothing, Optional maximumPageLength As Nullable(Of Integer) = Nothing, Optional pageOverlapLength As Nullable(Of Integer) = Nothing, Optional maximumPagesToTake As Nullable(Of Integer) = Nothing) As SplitSkill

Parameters

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

description
String

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

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

inputs
IEnumerable<InputFieldMappingEntry>

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

outputs
IEnumerable<OutputFieldMappingEntry>

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.

defaultLanguageCode
Nullable<SplitSkillLanguage>

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

textSplitMode
Nullable<TextSplitMode>

A value indicating which split mode to perform.

maximumPageLength
Nullable<Int32>

The desired maximum page length. Default is 10000.

pageOverlapLength
Nullable<Int32>

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.

maximumPagesToTake
Nullable<Int32>

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.

Returns

SplitSkill

A new SplitSkill instance for mocking.

Applies to