DictionaryDecompounderTokenFilter Class
Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.
Constructor
DictionaryDecompounderTokenFilter(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
name
|
The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. Required. |
|
word_list
|
The list of words to match against. Required. |
|
min_word_size
|
The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300. |
|
min_subword_size
|
The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300. |
|
max_subword_size
|
The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300. |
|
only_longest_match
|
A value indicating whether to add only the longest matching subword to the output. Default is false. |
|
odata_type
|
A URI fragment specifying the type of token filter. Required. Default value is "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter". |
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
|
Whether to remove the readonly properties. Default value: False
|
Returns
| Type | Description |
|---|---|
|
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 |
|---|---|
|
set-like object providing a view on D's items |
keys
keys() -> KeysView[str]
Returns
| Type | Description |
|---|---|
|
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 |
|---|---|
|
an object providing a view on D's values |
Attributes
max_subword_size
The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300.
max_subword_size: int | None
min_subword_size
The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300.
min_subword_size: int | None
min_word_size
The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300.
min_word_size: int | None
name
The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. Required.
name: str
odata_type
A URI fragment specifying the type of token filter. Required. Default value is "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter".
odata_type: Literal['#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter']
only_longest_match
A value indicating whether to add only the longest matching subword to the output. Default is false.
only_longest_match: bool | None
word_list
The list of words to match against. Required.
word_list: list[str]