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

CustomEntity interface

包:

@azure/search-documents

一个 对象，该对象包含有关找到的匹配项和相关元数据的信息。

属性

accentSensitive	默认为 false。 指示与实体名称的比较是否应区分重音的布尔值。
aliases	复杂对象的数组，可用于指定根实体名称的替代拼写或同义词。
caseSensitive	默认为 false。 一个布尔值，表示在与实体名称进行比较时是否应区分字符大小写。 “Microsoft”不区分大小写的示例匹配项可以是：microsoft、microSoft、MICROSOFT。
defaultAccentSensitive	更改此实体的默认重音敏感度值。 它用于更改所有别名 accentSensitive 值的默认值。
defaultCaseSensitive	更改此实体的默认区分大小写值。 它用于更改所有别名 caseSensitive 值的默认值。
defaultFuzzyEditDistance	更改此实体的默认模糊编辑距离值。 它可用于更改所有别名 fuzzyEditDistance 值的默认值。
description	此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。
fuzzyEditDistance	默认值为 0。 最大值为 5。 表示仍看作与实体名称匹配的可接受分歧字符数。 将返回任意给定匹配项的最小可能模糊匹配数。 例如，如果编辑距离设置为 3，则“Windows10”仍将匹配“Windows”、“Windows10”和“Windows 7”。 如果区分大小写设置为 false，则大小写差异不会计入模糊匹配容差；否则会计入。
id	此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。
name	顶级实体描述符。 技能输出中的匹配项将按此名称分组，此名称应表示所找到的文本的“规范化”形式。
subtype	此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。
type	此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。

属性详细信息

accentSensitive

默认为 false。 指示与实体名称的比较是否应区分重音的布尔值。

accentSensitive?: boolean

属性值

boolean

aliases

复杂对象的数组，可用于指定根实体名称的替代拼写或同义词。

aliases?: CustomEntityAlias[]

属性值

CustomEntityAlias[]

caseSensitive

默认为 false。 一个布尔值，表示在与实体名称进行比较时是否应区分字符大小写。 “Microsoft”不区分大小写的示例匹配项可以是：microsoft、microSoft、MICROSOFT。

caseSensitive?: boolean

属性值

boolean

defaultAccentSensitive

更改此实体的默认重音敏感度值。 它用于更改所有别名 accentSensitive 值的默认值。

defaultAccentSensitive?: boolean

属性值

boolean

defaultCaseSensitive

更改此实体的默认区分大小写值。 它用于更改所有别名 caseSensitive 值的默认值。

defaultCaseSensitive?: boolean

属性值

boolean

defaultFuzzyEditDistance

更改此实体的默认模糊编辑距离值。 它可用于更改所有别名 fuzzyEditDistance 值的默认值。

defaultFuzzyEditDistance?: number

属性值

number

description

此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。

description?: string

属性值

string

fuzzyEditDistance

默认值为 0。 最大值为 5。 表示仍看作与实体名称匹配的可接受分歧字符数。 将返回任意给定匹配项的最小可能模糊匹配数。 例如，如果编辑距离设置为 3，则“Windows10”仍将匹配“Windows”、“Windows10”和“Windows 7”。 如果区分大小写设置为 false，则大小写差异不会计入模糊匹配容差；否则会计入。

fuzzyEditDistance?: number

属性值

number

id

此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。

id?: string

属性值

string

name

顶级实体描述符。 技能输出中的匹配项将按此名称分组，此名称应表示所找到的文本的“规范化”形式。

name: string

属性值

string

subtype

此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。

subtype?: string

属性值

string

type

此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。

type?: string

属性值

string