你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

PatternAnalyzer Class

Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.

Constructor

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

Variables

Name Description
name
str

The name of the analyzer. 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.
lower_case_terms
bool

A value indicating whether terms should be lower-cased. Default is true.
pattern
str

A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters.
flags
list[str or RegexFlags]

Regular expression flags, specified as a '|' separated string of RegexFlags values.
stopwords
list[str]

A list of stopwords.
odata_type
str

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

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

flags

Regular expression flags, specified as a '|' separated string of RegexFlags values.

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

lower_case_terms

A value indicating whether terms should be lower-cased. Default is true.

lower_case_terms: bool | None

name

The name of the analyzer. 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 analyzer. Required. Default value is "#Microsoft.Azure.Search.PatternAnalyzer".

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

pattern

A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters.

pattern: str | None

stopwords

A list of stopwords.

stopwords: list[str] | None