你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
CustomEntityLookupSkill 类
技能从用户定义的自定义字词和短语列表中查找文本。
必须填充所有必需的参数才能发送到 Azure。
- 继承
-
azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkillCustomEntityLookupSkill
构造函数
CustomEntityLookupSkill(*, inputs: List[_models.InputFieldMappingEntry], outputs: List[_models.OutputFieldMappingEntry], name: str | None = None, description: str | None = None, context: str | None = None, default_language_code: str | _models.CustomEntityLookupSkillLanguage | None = None, entities_definition_uri: str | None = None, inline_entities_definition: List[_models.CustomEntity] | None = None, global_default_case_sensitive: bool | None = None, global_default_accent_sensitive: bool | None = None, global_default_fuzzy_edit_distance: int | None = None, **kwargs: Any)
仅限关键字的参数
名称 | 说明 |
---|---|
name
|
在技能组中唯一标识它的技能的名称。 未定义名称的技能将在技能数组中指定其从 1 开始的索引的默认名称,前缀为字符 |
description
|
技能的说明,描述技能的输入、输出和用法。 |
context
|
表示执行操作的级别,例如文档根目录或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。 |
inputs
|
list[<xref:search_service_client.models.InputFieldMappingEntry>]
技能的输入可以是源数据集中的列,也可以是上游技能的输出。 必需。 |
outputs
|
list[<xref:search_service_client.models.OutputFieldMappingEntry>]
技能的输出要么是搜索索引中的字段,要么是另一个技能可以用作输入的值。 必需。 |
default_language_code
|
str 或
<xref:search_service_client.models.CustomEntityLookupSkillLanguage>
一个 值,该值指示要使用哪种语言代码。 默认为 |
entities_definition_uri
|
JSON 或 CSV 文件的路径,该文件包含要匹配的所有目标文本。 此实体定义在索引器运行开始时读取。 索引器运行期间对此文件的任何更新在后续运行之前不会生效。 必须可以通过 HTTPS 访问此配置。 |
inline_entities_definition
|
list[<xref:search_service_client.models.CustomEntity>]
内联 CustomEntity 定义。 |
global_default_case_sensitive
|
CaseSensitive 的全局标志。 如果未在 CustomEntity 中设置 CaseSensitive,此值将是默认值。 |
global_default_accent_sensitive
|
AccentSensitive 的全局标志。 如果未在 CustomEntity 中设置 AccentSensitive,则此值将是默认值。 |
global_default_fuzzy_edit_distance
|
FuzzyEditDistance 的全局标志。 如果未在 CustomEntity 中设置 FuzzyEditDistance,则此值将是默认值。 |
变量
名称 | 说明 |
---|---|
odata_type
|
指定技能类型的 URI 片段。 必需。 |
name
|
在技能组中唯一标识它的技能的名称。 未定义名称的技能将在技能数组中指定其从 1 开始的索引的默认名称,前缀为字符 |
description
|
技能的说明,描述技能的输入、输出和用法。 |
context
|
表示执行操作的级别,例如文档根目录或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。 |
inputs
|
list[<xref:search_service_client.models.InputFieldMappingEntry>]
技能的输入可以是源数据集中的列,也可以是上游技能的输出。 必需。 |
outputs
|
list[<xref:search_service_client.models.OutputFieldMappingEntry>]
技能的输出要么是搜索索引中的字段,要么是另一个技能可以用作输入的值。 必需。 |
default_language_code
|
str 或
<xref:search_service_client.models.CustomEntityLookupSkillLanguage>
一个 值,该值指示要使用哪种语言代码。 默认为 |
entities_definition_uri
|
JSON 或 CSV 文件的路径,该文件包含要匹配的所有目标文本。 此实体定义在索引器运行开始时读取。 索引器运行期间对此文件的任何更新在后续运行之前不会生效。 必须可以通过 HTTPS 访问此配置。 |
inline_entities_definition
|
list[<xref:search_service_client.models.CustomEntity>]
内联 CustomEntity 定义。 |
global_default_case_sensitive
|
CaseSensitive 的全局标志。 如果未在 CustomEntity 中设置 CaseSensitive,此值将是默认值。 |
global_default_accent_sensitive
|
AccentSensitive 的全局标志。 如果未在 CustomEntity 中设置 AccentSensitive,则此值将是默认值。 |
global_default_fuzzy_edit_distance
|
FuzzyEditDistance 的全局标志。 如果未在 CustomEntity 中设置 FuzzyEditDistance,则此值将是默认值。 |
方法
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