Поделиться через

ShingleTokenFilter Класс

  • Ссылка

Создает сочетания маркеров в виде одного маркера. Этот фильтр маркеров реализуется с помощью Apache Lucene.

Все необходимые параметры должны быть заполнены для отправки в Azure.

Наследование
azure.search.documents.indexes._generated.models._models_py3.TokenFilter
ShingleTokenFilter

Конструктор

ShingleTokenFilter(*, name: str, max_shingle_size: int = 2, min_shingle_size: int = 2, output_unigrams: bool = True, output_unigrams_if_no_shingles: bool = False, token_separator: str = ' ', filter_token: str = '_', **kwargs: Any)

Параметры Keyword-Only

Имя Описание
name
str

Имя фильтра маркеров. Название должно содержать только буквы, цифры, тире или знаки подчеркивания. Оно может начинаться и заканчиваться только буквенно-цифровыми знаками, и его длина не должна превышать 128 знаков. Обязательный.
max_shingle_size
int

Максимальный размер гальки. По умолчанию и минимальное значение — 2.

значение по умолчанию: 2
min_shingle_size
int

Минимальный размер гальки. По умолчанию и минимальное значение — 2. Должно быть меньше значения maxShingleSize.

значение по умолчанию: 2
output_unigrams
bool

Значение , указывающее, будет ли выходной поток содержать входные маркеры (юниграммы), а также черепица. Значение по умолчанию — true.

значение по умолчанию: True
output_unigrams_if_no_shingles
bool

Значение, указывающее, следует ли выводить юниграммы для тех случаев, когда не доступны черепицы. Это свойство имеет приоритет, если outputUnigrams имеет значение false. Значение по умолчанию — false.
token_separator
str

Строка, используемая при объединении смежных маркеров для формирования голени. По умолчанию используется один пробел (" ").

значение по умолчанию:
filter_token
str

Строка для вставки для каждой позиции, в которой нет маркера. По умолчанию используется символ подчеркивания ("_").

значение по умолчанию: _

Переменные

Имя Описание
odata_type
str

Фрагмент URI, указывающий тип фильтра маркеров. Обязательный.
name
str

Имя фильтра маркеров. Название должно содержать только буквы, цифры, тире или знаки подчеркивания. Оно может начинаться и заканчиваться только буквенно-цифровыми знаками, и его длина не должна превышать 128 знаков. Обязательный.
max_shingle_size
int

Максимальный размер гальки. По умолчанию и минимальное значение — 2.
min_shingle_size
int

Минимальный размер гальки. По умолчанию и минимальное значение — 2. Должно быть меньше значения maxShingleSize.
output_unigrams
bool

Значение , указывающее, будет ли выходной поток содержать входные маркеры (юниграммы), а также черепица. Значение по умолчанию — true.
output_unigrams_if_no_shingles
bool

Значение, указывающее, следует ли выводить юниграммы для тех случаев, когда не доступны черепицы. Это свойство имеет приоритет, если outputUnigrams имеет значение false. Значение по умолчанию — false.
token_separator
str

Строка, используемая при объединении смежных маркеров для формирования голени. По умолчанию используется один пробел (" ").
filter_token
str

Строка для вставки для каждой позиции, в которой нет маркера. По умолчанию используется символ подчеркивания ("_").

Методы

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.
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

Возвращаемое значение

Тип Описание
dict

Объект, совместимый с JSON для диктовки

deserialize

Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Параметры

Имя Описание
data
Обязательно
str

Str, использующий структуру RestAPI. JSON по умолчанию.
content_type
str

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
Обязательно
dict

Диктовка, использующий структуру RestAPI
content_type
str

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
bool

Если вы хотите сериализовать атрибуты только для чтения

значение по умолчанию: False

Возвращаемое значение

Тип Описание
dict

Объект, совместимый с JSON для диктовки