Schema

string

物件的名稱，用於定義其類型。商品索引要求應將 objectType 欄位設為這個值。舉例來說，如果name 為 Document，則 Document 類型項目的索引要求應將 objectType 設為 Document。每個物件定義的名稱在架構中都必須是唯一的。名稱開頭必須為英文字母，且只能包含英文字母 (A-Z、a-z) 或數字 (0-9)。長度上限為 256 個半形字元。

object (ObjectOptions)

選用的物件專屬選項。

object (PropertyDefinition)

物件的屬性定義。元素數量上限為 1000。

object (ObjectOptions.FreshnessOptions)

物件的新鮮度選項。

object (ObjectDisplayOptions)

決定物件在 Cloud Search 搜尋結果頁面中顯示方式的選項。

string

可用於篩選建議的運算子。對於 query.suggest API，只有此處提及的運算子才會在 FilterOptions 中生效。僅支援 TEXT 和 ENUM 運算子。

注意：「objecttype」、「type」和「mimetype」已受支援。這項屬性用於設定結構定義專屬運算子。

雖然這是陣列，但只能指定一個運算子。這是日後可擴充的陣列。

運算子不支援對應至同一物件中多個屬性。如果運算子跨越不同物件類型，則必須為每個物件定義設定這個選項一次。

string

這個屬性會指出索引中物件的新鮮度。如果已設定，此屬性必須是 property definitions 中的頂層屬性，且必須是 timestamp type 或 date type。否則，Indexing API 會使用 updateTime 做為新鮮度指標。長度上限為 256 個半形字元。

使用屬性計算新鮮度時，系統會以目前時間為基準，預設為 2 年。

string (Duration format)

物件經過多久後應視為過時。預設值為 180 天 (以秒為單位)。

以秒為單位的時間長度，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。

string

在搜尋結果中顯示的友善使用者標籤，用於指出項目類型。這是選用項目；如果未提供，系統就不會在搜尋結果的內容行中顯示物件標籤。長度上限為 64 個半形字元。

object (ObjectDisplayOptions.Metaline)

定義搜尋結果的元資料行中顯示的屬性。屬性值會按照這裡提供的順序顯示。如果屬性含有多個值，系統會在下一個屬性之前顯示所有值。因此，建議您在清單中先指定單一屬性，再指定重複屬性。所有屬性都必須將 isReturnable 設為 true。最多只能有 3 個中繼行程。

object (ObjectDisplayOptions.DisplayedProperty)

顯示的中繼線屬性清單。屬性數量上限為 5。

string

物件屬性定義中定義的頂層屬性名稱。如果名稱不是結構定義中定義的屬性，嘗試更新結構定義時會顯示錯誤。

string

屬性名稱。傳送至 Indexing API 的項目索引要求應將 property name 設為這個值。舉例來說，如果名稱為「subject_line」，則針對含有主旨欄位的文件項目建立索引請求時，應將該欄位的 name 設為「subject_line」。使用名稱做為物件屬性的 ID。一旦將名稱註冊為物件的屬性，就無法在該物件中將此名稱用於其他屬性。名稱開頭必須為英文字母，且只能包含英文字母 (A-Z、a-z) 或數字 (0-9)。長度上限為 256 個半形字元。

boolean

表示資源會透過 Query API 在搜尋結果中傳回資料。如果設為 true，表示 Query API 使用者可以在結果中使用相符的屬性欄位。不過，儲存欄位需要更多空間分配，且會使用更多頻寬進行搜尋查詢，這會影響大型資料集的效能。只有在搜尋結果需要該欄位時，才將此屬性設為 true。對於類型為物件的屬性，此值無法設為 true。

boolean

表示屬性允許多個值。舉例來說，文件只有一個說明，但可以有多則留言。對於屬性類型為布林值的屬性，此值不得為 true。如果設為 false，含有多個值的屬性會導致系統拒絕該項目的索引要求。

boolean

表示可用於排序的屬性。對於可重複的房源，此值不得設為 true。對於類型為物件的屬性，此值不得為 true。如要設定這個選項，IsReturnable 必須設為 true。僅支援布林值、日期、雙精度浮點數、整數和時間戳記屬性。

boolean

表示該屬性可用於產生商情項目。對於類型為物件的屬性，此值不得為 true。如要設定這個選項，IsReturnable 必須設為 true。僅支援布林值、列舉、整數和文字屬性。

boolean

表示可使用該屬性產生搜尋建議。

boolean

表示使用者可以針對這個資源執行萬用字元搜尋。僅支援文字屬性。如要設定這個選項，IsReturnable 必須設為 true。在特定資料來源中，最多可將 5 個屬性標示為 isWildcardSearchable。詳情請參閱「定義物件屬性」一文。

object (PropertyDisplayOptions)

這些選項可決定系統如何在 Cloud Search 結果頁面中顯示屬性 (如果屬性已指定要在物件的 display options 中顯示)。

object (IntegerPropertyOptions)

object (DoublePropertyOptions)

object (TimestampPropertyOptions)

object (BooleanPropertyOptions)

object (ObjectPropertyOptions)

object (EnumPropertyOptions)

object (DatePropertyOptions)

object (TextPropertyOptions)

object (HtmlPropertyOptions)

enum (IntegerPropertyOptions.OrderedRanking)

用於指定整數的排序排名。只有在 isRepeatable 為 false 時才能使用。

string (Int64Value format)

屬性的最小值。屬性的最小值和最大值會用於根據 ordered ranking 對結果進行排名。系統會接受值低於最低值的索引要求，並將其與索引值為最低值的項目給予相同的權重。

string (Int64Value format)

屬性的最大值。屬性的最小值和最大值會用於根據 ordered ranking 對結果進行排名。系統會接受值大於上限值的索引要求，並以與索引值為上限值的項目相同的權重進行排名。

object (IntegerPropertyOptions.IntegerOperatorOptions)

如果已設定，則說明整數應如何用於搜尋運算子。

object (IntegerFacetingOptions)

如果已設定，則會說明指定整數屬性的整數切面選項。對應的整數屬性應標示為 isFacetable。

string

表示在查詢中需要的運算子名稱，以便隔離整數屬性。舉例來說，如果運算子名稱為 priority，屬性名稱為 priorityVal，則 priority:<value> 這類查詢只會在 priorityVal 屬性的值與 <value> 相符時，才會顯示結果。相較之下，如果搜尋使用相同的 <value> 但沒有運算子，則會傳回所有項目，其中 <value> 與項目內容欄位中的任何字串屬性或文字相符。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。

string

指出查詢中需要的運算子名稱，以便使用小於運算子隔離整數屬性。舉例來說，如果 lessThanOperatorName 是 prioritybelow，屬性名稱則為 priorityVal，則只有在 priorityVal 屬性值小於 <value> 時，查詢才會顯示結果。運算子名稱只能包含小寫英文字母 (a-z)。長度上限為 32 個字元。

string

表示查詢中需要的運算子名稱，以便使用大於運算子隔離整數屬性。舉例來說，如果 greaterThanOperatorName 是 priorityabove，屬性名稱是 priorityVal，則只有當 priorityVal 屬性值大於 <value> 時，查詢才會顯示結果。運算子名稱只能包含小寫字母 (a-z)。長度上限為 32 個字元。

object (DoublePropertyOptions.DoubleOperatorOptions)

如果已設定，則說明如何使用雙引號做為搜尋運算子。

string

表示在查詢中需要的運算子名稱，以便在排序或做為商情項目時使用雙精度屬性。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。

object (TimestampPropertyOptions.TimestampOperatorOptions)

如果已設定，則說明如何使用時間戳記做為搜尋運算子。

string

表示在查詢中需要的運算子名稱，以便隔離時間戳記屬性。舉例來說，如果運算子名稱為 closedon，屬性名稱為 closeDate，則 closedon:<value> 這類查詢只會顯示 closeDate 屬性值與 <value> 相符的結果。相較之下，如果搜尋查詢使用相同的 <value> 但不含運算子，則系統會傳回所有項目，其中 <value> 與項目內容欄位中的任何字串屬性或文字相符。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。

string

表示查詢中需要的運算子名稱，以便使用小於運算子隔離時間戳記屬性。舉例來說，如果 lessThanOperatorName 是 closedbefore，屬性名稱則為 closeDate，則只有在 closeDate 屬性值早於 <value> 時，查詢才會顯示結果。運算子名稱只能包含小寫字母 (a-z)。長度上限為 32 個字元。

string

表示查詢中所需的運算子名稱，以便使用大於運算子隔離時間戳記屬性。舉例來說，如果「greaterThanOperatorName」是「closedafter」，屬性名稱是「closeDate」，則只有當「closeDate」屬性值晚於「<value>」時，查詢才會顯示結果。運算子名稱只能包含小寫字母 (a-z)。長度上限為 32 個字元。

object (BooleanPropertyOptions.BooleanOperatorOptions)

如果已設定，則說明布林值應如何用於搜尋運算子。

string

指出查詢中需要的運算子名稱，以便隔離布林屬性。舉例來說，如果運算子名稱為 closed，屬性名稱為 isClosed，則 closed:<value> 這類查詢只會顯示 isClosed 屬性值與 <value> 相符的結果。相較之下，如果搜尋時未使用運算子，但使用相同的 <value>，則系統會傳回所有項目，其中 <value> 與項目內容欄中的任何字串屬性或文字相符。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。

object (PropertyDefinition)

子物件的屬性。這些屬性代表巢狀物件。舉例來說，如果這個屬性代表郵遞地址，子物件屬性可能會命名為「街道」、「城市」和「州」。元素數量上限為 1000。

object (EnumPropertyOptions.EnumValuePair)

列舉屬性可能的值清單。所有 EnumValuePairs 都必須提供字串值。如果您為一個 EnumValuePair 指定整數值，則所有可能的 EnumValuePairs 都必須提供整數值。字串值和整數值在所有可能的值中都必須是唯一值。設定後，您就無法移除或修改可能的值。如果您提供有序排名，且認為日後可能會插入其他列舉值，請在初始整數值中留出空格，以便在先前註冊的值之間新增值。元素數量上限為 100。

enum (EnumPropertyOptions.OrderedRanking)

用於指定列舉的排序排名，決定如何使用可能的 EnumValuePairs 中的整數值來為結果排序。如果指定了這個屬性的所有可能的 EnumValuePair 值，則必須為這些值提供整數值。只有在 isRepeatable 為 false 時才能使用。

object (EnumPropertyOptions.EnumOperatorOptions)

如果已設定，則說明如何使用列舉做為搜尋運算子。

string

EnumValuePair 的字串值。長度上限為 32 個字元。

integer

EnumValuePair 的整數值，必須為非負值。選填。

string

表示在查詢中需要的運算子名稱，以便隔離列舉屬性。舉例來說，如果運算子名稱為 priority，屬性名稱為 priorityVal，則 priority:<value> 這類查詢只會在 priorityVal 屬性的值與 <value> 相符時，才會顯示結果。相較之下，如果搜尋使用相同的 <value> 但沒有運算子，則會傳回所有項目，其中 <value> 與項目內容欄位中的任何字串屬性或文字相符。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。

object (DatePropertyOptions.DateOperatorOptions)

如果已設定，則會說明如何使用日期做為搜尋運算子。

string

指出查詢中所需的實際字串，以便隔離日期屬性。舉例來說，假設問題追蹤結構定義物件含有名為 closeDate 的屬性，該屬性會指定運算子，其運算子名稱為 closedon。針對這類資料的搜尋，如果使用 closedon:<value> 這類查詢，系統只會在 closeDate 屬性的值與 <value> 相符時，才會顯示結果。相較之下，如果搜尋時使用相同的 <value> 但沒有運算子，系統會傳回所有項目，其中 <value> 與索引資料來源的內容欄位中任何字串屬性或文字的值相符。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。

string

表示在查詢中需要的運算子名稱，以便使用小於運算子隔離日期屬性。舉例來說，如果 lessThanOperatorName 是 closedbefore，屬性名稱則為 closeDate，則只有在 closeDate 屬性值早於 <value> 時，查詢才會顯示結果。運算子名稱只能包含小寫字母 (a-z)。長度上限為 32 個字元。

string

表示查詢中需要的運算子名稱，以便使用大於運算子隔離日期屬性。舉例來說，如果「greaterThanOperatorName」是「closedafter」，屬性名稱是「closeDate」，則只有當「closeDate」屬性值晚於「<value>」時，查詢才會顯示結果。運算子名稱只能包含小寫字母 (a-z)。長度上限為 32 個字元。

object (RetrievalImportance)

指出在用於擷取時，欄位中符記的搜尋品質重要性。

object (TextPropertyOptions.TextOperatorOptions)

如果已設定，則說明如何使用該屬性做為搜尋運算子。

enum (RetrievalImportance.Importance)

表示在擷取期間比對到的屬性所獲得的排名重要性。一旦設定，就無法變更屬性的符記重要性。

string

表示查詢中所需的運算子名稱，用於隔離文字屬性。舉例來說，如果運算子名稱為 subject，屬性名稱為 subjectLine，那麼 subject:<value> 這類查詢只會在屬性名稱為 subjectLine 的值與 <value> 相符時，才會顯示結果。相較之下，如果搜尋內容使用相同的 <value> 但沒有運算子，系統會傳回所有項目，其中 <value> 與任何文字屬性的值或項目內容欄中的文字相符。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。

boolean

如果為 true，系統會在運算子搜尋和面向比對中，將文字值代碼化為一個原子值。舉例來說，如果運算子名稱為「genre」，而值為「science-fiction」，則查詢限制「genre:science」和「genre:fiction」與項目不符；「genre:science-fiction」則符合。文字值比對會區分大小寫，且不會移除特殊字元。如果設為 False，系統會將文字切割成符記。舉例來說，如果值為「科幻」，則「genre:science」和「genre:fiction」查詢會與項目相符。

object (RetrievalImportance)

指出欄位中用於擷取的符記搜尋品質的重要性。只能設為「DEFAULT」或「NONE」。

object (HtmlPropertyOptions.HtmlOperatorOptions)

如果已設定，則說明如何使用該屬性做為搜尋運算子。

string

表示在查詢中需要的運算子名稱，以便隔離 html 屬性。舉例來說，如果運算子名稱為 subject，屬性名稱為 subjectLine，則 subject:<value> 這類查詢只會顯示 subjectLine 屬性值與 <value> 相符的結果。相較之下，如果搜尋查詢使用相同的 <value> 但沒有運算子，則會傳回所有項目，其中 <value> 與項目內容欄位中的任何 HTML 屬性或文字相符。運算子名稱只能使用小寫英文字母 (a 至 z)。長度上限為 32 個字元。

string

如果屬性已指定在 ObjectDisplayOptions 中顯示，則使用者友善的屬性標籤。如果提供顯示標籤，當屬性屬於物件顯示選項的一部分時，系統就會在屬性值前方顯示顯示標籤。舉例來說，如果屬性值是「1」，這個值本身可能對使用者而言並非實用的上下文。如果您指定的顯示名稱為「priority」，使用者在搜尋結果中會看到「priority : 1」，這可為搜尋使用者提供明確的背景資訊。這是選用項目；如果未提供，系統只會顯示屬性值。長度上限為 64 個半形字元。