CustomEntity interface

套件:

@azure/search-documents

物件，其中包含找到之相符專案的相關信息，以及相關的元數據。

屬性

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

變更此實體的預設模糊編輯距離值。 它可以用來變更所有別名模糊EditDistance 值的預設值。

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