PathHierarchyTokenizerV2 Class

Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.

Constructor

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

Variables

Name	Description
name	str The name of the tokenizer. 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.
delimiter	str The delimiter character to use. Default is "/".
replacement	str A value that, if set, replaces the delimiter character. Default is "/".
max_token_length	int The maximum token length. Default and maximum is 300.
reverse_token_order	bool A value indicating whether to generate tokens in reverse order. Default is false.
number_of_tokens_to_skip	int The number of initial tokens to skip. Default is 0.
odata_type	str A URI fragment specifying the type of tokenizer. Required. Default value is "#Microsoft.Azure.Search.PathHierarchyTokenizerV2".

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

delimiter

The delimiter character to use. Default is "/".

delimiter: str | None

max_token_length

The maximum token length. Default and maximum is 300.

max_token_length: int | None

name

The name of the tokenizer. 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

number_of_tokens_to_skip

The number of initial tokens to skip. Default is 0.

number_of_tokens_to_skip: int | None

odata_type

A URI fragment specifying the type of tokenizer. Required. Default value is "#Microsoft.Azure.Search.PathHierarchyTokenizerV2".

odata_type: Literal['#Microsoft.Azure.Search.PathHierarchyTokenizerV2']

replacement

A value that, if set, replaces the delimiter character. Default is "/".

replacement: str | None

reverse_token_order

A value indicating whether to generate tokens in reverse order. Default is false.

reverse_token_order: bool | None

Commentaires

Cette page a-t-elle été utile ?