SplitSkill Class

A skill to split a string into chunks of text.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkill

SplitSkill

Constructor

SplitSkill(*, inputs: List[azure.search.documents.indexes._generated.models._models_py3.InputFieldMappingEntry], outputs: List[azure.search.documents.indexes._generated.models._models_py3.OutputFieldMappingEntry], name: Optional[str] = None, description: Optional[str] = None, context: Optional[str] = None, default_language_code: Optional[Union[str, azure.search.documents.indexes._generated.models._search_client_enums.SplitSkillLanguage]] = None, text_split_mode: Optional[Union[str, azure.search.documents.indexes._generated.models._search_client_enums.TextSplitMode]] = None, maximum_page_length: Optional[int] = None, **kwargs)

Parameters

odata_type

str

Required

Required. Identifies the concrete type of the skill.Constant filled by server.

name

str

Required

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

str

Required

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

context

str

Required

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

list[InputFieldMappingEntry]

Required

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

outputs

list[OutputFieldMappingEntry]

Required

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

default_language_code

str or SplitSkillLanguage

Required

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

text_split_mode

str or TextSplitMode

Required

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

maximum_page_length

int

Required

The desired maximum page length. Default is 10000.