SnowballTokenFilter Класс
Фильтр, который содержит слова с помощью сгенерированного Снежком парадигматического модуля. Этот фильтр маркеров реализуется с помощью Apache Lucene.
Все необходимые параметры должны быть заполнены для отправки в Azure.
- Наследование
-
azure.search.documents.indexes._generated.models._models_py3.TokenFilterSnowballTokenFilter
Конструктор
SnowballTokenFilter(*, name: str, language: str | _models.SnowballTokenFilterLanguage, **kwargs: Any)
Параметры Keyword-Only
Имя | Описание |
---|---|
name
|
Имя фильтра маркеров. Название должно содержать только буквы, цифры, тире или знаки подчеркивания. Оно может начинаться и заканчиваться только буквенно-цифровыми знаками, и его длина не должна превышать 128 знаков. Обязательный. |
language
|
str или
<xref:search_service_client.models.SnowballTokenFilterLanguage>
Используемый язык. Обязательный. Известные значения: "армянский", "баскский", "каталанский", "датский", "голландский", "английский", "финский", "французский", "немецкий", "немецкий2", "венгерский", "итальянский", "kp", "lovins", "норвежский", "портер", "португальский", "румынский", "русский", "испанский", "шведский" и "турецкий". |
Переменные
Имя | Описание |
---|---|
odata_type
|
Фрагмент URI, указывающий тип фильтра маркеров. Обязательный. |
name
|
Имя фильтра маркеров. Название должно содержать только буквы, цифры, тире или знаки подчеркивания. Оно может начинаться и заканчиваться только буквенно-цифровыми знаками, и его длина не должна превышать 128 знаков. Обязательный. |
language
|
str или
<xref:search_service_client.models.SnowballTokenFilterLanguage>
Используемый язык. Обязательный. Известные значения: "армянский", "баскский", "каталанский", "датский", "голландский", "английский", "финский", "французский", "немецкий", "немецкий2", "венгерский", "итальянский", "kp", "lovins", "норвежский", "портер", "португальский", "румынский", "русский", "испанский", "шведский" и "турецкий". |
Методы
as_dict |
Возвращает диктовку, которую можно сериализовать с помощью json.dump. При дополнительном использовании можно использовать обратный вызов в качестве параметра: Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте. Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом. См. три примера в этом файле:
Если требуется сериализация XML, можно передать kwargs is_xml=True. |
deserialize |
Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель. |
enable_additional_properties_sending | |
from_dict |
Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель. По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor). |
is_xml_model | |
serialize |
Возвращает json, который будет отправлен на сервер из этой модели. Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False). Если требуется сериализация XML, можно передать kwargs is_xml=True. |
as_dict
Возвращает диктовку, которую можно сериализовать с помощью json.dump.
При дополнительном использовании можно использовать обратный вызов в качестве параметра:
Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.
Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.
См. три примера в этом файле:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Если требуется сериализация XML, можно передать kwargs is_xml=True.
as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]
Параметры
Имя | Описание |
---|---|
key_transformer
|
<xref:function>
Функция преобразователя ключей. |
keep_readonly
|
значение по умолчанию: True
|
Возвращаемое значение
Тип | Описание |
---|---|
Объект, совместимый с JSON для диктовки |
deserialize
Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Параметры
Имя | Описание |
---|---|
data
Обязательно
|
Str, использующий структуру RestAPI. JSON по умолчанию. |
content_type
|
JSON по умолчанию задайте значение application/xml, если XML. значение по умолчанию: None
|
Возвращаемое значение
Тип | Описание |
---|---|
Экземпляр этой модели |
Исключения
Тип | Описание |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель.
По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType
Параметры
Имя | Описание |
---|---|
data
Обязательно
|
Диктовка, использующий структуру RestAPI |
content_type
|
JSON по умолчанию задайте значение application/xml, если XML. значение по умолчанию: None
|
key_extractors
|
значение по умолчанию: None
|
Возвращаемое значение
Тип | Описание |
---|---|
Экземпляр этой модели |
Исключения
Тип | Описание |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
Возвращает json, который будет отправлен на сервер из этой модели.
Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).
Если требуется сериализация XML, можно передать kwargs is_xml=True.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Параметры
Имя | Описание |
---|---|
keep_readonly
|
Если вы хотите сериализовать атрибуты только для чтения значение по умолчанию: False
|
Возвращаемое значение
Тип | Описание |
---|---|
Объект, совместимый с JSON для диктовки |
Azure SDK for Python