CustomEntity interface

套件:

@azure/search-documents

物件，包含所找到相符專案和相關中繼資料的相關資訊。

屬性

accentSensitive	預設為 False。 布林值，表示與機構名稱的比較是否應該區分腔調字。
aliases	複雜物件的陣列，可用來指定根機構名稱的替代拼字或同義字。
caseSensitive	預設為 False。 此布林值表示與實體名稱的比較是否應該區分字元大小寫。 「Microsoft」 的不區分大小寫比對範例可能是：microsoft、microSoft、MICROSOFT。
defaultAccentSensitive	變更此實體的預設輔色敏感度值。 它可用來變更所有別名的預設值區分腔調字值。
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

變更此實體的預設輔色敏感度值。 它可用來變更所有別名的預設值區分腔調字值。

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