渲染搜索应用程序查询

编辑

此功能处于技术预览阶段,可能会在未来的版本中更改或删除。Elastic 将努力解决任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 约束。

给定指定的查询参数,使用与搜索应用程序关联的搜索模板或默认模板(如果未指定)生成 Elasticsearch 查询。未指定的模板参数将被分配其默认值(如果适用)。返回通过调用搜索应用程序搜索将生成和执行的特定 Elasticsearch 查询。

请求

编辑

POST _application/search_application/<name>/_render_query

先决条件

编辑

需要对搜索应用程序的后备别名具有读取权限。

请求体

编辑
params
(可选,字符串到对象的映射)用于从与搜索应用程序关联的搜索模板生成 Elasticsearch 查询的查询参数。如果在 params 中未指定搜索模板中使用的参数,则将使用该参数的默认值。

可以配置搜索应用程序以验证搜索模板参数。有关详细信息,请参阅 put search application API 中的 dictionary 参数。

响应代码

编辑
400

传递给搜索模板的参数无效。示例包括

  • 缺少必需的参数
  • 无效的参数数据类型
  • 无效的参数值
404
搜索应用程序 <name> 不存在。

示例

编辑

以下示例为名为 my-app 的搜索应用程序生成查询,该应用程序使用来自文本搜索示例的搜索模板

resp = client.search_application.render_query(
    name="my-app",
    body={
        "params": {
            "query_string": "my first query",
            "text_fields": [
                {
                    "name": "title",
                    "boost": 5
                },
                {
                    "name": "description",
                    "boost": 1
                }
            ]
        }
    },
)
print(resp)
const response = await client.searchApplication.renderQuery({
  name: "my-app",
  body: {
    params: {
      query_string: "my first query",
      text_fields: [
        {
          name: "title",
          boost: 5,
        },
        {
          name: "description",
          boost: 1,
        },
      ],
    },
  },
});
console.log(response);
POST _application/search_application/my-app/_render_query
{
  "params": {
    "query_string": "my first query",
    "text_fields": [
      {"name": "title", "boost": 5},
      {"name": "description", "boost": 1}
    ]
  }
}

示例响应

{
  "from": 0,
  "size": 10,
  "query": {
    "multi_match": {
      "query": "my first query",
      "fields": [
        "description^1.0",
        "title^5.0"
      ]
    }
  },
  "explain": false
}

在这种情况下,请求中未指定 fromsizeexplain 参数,因此使用搜索模板中指定的默认值。