REST Resource: settings.searchapplications

资源: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)

查询解释的默认选项

数据源限制

数据源限制。

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

object (Source)

限制来源。

filterOptions[]

object (FilterOptions)

用于限制结果的过滤条件选项。如果存在多个过滤条件,则会在加入之前按对象类型进行分组。具有相同对象类型的过滤器以连接方式联接,然后将结果表达式与连接语句合并。

元素数量上限为 20。

注意: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 的预定义内容来源。

来源.预定义来源

预定义来源:

枚举
NONE
QUERY_HISTORY 建议用户过去发出的查询。仅在与建议 API 一起使用时有效。在查询 API 中使用时会被忽略。
PERSON 推荐单位中的用户。仅在与建议 API 一起使用时有效。在查询 API 中使用时导致错误。
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

过滤选项

要应用于查询的过滤条件选项。

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

string

如果已设置 objectType,则仅返回该类型的对象。此名称应与在架构定义中注册的对象名称一致。长度上限为 256 个字符。

filter

object (Filter)

用于限制搜索的通用过滤条件,例如 lang:ensite:xyz

过滤条件

在查询中表示过滤条件的通用方法,支持两种方法:

1. 设置 ValueFilter。该名称必须与数据源架构中定义的运算符名称一致。

2. 设置 composeFilter。使用逻辑运算符评估过滤器。顶级运算符只能为 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. 架构中的 greaterThanOperatorNamelessThanOperatorName。该查询会过滤属性值大于或等于查询中所提供的值的结果。

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)

过滤条件.复合过滤条件

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

enum (Filter.CompositeFilter.LogicOperator)

子过滤器的逻辑运算符。

subFilters[]

object (Filter)

子过滤条件。

Filter.复合过滤条件.LogicOperator

枚举
AND 逻辑运算符,只能应用于子过滤条件。
OR
NOT 无法仅应用于一个子过滤条件。

SourceConfig

处理 query.searchquery.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,则不会对结果设置限制。

评分配置

在处理 query.searchquery.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.排序顺序

枚举
ASCENDING
DESCENDING

FacetOptions

指定要返回构面结果的运算符。每个 sourceName/objectType/operatorName 组合都有一个 FacetResult。

JSON 表示法
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer
}
字段
sourceName

string

要作为构面的来源名称。格式:datasources/{source_id}。如果留空,系统将使用所有数据源。

objectType

string

如果设置了 objectType,则系统只会使用该类型的对象来计算构面。如果留空,则所有对象都将用于计算构面。

operatorName

string

选择分面的运算符的名称。@see cloudsearch.SchemaPropertyOptions

numFacetBuckets

integer

此构面应返回的构面分区数量上限。默认值为 10。最大值为 100。

QueryExplainationConfig

解释用户查询的默认选项。

JSON 表示法
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
字段
forceVerbatimMode

boolean

启用此标志可以关闭所有内部优化,如查询自然语言 (NL) 解释、补充结果检索以及使用同义词(包括自定义同义词)。如果此标志设置为 True,其优先级将高于在查询级别设置的选项。如果默认值是 False,查询级别的标志将为逐字模式设置正确的解释。

forceDisableSupplementalResults

boolean

设置此标志可停用补充结果检索,在此处设置标记不会检索与指定搜索应用相关联的查询的补充结果。如果此标志设置为 True,其优先级将高于在查询级别设置的选项。如果默认值为 False,查询级别的标志将为补充结果设置正确的解释。

方法

create

创建搜索应用。

delete

删除搜索应用。

get

获取指定的搜索应用。

list

列出所有搜索应用。

reset

将搜索应用重置为默认设置。

update

更新搜索应用。