DetectedLanguage Class

Contains the details of the detected language for the text.

Constructor

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

Variables

Name	Description
name	str Long name of a detected language (e.g. English, French). Required.
iso6391_name	str A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr). Required.
confidence_score	float A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. Required.
script_name	str or ScriptKind Identifies the script name of the input document according to the ISO 15924 standard. Known values are: "Arabic", "Armenian", "Bangla", "UnifiedCanadianAboriginalSyllabics", "Cyrillic", "Devanagari", "Ethiopic", "Georgian", "Greek", "Gujarati", "Gurmukhi", "Hangul", "HanLiteral", "HanSimplified", "HanTraditional", "Hebrew", "Japanese", "Khmer", "Kannada", "Lao", "Latin", "Malayalam", "Meitei", "Mongolian", "Myanmar", "Odia", "Santali", "Sharada", "Sinhala", "Tamil", "Telugu", "Thaana", "Thai", and "Tibetan".
script_iso15924_code	str or ScriptCode Identifies the script code of the input document according to the ISO 15924 standard. Known values are: "Arab", "Armn", "Beng", "Cans", "Cyrl", "Deva", "Ethi", "Geor", "Grek", "Gujr", "Guru", "Hang", "Hani", "Hans", "Hant", "Hebr", "Jpan", "Khmr", "Knda", "Laoo", "Latn", "Mlym", "Mong", "Mtei", "Mymr", "Olck", "Orya", "Sinh", "Shrd", "Taml", "Telu", "Thaa", "Thai", and "Tibt".

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from the dictionary.
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: The value for key if key is in the dictionary, else default. :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 the dictionary is empty.
setdefault	Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update	Update the dictionary from a mapping or an iterable of key-value pairs. :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 the dictionary.

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: The value for key if key is in the dictionary, else default. :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	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on the mapping'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 the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :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 the mapping's values

Attributes

confidence_score

A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. Required.

confidence_score: float

iso6391_name

A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr). Required.

iso6391_name: str

name

Long name of a detected language (e.g. English, French). Required.

name: str

script_iso15924_code

Identifies the script code of the input document according to the ISO 15924 standard. Known values are: "Arab", "Armn", "Beng", "Cans", "Cyrl", "Deva", "Ethi", "Geor", "Grek", "Gujr", "Guru", "Hang", "Hani", "Hans", "Hant", "Hebr", "Jpan", "Khmr", "Knda", "Laoo", "Latn", "Mlym", "Mong", "Mtei", "Mymr", "Olck", "Orya", "Sinh", "Shrd", "Taml", "Telu", "Thaa", "Thai", and "Tibt".

script_iso15924_code: str | _models.ScriptCode | None

script_name

Identifies the script name of the input document according to the ISO 15924 standard. Known values are: "Arabic", "Armenian", "Bangla", "UnifiedCanadianAboriginalSyllabics", "Cyrillic", "Devanagari", "Ethiopic", "Georgian", "Greek", "Gujarati", "Gurmukhi", "Hangul", "HanLiteral", "HanSimplified", "HanTraditional", "Hebrew", "Japanese", "Khmer", "Kannada", "Lao", "Latin", "Malayalam", "Meitei", "Mongolian", "Myanmar", "Odia", "Santali", "Sharada", "Sinhala", "Tamil", "Telugu", "Thaana", "Thai", and "Tibetan".

script_name: str | _models.ScriptKind | None

Feedback

Was this page helpful?