CustomEntityLookupSkill Class
A skill looks for text from a custom, user-defined list of words and phrases.
Constructor
CustomEntityLookupSkill(*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 |
|
entities_definition_uri
|
Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS. |
|
inline_entities_definition
|
The inline CustomEntity definition. |
|
global_default_case_sensitive
|
A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value. |
|
global_default_accent_sensitive
|
A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value. |
|
global_default_fuzzy_edit_distance
|
A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value. |
|
odata_type
|
A URI fragment specifying the type of skill. Required. Default value is "#Microsoft.Skills.Text.CustomEntityLookupSkill". |
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
"da", "de", "en", "es", "fi", "fr", "it", "ko", and "pt".
default_language_code: str | _models.CustomEntityLookupSkillLanguage | None
description
The description of the skill which describes the inputs, outputs, and usage of the skill.
description: str | None
entities_definition_uri
Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS.
entities_definition_uri: str | None
global_default_accent_sensitive
A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value.
global_default_accent_sensitive: bool | None
global_default_case_sensitive
A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value.
global_default_case_sensitive: bool | None
global_default_fuzzy_edit_distance
A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value.
global_default_fuzzy_edit_distance: int | None
inline_entities_definition
The inline CustomEntity definition.
inline_entities_definition: list['_models.CustomEntity'] | 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']
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.CustomEntityLookupSkill".
odata_type: Literal['#Microsoft.Skills.Text.CustomEntityLookupSkill']
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']