Share via

NumericRangeMetadata Class

represents the Metadata of numeric intervals.

Constructor

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

Variables

Name Description
metadata_kind
str or <xref:azure.ai.textanalytics.models.NUMERIC_RANGE_METADATA>

Kind of the metadata. Required. Metadata for numeric range values.
range_kind
str or RangeKind

Kind of numeric ranges supported - like Number, Speed, etc. Required. Known values are: "Number", "Speed", "Weight", "Length", "Volume", "Area", "Age", "Information", "Temperature", and "Currency".
minimum
float

The beginning value of the interval. Required.
maximum
float

The ending value of the interval. Required.
range_inclusivity
str or RangeInclusivity

The inclusiveness of this range. Known values are: "NoneInclusive", "LeftInclusive", "RightInclusive", and "LeftRightInclusive".

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

maximum

The ending value of the interval. Required.

maximum: float

metadata_kind

Kind of the metadata. Required. Metadata for numeric range values.

metadata_kind: NUMERIC_RANGE_METADATA: 'NumericRangeMetadata'>]

minimum

The beginning value of the interval. Required.

minimum: float

range_inclusivity

"NoneInclusive", "LeftInclusive", "RightInclusive", and "LeftRightInclusive".

range_inclusivity: str | _models.RangeInclusivity | None

range_kind

Kind of numeric ranges supported - like Number, Speed, etc. Required. Known values are: "Number", "Speed", "Weight", "Length", "Volume", "Area", "Age", "Information", "Temperature", and "Currency".

range_kind: str | _models.RangeKind