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

仅限输出。目前为此架构运行的长时间运行的操作 (LRO) 的 ID。仅限输出字段。
enableAuditLog

boolean

指示是否为在查询 API 中针对搜索应用发出的请求启用/停用审核日志记录。
queryInterpretationConfig

object (QueryInterpretationConfig)

查询解释的默认选项

DataSourceRestriction

对数据源的限制。

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

object (Source)

限制的来源。
filterOptions[]

object (FilterOptions)

对结果进行限制的过滤条件选项。如果存在多个过滤条件，则会在合并之前按对象类型对其进行分组。具有相同对象类型的过滤条件以连接方式连接，然后以析取方式连接生成的表达式。

元素数量上限为 20。

注意：Google Suggest API 目前仅支持少数过滤条件：“objecttype”、“type”和“mimetype”目前，特定于架构的过滤条件不能用于过滤建议。

来源

定义建议/搜索 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 Apps 的预定义内容来源。

Source.PredefinedSource

预定义的来源：

枚举
NONE
QUERY_HISTORY 提供用户过去发出的查询建议。仅在与建议 API 一起使用时有效。在查询 API 中使用时，系统会忽略此参数。
PERSON 推荐组织中的用户。仅在与建议 API 一起使用时有效。在 Query 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。且只能显示在最顶层。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 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："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

应为此构面返回的分面分区数上限。默认值为 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

 更新搜索应用。