Share via

CustomEntityLookupSkill Class

A skill looks for text from a custom, user-defined list of words and phrases.

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

Constructor

CustomEntityLookupSkill(*, inputs: list['_models.InputFieldMappingEntry'], outputs: list['_models.OutputFieldMappingEntry'], name: str | None = None, description: str | None = None, context: str | None = None, default_language_code: str | _models.CustomEntityLookupSkillLanguage | None = None, entities_definition_uri: str | None = None, inline_entities_definition: list['_models.CustomEntity'] | None = None, global_default_case_sensitive: bool | None = None, global_default_accent_sensitive: bool | None = None, global_default_fuzzy_edit_distance: int | None = None, **kwargs: Any)

Keyword-Only Parameters

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

Default value: None
description
str

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

Default value: None
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.

Default value: None
inputs
list[InputFieldMappingEntry]

Inputs of the skills could be a column in the source data set, or the output of an upstream skill. Required.
outputs
list[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. Required.
default_language_code
str or CustomEntityLookupSkillLanguage

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

Default value: None
entities_definition_uri
str

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.

Default value: None
inline_entities_definition
list[CustomEntity]

The inline CustomEntity definition.

Default value: None
global_default_case_sensitive
bool

A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value.

Default value: None
global_default_accent_sensitive
bool

A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value.

Default value: None
global_default_fuzzy_edit_distance
int

A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value.

Default value: None

Variables

Name Description
odata_type
str

A URI fragment specifying the type of skill. Required.
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
list[InputFieldMappingEntry]

Inputs of the skills could be a column in the source data set, or the output of an upstream skill. Required.
outputs
list[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. Required.
default_language_code
str or CustomEntityLookupSkillLanguage

A value indicating which language code to use. Default is en. Known values are: "da", "de", "en", "es", "fi", "fr", "it", "ko", and "pt".
entities_definition_uri
str

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
list[CustomEntity]

The inline CustomEntity definition.
global_default_case_sensitive
bool

A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value.
global_default_accent_sensitive
bool

A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value.
global_default_fuzzy_edit_distance
int

A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value.

Methods

as_dict

Return a dict that can be serialized using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize

Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Return the JSON that would be sent to server from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict

Return a dict that can be serialized using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, dict[str, typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parameters

Name Description
keep_readonly
bool

If you want to serialize the readonly attributes

Default value: True
key_transformer
<xref:function>

A key transformer function.

Returns

Type Description
dict

A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data: Any, content_type: str | None = None) -> Self

Parameters

Name Description
data
Required
str

A str using RestAPI structure. JSON by default.
content_type
str

JSON by default, set application/xml if XML.

Default value: None

Returns

Type Description
Self

An instance of this model

Exceptions

Type Description
DeserializationError

if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> Self

Parameters

Name Description
data
Required
dict

A dict using RestAPI structure
key_extractors
<xref:function>

A key extractor function.

Default value: None
content_type
str

JSON by default, set application/xml if XML.

Default value: None

Returns

Type Description
Self

An instance of this model

Exceptions

Type Description
DeserializationError

if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Return the JSON that would be sent to server from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name Description
keep_readonly
bool

If you want to serialize the readonly attributes

Default value: False

Returns

Type Description
dict

A dict JSON compatible object