› › ›

API шаблона поиска

Отображает шаблон поиска в виде тела запроса поиска.

resp = client.render_search_template(
    id="my-search-template",
    params={
        "query_string": "hello world",
        "from": 20,
        "size": 10
    },
)
print(resp)

response = client.render_search_template(
  body: {
    id: 'my-search-template',
    params: {
      query_string: 'hello world',
      from: 20,
      size: 10
    }
  }
)
puts response

const response = await client.renderSearchTemplate({
  id: "my-search-template",
  params: {
    query_string: "hello world",
    from: 20,
    size: 10,
  },
});
console.log(response);

POST _render/template
{
  "id": "my-search-template",
  "params": {
    "query_string": "hello world",
    "from": 20,
    "size": 10
  }
}

Запрос

GET _render/template

GET _render/template/<template-id>

POST _render/template

POST _render/template/<template-id>

Предварительные условия

Если включены функции безопасности Elasticsearch, у вас должна быть read привилегия доступа к индексам для хотя бы одной группы индексов.

Параметры пути

<template-id>: (Обязательно*, строка) Идентификатор шаблона поиска для рендеринга. Если не указан source, этот или параметр тела запроса id являются обязательными.

Тело запроса

id: (Обязательно*, строка) Идентификатор шаблона поиска для рендеринга. Если не указан source, этот или параметр пути запроса <template-id> являются обязательными. Если вы указали оба этих параметра, API использует только <template-id>.
params: (Необязательно, объект) Пара-значение, используемые для замены переменных Mustache в шаблоне. Ключ — имя переменной. Значение — значение переменной.
source: (Обязательно*, объект) Встроенный шаблон поиска. Поддерживает те же параметры, что и тело запроса API поиска. Эти параметры также поддерживают переменные Mustache. Если не указан id или <templated-id>, этот параметр обязателен.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/render-search-template-api.html