SplitSkill Class

A skill to split a string into chunks of text.

Constructor

SplitSkill(*args: Any, **kwargs: Any)

Variables

Name Description
name
str

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

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

context
str

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

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

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

default_language_code

A value indicating which language code to use. Default is en. Known values are: "am", "bs", "cs", "da", "de", "en", "es", "et", "fi", "fr", "he", "hi", "hr", "hu", "id", "is", "it", "ja", "ko", "lv", "nb", "nl", "pl", "pt", "pt-br", "ru", "sk", "sl", "sr", "sv", "tr", "ur", and "zh".

text_split_mode

A value indicating which split mode to perform. Known values are: "pages" and "sentences".

maximum_page_length
int

The desired maximum page length. Default is 10000.

page_overlap_length
int

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.

maximum_pages_to_take
int

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.

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. Known values are: "characters" and "azureOpenAITokens".

azure_open_ai_tokenizer_parameters

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.

odata_type
str

A URI fragment specifying the type of skill. Required. Default value is "#Microsoft.Skills.Text.SplitSkill".

Methods

as_dict

Return a dict that can be turned into json using json.dump.

clear

Remove all items from the dictionary.

copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

Default value: False

Returns

Type Description

A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type Description

a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type Description

a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type Description

an object providing a view on the mapping's values

Attributes

azure_open_ai_tokenizer_parameters

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.

azure_open_ai_tokenizer_parameters: _models.AzureOpenAITokenizerParameters | None

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: str | None

default_language_code

"am", "bs", "cs", "da", "de", "en", "es", "et", "fi", "fr", "he", "hi", "hr", "hu", "id", "is", "it", "ja", "ko", "lv", "nb", "nl", "pl", "pt", "pt-br", "ru", "sk", "sl", "sr", "sv", "tr", "ur", and "zh".

default_language_code: str | _models.SplitSkillLanguage | None

description

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

description: str | None

inputs

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

inputs: list['_models.InputFieldMappingEntry']

maximum_page_length

The desired maximum page length. Default is 10000.

maximum_page_length: int | None

maximum_pages_to_take

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.

maximum_pages_to_take: int | None

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: str | None

odata_type

A URI fragment specifying the type of skill. Required. Default value is "#Microsoft.Skills.Text.SplitSkill".

odata_type: Literal['#Microsoft.Skills.Text.SplitSkill']

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

outputs: list['_models.OutputFieldMappingEntry']

page_overlap_length

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.

page_overlap_length: int | None

text_split_mode

"pages" and "sentences".

text_split_mode: str | _models.TextSplitMode | None

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. Known values are: "characters" and "azureOpenAITokens".

unit: str | _models.SplitSkillUnit | None