你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

EntityRecognitionSkillV3 Class

Using the Text Analytics API, extracts entities of different types from text.

Constructor

EntityRecognitionSkillV3(*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
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.
categories
list[str or EntityCategory]

A list of entity categories that should be extracted.
default_language_code
str or EntityRecognitionSkillLanguage

A value indicating which language code to use. Default is en. Known values are: "ar", "cs", "zh-Hans", "zh-Hant", "da", "nl", "en", "fi", "fr", "de", "el", "hu", "it", "ja", "ko", "no", "pl", "pt-PT", "pt-BR", "ru", "es", "sv", and "tr".
minimum_precision
float

A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.
model_version
str

The version of the model to use when calling the Text Analytics API. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.
odata_type
str

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

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
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

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
ItemsView

set-like object providing a view on D's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

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
ValuesView

an object providing a view on D's values

Attributes

categories

A list of entity categories that should be extracted.

categories: list[typing.Union[str, ForwardRef('_models.EntityCategory')]] | 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

"ar", "cs", "zh-Hans", "zh-Hant", "da", "nl", "en", "fi", "fr", "de", "el", "hu", "it", "ja", "ko", "no", "pl", "pt-PT", "pt-BR", "ru", "es", "sv", and "tr".

default_language_code: str | _models.EntityRecognitionSkillLanguage | 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']

minimum_precision

A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.

minimum_precision: float | None

model_version

The version of the model to use when calling the Text Analytics API. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.

model_version: str | 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.V3.EntityRecognitionSkill".

odata_type: Literal['#Microsoft.Skills.Text.V3.EntityRecognitionSkill']

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']