Инструмент WebSearch

В API при создании или изменении AI-ассистента передайте настройки этого инструмента в объекте genSearch в массиве tools тела запроса:

{
  ...
  "tools": [
    {
      "genSearch": {
        "options": {
          "site": {
            "site": [
              "<адрес_сайта_1_для_поиска>",
              "<адрес_сайта_2_для_поиска>",
              ...
              "<адрес_сайта_n_для_поиска>"
            ]
          },
          "host": {
            "host": [
              "<хост_1_для_поиска>",
              "<хост_2_для_поиска>",
              ...
              "<хост_n_для_поиска>"
            ]
          },
          "url": {
            "url": [
              "<страница_1_для_поиска>",
              "<страница_2_для_поиска>",
              ...
              "<страница_n_для_поиска>"
            ]
          },
          "enableNrfmDocs": true|false,
          "searchFilters": [
            {
              "date": "<дата_обновления_документов>",
              "lang": "<язык_документов>",
              "format": "<формат_документов>"
            }
          ]
        },
        "description": "<описание_инструмента>"
      }
    }
  ],
}

Где:

• В объектах site, host и url задается область поиска. Необязательный параметр. Если не задан ни один из этих объектов, поиск будет выполняться по всем сайтам в интернете.

  При этом объекты site, host и url — взаимоисключающие, задать можно только один из них:

  • site — ограничение области поиска релевантных документов по массиву сайтов.

    Например, для сайта yandex.cloud поиск будет выполняться по всем документам вида *.yandex.cloud/*. То есть в область поиска попадут документы со следующими адресами:

    • yandex.cloud/
    • subdomain.yandex.cloud/
    • yandex.cloud/path/
    • subdomain.yandex.cloud/path/

    В объекте site можно указать конкретный путь к области поиска, например, https://yandex.cloud/ru/docs.

  • host — ограничение области поиска релевантных документов по массиву хостов.

    Например, для хоста yandex.cloud/ поиск будет выполняться по всем документам вида yandex.cloud/*. То есть в область поиска попадут документы со следующими адресами:

    • yandex.cloud/
    • yandex.cloud/path/

    В отличие от ограничения области поиска в объекте site, заданное в объекте host ограничение не распространяется на поддомены. В объекте host также нельзя указать конкретный путь к области поиска.

  • url — ограничение области поиска релевантных документов по массиву страниц. Например, https://yandex.cloud/ru/docs/serverless-containers/concepts/container и https://yandex.cloud/ru/docs/container-registry/concepts/docker-image.

• enableNrfmDocs — параметр, который определяет, попадут ли в поиск документы, недоступные при прямом переходе с главной страницы. Параметр работает только в том случае, если область поиска задана объектом site. Например, если вы хотите добавить в поиск страницу, на которую нельзя перейти ни по одной из ссылок, ведущих с главной страницы сайта, то необходимо включить параметр enableNrfmDocs. Необязательный параметр. Возможные значения: true или false.

• searchFilters — дополнительный текст, который будет добавлен к каждому запросу. Используется для передачи поисковых операторов date:, mime: и lang:. Например, если указать "date": ">20250101", то в ответ на запрос будут получены только документы с датой обновления после 1 января 2025 года. Необязательный параметр. Поля date, lang и format являются взаимоисключающими — в теле запроса можно передать только одно из них.

• description — обязательное текстовое описание создаваемого инструмента WebSearch. Описание должно содержать информацию об условиях, при которых AI-ассистент должен использовать этот инструмент.