SimpleField interface

套件:

@azure/search-documents

表示索引定義中的欄位，描述欄位的名稱、數據類型和搜尋行為。

屬性

analyzerName	要用於欄位的分析器名稱。 此選項只能與可搜尋的字段搭配使用，而且無法與 searchAnalyzer 或 indexAnalyzer 一起設定。 選擇分析器之後，就無法變更欄位。
facetable	值，指出是否要在Facet查詢中參考欄位。 通常用於搜尋結果的呈現中，包括依類別的點擊計數（例如，搜尋數字相機，並查看依品牌點擊、依百萬像素、價格等等）。 類型為 Edm.GeographyPoint 或 Collection（Edm.GeographyPoint） 的欄位不可多面向。 默認值為 false。
filterable	值，指出是否要在$filter查詢中參考欄位。 filterable 與可搜尋的字串處理方式不同。 可篩選的 Edm.String 或 Collection（Edm.String） 類型的字段不會進行斷詞，因此比較僅適用於完全相符專案。 例如，如果您將這類字段 f 設定為 「sunny day」，$filter=f eq 'sunny' 將找不到相符專案，但$filter=f eq 'sunny day' 將會。 默認值為 false。
hidden	值，指出是否可以在搜尋結果中傳回欄位。 如果您想要使用欄位（例如 margin）做為篩選、排序或評分機制，但不想讓使用者看到字段，則可以停用此選項。 索引鍵欄位的此屬性必須為 false。 這個屬性可以在現有的欄位上變更。 啟用此屬性不會造成索引記憶體需求增加。 若為向量欄位，預設值為 true，否則為 false。
indexAnalyzerName	用於欄位索引編製時間的分析器名稱。 此選項只能與可搜尋的欄位搭配使用。 它必須與 searchAnalyzer 一起設定，且無法與分析器選項一起設定。 此屬性無法設定為語言分析器的名稱;如果您需要語言分析器，請改用分析器屬性。 選擇分析器之後，就無法變更欄位。
key	值，指出欄位是否唯一識別索引中的檔。 每個索引中只有一個最上層字段必須選擇為索引鍵欄位，而且必須是Edm.String類型。 索引鍵欄位可用來直接查閱檔，並更新或刪除特定檔。 默認值為 false。
name	欄位的名稱，在索引或父字段的 fields 集合中必須是唯一的。
searchable	值，指出欄位是否可供全文搜索。 這表示它會在編製索引期間進行斷詞分析。 如果您將可搜尋的字段設定為「晴天」之類的值，則內部會分割成個別標記「陽光明媚」和「日」。 這可啟用全文搜索這些字詞。 默認可搜尋類型為 Edm.String 或 Collection（Edm.String） 的欄位。 對於其他非字串數據類型的簡單字段，此屬性必須為 false。 注意：可搜尋的欄位會耗用索引中的額外空間，以容納全文搜索之域值的其他標記化版本。 如果您想要在索引中節省空間，而且不需要在搜尋中包含字段，請將 [可搜尋] 設定為 false。 默認值為 false。
searchAnalyzerName	在搜尋時用於欄位的分析器名稱。 此選項只能與可搜尋的欄位搭配使用。 它必須與 indexAnalyzerName 一起設定，且無法與 [analyzerName] 選項一起設定。 此屬性無法設定為語言分析器的名稱;如果您需要語言分析器，請改用 analyzerName 屬性。 您可以在現有的欄位更新此分析器。
sortable	值，指出是否要在$orderby運算式中參考字段。 根據預設，搜尋引擎會依分數排序結果，但在許多情況下，使用者會想要依檔中的欄位排序。 只有在單一值時，才能排序簡單字段（在父檔範圍中有單一值）。 簡單集合欄位無法排序，因為它們是多重值。 複雜集合的簡單子欄位也是多重值，因此無法排序。 不論其為即時父欄位或上階字段，都是複雜的集合，都是如此。 默認值為 false。
stored	不可變的值，指出欄位是否會個別保存在要在搜尋結果中傳回的磁碟上。 如果您不打算在搜尋回應中傳回字段內容，以節省記憶體額外負荷，則可以停用此選項。 這隻能在索引建立期間設定，而且只能在向量字段設定。 現有欄位無法變更此屬性，或針對新欄位設定為 false。 如果此屬性設定為 false，屬性 'hidden' 必須設定為 'true'。 對於索引鍵欄位、新字段，以及非向量字段，此屬性必須為 false 或 unset。 停用此屬性會減少索引記憶體需求。
synonymMapNames	要與此欄位關聯的同義字名稱清單。 此選項只能與可搜尋的欄位搭配使用。 目前每個欄位只支援一個同義字對應。 將同義字對應指派給字段可確保以該欄位為目標的查詢字詞會使用同義字對應中的規則在查詢時間展開。 這個屬性可以在現有的欄位上變更。
type	欄位的數據類型。
vectorEncodingFormat	用來解譯欄位內容的編碼格式。
vectorSearchDimensions	向量欄位的維度。
vectorSearchProfileName	向量搜尋配置檔的名稱，指定搜尋向量字段時要使用的演算法和向量化程式。

屬性詳細資料

analyzerName

要用於欄位的分析器名稱。 此選項只能與可搜尋的字段搭配使用，而且無法與 searchAnalyzer 或 indexAnalyzer 一起設定。 選擇分析器之後，就無法變更欄位。

analyzerName?: string

屬性值

string

facetable

值，指出是否要在Facet查詢中參考欄位。 通常用於搜尋結果的呈現中，包括依類別的點擊計數（例如，搜尋數字相機，並查看依品牌點擊、依百萬像素、價格等等）。 類型為 Edm.GeographyPoint 或 Collection（Edm.GeographyPoint） 的欄位不可多面向。 默認值為 false。

facetable?: boolean

屬性值

boolean

filterable

值，指出是否要在$filter查詢中參考欄位。 filterable 與可搜尋的字串處理方式不同。 可篩選的 Edm.String 或 Collection（Edm.String） 類型的字段不會進行斷詞，因此比較僅適用於完全相符專案。 例如，如果您將這類字段 f 設定為 「sunny day」，$filter=f eq 'sunny' 將找不到相符專案，但$filter=f eq 'sunny day' 將會。 默認值為 false。

filterable?: boolean

屬性值

boolean

hidden

值，指出是否可以在搜尋結果中傳回欄位。 如果您想要使用欄位（例如 margin）做為篩選、排序或評分機制，但不想讓使用者看到字段，則可以停用此選項。 索引鍵欄位的此屬性必須為 false。 這個屬性可以在現有的欄位上變更。 啟用此屬性不會造成索引記憶體需求增加。 若為向量欄位，預設值為 true，否則為 false。

hidden?: boolean

屬性值

boolean

indexAnalyzerName

用於欄位索引編製時間的分析器名稱。 此選項只能與可搜尋的欄位搭配使用。 它必須與 searchAnalyzer 一起設定，且無法與分析器選項一起設定。 此屬性無法設定為語言分析器的名稱;如果您需要語言分析器，請改用分析器屬性。 選擇分析器之後，就無法變更欄位。

indexAnalyzerName?: string

屬性值

string

key

值，指出欄位是否唯一識別索引中的檔。 每個索引中只有一個最上層字段必須選擇為索引鍵欄位，而且必須是Edm.String類型。 索引鍵欄位可用來直接查閱檔，並更新或刪除特定檔。 默認值為 false。

key?: boolean

屬性值

boolean

name

欄位的名稱，在索引或父字段的 fields 集合中必須是唯一的。

name: string

屬性值

string

searchable

值，指出欄位是否可供全文搜索。 這表示它會在編製索引期間進行斷詞分析。 如果您將可搜尋的字段設定為「晴天」之類的值，則內部會分割成個別標記「陽光明媚」和「日」。 這可啟用全文搜索這些字詞。 默認可搜尋類型為 Edm.String 或 Collection（Edm.String） 的欄位。 對於其他非字串數據類型的簡單字段，此屬性必須為 false。 注意：可搜尋的欄位會耗用索引中的額外空間，以容納全文搜索之域值的其他標記化版本。 如果您想要在索引中節省空間，而且不需要在搜尋中包含字段，請將 [可搜尋] 設定為 false。 默認值為 false。

searchable?: boolean

屬性值

boolean

searchAnalyzerName

在搜尋時用於欄位的分析器名稱。 此選項只能與可搜尋的欄位搭配使用。 它必須與 indexAnalyzerName 一起設定，且無法與 [analyzerName] 選項一起設定。 此屬性無法設定為語言分析器的名稱;如果您需要語言分析器，請改用 analyzerName 屬性。 您可以在現有的欄位更新此分析器。

searchAnalyzerName?: string

屬性值

string

sortable

值，指出是否要在$orderby運算式中參考字段。 根據預設，搜尋引擎會依分數排序結果，但在許多情況下，使用者會想要依檔中的欄位排序。 只有在單一值時，才能排序簡單字段（在父檔範圍中有單一值）。 簡單集合欄位無法排序，因為它們是多重值。 複雜集合的簡單子欄位也是多重值，因此無法排序。 不論其為即時父欄位或上階字段，都是複雜的集合，都是如此。 默認值為 false。

sortable?: boolean

屬性值

boolean

stored

不可變的值，指出欄位是否會個別保存在要在搜尋結果中傳回的磁碟上。 如果您不打算在搜尋回應中傳回字段內容，以節省記憶體額外負荷，則可以停用此選項。 這隻能在索引建立期間設定，而且只能在向量字段設定。 現有欄位無法變更此屬性，或針對新欄位設定為 false。 如果此屬性設定為 false，屬性 'hidden' 必須設定為 'true'。 對於索引鍵欄位、新字段，以及非向量字段，此屬性必須為 false 或 unset。 停用此屬性會減少索引記憶體需求。

stored?: boolean

屬性值

boolean

synonymMapNames

要與此欄位關聯的同義字名稱清單。 此選項只能與可搜尋的欄位搭配使用。 目前每個欄位只支援一個同義字對應。 將同義字對應指派給字段可確保以該欄位為目標的查詢字詞會使用同義字對應中的規則在查詢時間展開。 這個屬性可以在現有的欄位上變更。

synonymMapNames?: string[]

屬性值

string[]

type

欄位的數據類型。

type: SearchFieldDataType

屬性值

SearchFieldDataType

vectorEncodingFormat

用來解譯欄位內容的編碼格式。

vectorEncodingFormat?: string

屬性值

string

vectorSearchDimensions

向量欄位的維度。

vectorSearchDimensions?: number

屬性值

number

vectorSearchProfileName

向量搜尋配置檔的名稱，指定搜尋向量字段時要使用的演算法和向量化程式。

vectorSearchProfileName?: string

屬性值

string