SplitSkill Class
A skill to split a string into chunks of text.
Constructor
SplitSkill(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
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 '#'. |
|
description
|
The description of the skill which describes the inputs, outputs, and usage of the skill. |
|
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. |
|
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 |
|
text_split_mode
|
str or
TextSplitMode
A value indicating which split mode to perform. Known values are: "pages" and "sentences". |
|
maximum_page_length
|
The desired maximum page length. Default is 10000. |
|
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. |
|
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. |
|
odata_type
|
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 D. |
| 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: D[k] if k in D, else d. :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 D is empty. |
| setdefault |
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any |
| update |
Updates D from mapping/iterable E and F. :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 D.
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: D[k] if k in D, else d. :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 |
|---|---|
|
set-like object providing a view on D's items |
keys
keys() -> KeysView[str]
Returns
| Type | Description |
|---|---|
|
a set-like object providing a view on D'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 D is empty.
popitem() -> tuple[str, Any]
setdefault
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
setdefault(key: str, default: ~typing.Any = <object object>) -> Any
Parameters
| Name | Description |
|---|---|
|
key
Required
|
|
|
default
|
|
update
Updates D from mapping/iterable E and F. :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 D's values |
Attributes
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