Share via

EntitiesActionContent Class

Supported parameters for an Entity Recognition task.

Constructor

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

Variables

Name Description
logging_opt_out
bool

logging opt out.
model_version
str

model version.
string_index_type
str or StringIndexType

(Optional) parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes). Known values are: "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit".
inclusions
list[str or EntityCategory]

(Optional) request parameter that limits the output to the requested entity types included in this list. We will apply inclusionList before exclusionList.
exclusions
list[str or EntityCategory]

(Optional) request parameter that filters out any entities that are included the excludeList. When a user specifies an excludeList, they cannot get a prediction returned with an entity in that list. We will apply inclusionList before exclusionList.
overlap_policy
EntityOverlapPolicy

(Optional) describes the type of overlap policy to apply to the ner output.
inference_options
EntityInferenceConfig

(Optional) request parameter that allows the user to provide settings for running the inference.

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

exclusions

(Optional) request parameter that filters out any entities that are included the excludeList. When a user specifies an excludeList, they cannot get a prediction returned with an entity in that list. We will apply inclusionList before exclusionList.

exclusions: list[typing.Union[str, ForwardRef('_models.EntityCategory')]] | None

inclusions

(Optional) request parameter that limits the output to the requested entity types included in this list. We will apply inclusionList before exclusionList.

inclusions: list[typing.Union[str, ForwardRef('_models.EntityCategory')]] | None

inference_options

(Optional) request parameter that allows the user to provide settings for running the inference.

inference_options: _models.EntityInferenceConfig | None

logging_opt_out

logging opt out.

logging_opt_out: bool | None

model_version

model version.

model_version: str | None

overlap_policy

(Optional) describes the type of overlap policy to apply to the ner output.

overlap_policy: _models.EntityOverlapPolicy | None

string_index_type

(Optional) parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes). Known values are: "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit".

string_index_type: str | _models.StringIndexType | None