REST Resource: settings.searchapplications

資源：SearchApplication

SearchApplication

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
欄位
name

string

搜尋應用程式的名稱。

格式：searchapplications/{applicationId}。
displayName

string

搜尋應用程式的顯示名稱。長度上限為 300 個半形字元。
dataSourceRestrictions[]

object (DataSourceRestriction)

套用至設定的限制。元素數量上限為 10。
sourceConfig[]

object (SourceConfig)

針對 dataSourceRestrictions 中指定的來源設定。
scoringConfig

object (ScoringConfig)

排序結果的設定。
defaultSortOptions

object (SortOptions)

搜尋結果的預設排序選項
defaultFacetOptions[]

object (FacetOptions)

傳回切面結果的預設欄位。上述 dataSourceRestrictions 中也包含了這裡指定的來源。
returnResultThumbnailUrls

boolean

每個結果都應傳回縮圖的 URI (如適用)
operationIds[]

string

僅供輸出。目前針對此結構定義執行的長時間執行作業 (LROs) ID。僅供輸出的欄位。
enableAuditLog

boolean

指出是否為查詢 API 中搜尋應用程式提出的要求啟用/停用稽核記錄。
queryInterpretationConfig

object (QueryInterpretationConfig)

查詢解讀的預設選項

DataSourceRestriction

資料來源限制。

JSON 表示法 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
欄位
source

object (Source)

限制來源。
filterOptions[]

object (FilterOptions)

篩選器選項可限制結果。如果有多個篩選器，系統會先依物件類型將這些篩選器分組，再進行彙整。具有相同物件類型的篩選器會以連接方式結合，然後產生的運算式會以排除方式結合。

元素數量上限為 20。

注意：Suggest API 目前僅支援少數篩選器：「objecttype」、「type」和「mimetype」。目前無法使用結構定義專屬篩選器篩選建議。

來源

定義 suggest/search API 的來源。

JSON 表示法 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
欄位

聯集欄位 source。

source 只能是下列其中一個：
name

string

由 Indexing API 建立索引的內容來源名稱。
predefinedSource

enum (Source.PredefinedSource)

Google 應用程式的預先定義內容來源。

Source.PredefinedSource

預先定義的來源：

列舉
NONE
QUERY_HISTORY 建議使用者過去曾執行的查詢。僅適用於與 suggest API 搭配使用。在查詢 API 中使用時會遭到忽略。
PERSON 建議貴機構中的使用者。僅適用於與 suggest API 搭配使用。在查詢 API 中使用時會導致錯誤。
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

要套用至查詢的篩選器選項。

JSON 表示法 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
欄位
objectType

string

如果已設定 objectType，系統只會傳回該類型的物件。這個值應與結構定義定義中註冊的物件名稱相符。長度上限為 256 個半形字元。
filter

object (Filter)

用於限制搜尋的一般篩選器，例如 lang:en、site:xyz。

篩選器

在查詢中表示篩選器的一般方式，支援兩種做法：

1. 設定 ValueFilter。名稱必須與資料來源架構中定義的 operatorName 相符。

2. 設定 CompositeFilter。系統會使用邏輯運算子評估篩選條件。頂層運算子只能是 AND 或 NOT。AND 只能出現在最頂層。「OR」只能出現在頂層「AND」下方。

JSON 表示法 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
欄位

聯集欄位 filter。

filter 只能是下列其中一個：
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

JSON 表示法 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
欄位
operatorName

string

套用至查詢的 operatorName，例如 price_greater_than。篩選器可針對資料來源結構定義中的兩種篩選器類型運作：

  1. operatorName，查詢會根據與值相符的屬性篩選結果。

  2. greaterThanOperatorName 或 lessThanOperatorName 查詢會篩選屬性值的結果，這些值大於或小於查詢中提供的值。
value

object (Value)

要比較的值。

值

使用泛型類型的單一值定義。

JSON 表示法 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
欄位
聯集欄位 value。命名屬性的值。value 只能是下列其中一項：
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

JSON 表示法 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
欄位
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

子篩選器的邏輯運算子。
subFilters[]

object (Filter)

子篩選器。

Filter.CompositeFilter.LogicOperator

列舉
AND 邏輯運算子，只能套用至子篩選器。
OR
NOT NOT 只能套用至單一子篩選器。

SourceConfig

處理 query.search 或 query.suggest 要求時的來源設定。

JSON 表示法 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
欄位
source

object (Source)

要使用這項設定的來源。
scoringConfig

object (SourceScoringConfig)

來源的評分設定。
crowdingConfig

object (SourceCrowdingConfig)

來源的擁擠情形設定。

SourceScoringConfig

設定評分設定。這可讓您修改來源的結果排名。

JSON 表示法 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
欄位
sourceImportance

enum (SourceScoringConfig.SourceImportance)

來源的重要性。

SourceScoringConfig.SourceImportance

來源的重要性，可用於指出某個來源在排名時應否優先於其他來源。

列舉
DEFAULT
LOW
HIGH

SourceCrowdingConfig

設定搜尋結果數量上限。擁擠現象是指同一個來源或主機的多個結果「擠走」其他結果，降低使用者搜尋的品質。為提升搜尋結果的品質和來源多樣性，您可以設定條件，減少重複的來源搜尋結果。

JSON 表示法 
{
  "numResults": integer,
  "numSuggestions": integer
}
欄位
numResults

integer

只要其他來源的結果尚未用盡，結果頁面中每個資料來源的結果數量上限就會增加。指定的值不得為負值。如果這個值等於 0，系統會使用預設值。如要停用這個上限，請將值設為大於 100。
numSuggestions

integer

來源允許的建議數量上限。如果這個值小於或等於 0，系統就不會設定結果限制。

ScoringConfig

處理 query.search 或 query.suggest 要求時，來源的評分設定。

JSON 表示法 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
欄位
disableFreshness

boolean

是否將資訊即時性納入排名信號。根據預設，系統會使用新鮮度做為排名信號。請注意，這項設定不適用於管理員使用者介面。
disablePersonalization

boolean

是否要將結果個人化。根據預設，系統會使用個人信號提升搜尋結果。

SortOptions

JSON 表示法 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
欄位
operatorName

string

對應要排序的欄位運算子的名稱。對應的屬性必須標示為 sortable。
sortOrder

enum (SortOptions.SortOrder)

遞增是預設的排序順序

SortOptions.SortOrder

列舉
ASCENDING
DESCENDING

FacetOptions

指定要傳回商情結果的運算子。每個 sourceName/objectType/operatorName 組合都會有一個 FacetResult。

JSON 表示法 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
欄位
sourceName

string

要啟用切面的來源名稱。格式：datasources/{sourceId} 如果留空，系統會使用所有資料來源。
objectType

string

如果已設定 objectType，系統只會使用該類型的物件來計算切面。如果留空，系統會使用所有物件來計算切面。
operatorName

string

用於切面的運算子名稱。@see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

系統應為此 facet 傳回的 facet 值區數量上限。預設值為 10。值的上限為 100。
integerFacetingOptions

object (IntegerFacetingOptions)

如果已設定，則會說明指定整數屬性的整數切面選項。結構定義中的對應整數屬性應標示為 isFacetable。傳回的分頁數量會是這個值和 numFacetBuckets 的較小值。

IntegerFacetingOptions

用於指定整數切面選項。

JSON 表示法 
{
  "integerBuckets": [
    string
  ]
}
欄位
integerBuckets[]

string (Int64Value format)

指定整數值的值區應以遞增順序排列。舉例來說，如果提供的值為 (1,5,10,100)，系統會建立下列商情項目值區：{<1, [1,5), [5-10), [10-100), >=100}。

QueryInterpretationConfig

解讀使用者查詢的預設選項。

JSON 表示法 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
欄位
forceVerbatimMode

boolean

啟用這個旗標可關閉所有內部最佳化功能，例如查詢的自然語言 (NL) 解讀、額外結果擷取，以及同義詞 (包括自訂同義詞) 的使用。如果此標記設為 True，系統會優先採用此標記，而非在查詢層級設定的選項。如果預設值為 False，查詢層級標記會為逐字模式設定正確的解讀方式。
forceDisableSupplementalResults

boolean

設定這個旗標可停用額外結果擷取功能，如果在此設定旗標，系統就不會擷取與特定搜尋應用程式相關的查詢額外結果。如果此標記設為 True，系統會優先採用此標記，而非在查詢層級設定的選項。如果預設值為 False，查詢層級旗標會為補充結果設定正確的解讀方式。

方法

create

 建立搜尋應用程式。

delete

 刪除搜尋應用程式。

get

 取得指定的搜尋應用程式。

list

 列出所有搜尋應用程式。

patch

 更新搜尋應用程式。

reset

 將搜尋應用程式重設為預設設定。

update

 更新搜尋應用程式。