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

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)

仅限关键字的参数

名称	说明
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 序列化的 dict。高级用法可以选择使用回调作为参数： Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。当前包含具有 msrest 类型的“type”和包含 RestAPI 编码密钥的“key”。 Value 是此对象中的当前值。返回的字符串将用于序列化密钥。如果返回类型是列表，则这被视为分层结果 dict。请参阅此文件中的三个示例： attribute_transformer full_restapi_key_transformer last_restapi_key_transformer 如果需要 XML 序列化，可以传递 kwargs is_xml=True。
deserialize	使用 RestAPI 语法分析 str 并返回模型。
enable_additional_properties_sending
from_dict	使用给定的键提取程序分析 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 序列化的 dict。

高级用法可以选择使用回调作为参数：

Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。当前包含具有 msrest 类型的“type”和包含 RestAPI 编码密钥的“key”。 Value 是此对象中的当前值。

返回的字符串将用于序列化密钥。如果返回类型是列表，则这被视为分层结果 dict。

请参阅此文件中的三个示例：

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	与 dict JSON 兼容的对象

deserialize

使用 RestAPI 语法分析 str 并返回模型。

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

参数

名称	说明
data 必需	str 使用 RestAPI 结构的 str。默认情况下为 JSON。
content_type	str 默认情况下，如果为 XML，则设置 application/xml。默认值: None

类型	说明
	此模型的实例

例外

类型	说明
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

使用给定的键提取程序分析 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 结构的 dict
content_type	str 默认情况下，如果为 XML，则设置 application/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) 。