搜索模板 API
编辑搜索模板 API编辑
使用 搜索模板 运行搜索。
response = client.search_template(
index: 'my-index',
body: {
id: 'my-search-template',
params: {
query_string: 'hello world',
from: 0,
size: 10
}
}
)
puts response
GET my-index/_search/template
{
"id": "my-search-template",
"params": {
"query_string": "hello world",
"from": 0,
"size": 10
}
}
请求编辑
GET <target>/_search/template
GET _search/template
POST <target>/_search/template
POST _search/template
路径参数编辑
-
<target> - （可选，字符串）要搜索的数据流、索引和别名的逗号分隔列表。支持通配符 (
*)。要搜索所有数据流和索引，请省略此参数或使用*。
查询参数编辑
-
allow_no_indices -
（可选，布尔值）如果为
false，则如果任何通配符表达式、索引别名 或_all值仅指向缺少或关闭的索引，则请求将返回错误。即使请求指向其他打开的索引，此行为也适用。例如，如果索引以foo开头但没有索引以bar开头，则指向foo*,bar*的请求将返回错误。默认为
true。 -
ccs_minimize_roundtrips - （可选，布尔值）如果为
true，则会尽量减少跨集群搜索请求的网络往返次数。默认为true。 -
expand_wildcards -
（可选，字符串）通配符模式可以匹配的索引类型。如果请求可以指向数据流，则此参数确定通配符表达式是否匹配隐藏的数据流。支持逗号分隔的值，例如
open,hidden。有效值为-
all - 匹配任何数据流或索引，包括 隐藏的 数据流或索引。
-
open - 匹配打开的、非隐藏的索引。也匹配任何非隐藏的数据流。
-
closed - 匹配关闭的、非隐藏的索引。也匹配任何非隐藏的数据流。数据流不能关闭。
-
hidden - 匹配隐藏的数据流和隐藏的索引。必须与
open、closed或两者结合使用。 -
none - 不接受通配符模式。
-
-
explain - （可选，布尔值）如果为
true，则响应将在命中结果中包含有关分数计算的更多详细信息。默认为false。 -
ignore_throttled -
（可选，布尔值）如果为
true，则在冻结时忽略具体的、已扩展的或已设置别名的索引。默认为true。[7.16.0] 已弃用于 7.16.0。
-
ignore_unavailable - （可选，布尔值）如果为
false，则如果请求指向缺少或关闭的索引，则请求将返回错误。默认为false。 -
preference - （可选，字符串）指定应在其上执行操作的节点或分片。默认为随机。
-
rest_total_hits_as_int - （可选，布尔值）如果为
true，则响应将hits.total作为整数返回。如果为 false，则将hits.total作为对象返回。默认为false。 -
routing - （可选，字符串）用于将操作路由到特定分片的自定义值。
-
scroll - （可选，时间单位）指定应为滚动搜索维护一致的索引视图多长时间。
-
search_type -
（可选，字符串）搜索操作的类型。可用选项
-
query_then_fetch -
dfs_query_then_fetch
-
-
typed_keys - （可选，布尔值）如果为
true，则响应将在聚合和建议器名称前加上其各自的类型。默认为false。
请求正文编辑
-
explain -
（可选，布尔值）如果为
true，则返回每个命中结果中有关分数计算的详细信息。默认为false。如果同时指定此参数和
explain查询参数，则 API 仅使用查询参数。