你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
CustomEntity 类
一个 对象,该对象包含有关找到的匹配项和相关元数据的信息。
必须填充所有必需的参数才能发送到 Azure。
- 继承
-
azure.search.documents.indexes._generated._serialization.ModelCustomEntity
构造函数
CustomEntity(*, name: str, description: str | None = None, type: str | None = None, subtype: str | None = None, id: str | None = None, case_sensitive: bool | None = None, accent_sensitive: bool | None = None, fuzzy_edit_distance: int | None = None, default_case_sensitive: bool | None = None, default_accent_sensitive: bool | None = None, default_fuzzy_edit_distance: int | None = None, aliases: List[_models.CustomEntityAlias] | None = None, **kwargs: Any)
仅限关键字的参数
名称 | 说明 |
---|---|
name
|
顶级实体描述符。 技能输出中的匹配项将按此名称分组,此名称应表示所找到的文本的“规范化”形式。 必需。 |
description
|
此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。 |
type
|
此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。 |
subtype
|
此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。 |
id
|
此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。 |
case_sensitive
|
默认为 false。 一个布尔值,表示在与实体名称进行比较时是否应区分字符大小写。 “Microsoft”不区分大小写的示例匹配项可以是:microsoft、microSoft、MICROSOFT。 |
accent_sensitive
|
默认为 false。 指示与实体名称的比较是否应区分重音的布尔值。 |
fuzzy_edit_distance
|
默认值为 0。 最大值为 5。 表示仍看作与实体名称匹配的可接受分歧字符数。 将返回任意给定匹配项的最小可能模糊匹配数。 例如,如果编辑距离设置为 3,则“Windows10”仍将匹配“Windows”、“Windows10”和“Windows 7”。 如果区分大小写设置为 false,则大小写差异不会计入模糊匹配容差;否则会计入。 |
default_case_sensitive
|
更改此实体的默认区分大小写值。 它用于更改所有别名 caseSensitive 值的默认值。 |
default_accent_sensitive
|
更改此实体的默认重音敏感度值。 它用于更改所有别名 accentSensitive 值的默认值。 |
default_fuzzy_edit_distance
|
更改此实体的默认模糊编辑距离值。 它可用于更改所有别名 fuzzyEditDistance 值的默认值。 |
aliases
|
list[<xref:search_service_client.models.CustomEntityAlias>]
复杂对象的数组,可用于指定根实体名称的替代拼写或同义词。 |
变量
名称 | 说明 |
---|---|
name
|
顶级实体描述符。 技能输出中的匹配项将按此名称分组,此名称应表示所找到的文本的“规范化”形式。 必需。 |
description
|
此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。 |
type
|
此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。 |
subtype
|
此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。 |
id
|
此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。 |
case_sensitive
|
默认为 false。 一个布尔值,表示在与实体名称进行比较时是否应区分字符大小写。 “Microsoft”不区分大小写的示例匹配项可以是:microsoft、microSoft、MICROSOFT。 |
accent_sensitive
|
默认为 false。 指示与实体名称的比较是否应区分重音的布尔值。 |
fuzzy_edit_distance
|
默认值为 0。 最大值为 5。 表示仍看作与实体名称匹配的可接受分歧字符数。 将返回任意给定匹配项的最小可能模糊匹配数。 例如,如果编辑距离设置为 3,则“Windows10”仍将匹配“Windows”、“Windows10”和“Windows 7”。 如果区分大小写设置为 false,则大小写差异不会计入模糊匹配容差;否则会计入。 |
default_case_sensitive
|
更改此实体的默认区分大小写值。 它用于更改所有别名 caseSensitive 值的默认值。 |
default_accent_sensitive
|
更改此实体的默认重音敏感度值。 它用于更改所有别名 accentSensitive 值的默认值。 |
default_fuzzy_edit_distance
|
更改此实体的默认模糊编辑距离值。 它可用于更改所有别名 fuzzyEditDistance 值的默认值。 |
aliases
|
list[<xref:search_service_client.models.CustomEntityAlias>]
复杂对象的数组,可用于指定根实体名称的替代拼写或同义词。 |
方法
as_dict |
返回可以使用 json.dump 序列化的 dict。 高级用法可以选择使用回调作为参数: Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码密钥的“key”。 Value 是此 对象中的当前值。 返回的字符串将用于序列化密钥。 如果返回类型是列表,则这被视为分层结果 dict。 请参阅此文件中的三个示例:
如果需要 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 JSON 兼容的对象 |
deserialize
使用 RestAPI 语法分析 str 并返回模型。
deserialize(data: Any, content_type: str | None = None) -> ModelType
参数
名称 | 说明 |
---|---|
data
必需
|
使用 RestAPI 结构的 str。 默认情况下为 JSON。 |
content_type
|
默认情况下,如果为 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
必需
|
使用 RestAPI 结构的 dict |
content_type
|
默认情况下,如果为 XML,则设置 application/xml。 默认值: None
|
key_extractors
|
默认值: None
|
返回
类型 | 说明 |
---|---|
此模型的实例 |
例外
类型 | 说明 |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool