Генеративный ответ

Статья создана

Обновлена 21 октября 2024 г.

Поисковый запрос
Генеративный ответ
- Особенности ответа

Вы можете использовать текстовый поиск Search API в сочетании с генеративными возможностями YandexGPT, чтобы получить на поисковый запрос пользователя единый емкий и понятный генеративный ответ, при формировании которого нейросеть анализирует релевантные результаты текстового поиска Search API по сайтам вашей компании.

Примечание

Функциональность находится на стадии Preview.

Чтобы получить доступ к возможности генеративного ответа, заполните форму или обратитесь к вашему аккаунт-менеджеру.

В настоящий момент генеративный ответ доступен только для запросов, выполненных через интерфейс API v1.

Поисковый запрос

Запросы к сервису Search API на получение генеративного ответа отправляются методом POST на эндпоинт https://yandex.ru/search/xml/generative.

Для выполнения запросов необходим сервисный аккаунт с ролью search-api.executor и созданный для него API-ключ. Для успешной авторизации передавайте в каждом запросе идентификатор каталога и API-ключ сервисного аккаунта.

Формат запроса

Каждый запрос на получение генеративного ответа должен содержать тело запроса в формате JSON следующего вида:

{
  "messages": [
    {
      "content": "<текст_сообщения_1>",
      "role": "user"
    },
    {
      "content": "<ответ_модели_1>",
      "role": "assistant"
    },
    {
      "content": "<текст_сообщения_2>",
      "role": "user"
    },
    {
      "content": "<ответ_модели_3>",
      "role": "assistant"
    },
    ...
    {
      "content": "<текст_сообщения_n>",
      "role": "user"
    }
  ],
  "site": "<адрес_сайта_для_поиска>",
  "host": "<хост_для_поиска>",
  "url": "<страница_для_поиска>"
}

Параметры запроса

messages — одиночный поисковый запрос или поисковый запрос с контекстом в форме чата с моделью. Задается в виде массива объектов, в каждом из которых содержатся два элемента:
- content — текст запроса пользователя или ответа модели (в зависимости от значения элемента role).
- role — роль автора сообщения. Возможные значения:
  - user — означает, что автор сообщения — пользователь, а в поле content — запрос пользователя.
  - assistant — означает, что автор сообщения — модель, а в поле content — ответ модели.
Подробнее о режиме чата в YandexGPT см. в разделе Как реализовать чат с YandexGPT.
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/search-api/pricing.

Примечание

Для ограничения области поиска достаточно указать в запросе одно из полей: site, host или url.

Приоритет поля host выше, чем у поля site, а url в приоритете над host. Если в запросе передаются все три поля, область поиска будет ограничена значением поля url, а значение полей host и site будет проигнорировано.

Пример тела запроса:

{
  "messages": [
    {
      "content": "Сколько стоит Search API?",
      "role": "user"
    }
  ],
  "site": "https://yandex.cloud/ru/docs"
}

Отправка запроса

Чтобы отправить запрос, воспользуйтесь утилитой cURL или языком программирования Python. Перед отправкой запроса сохраните идентификатор каталога и API-ключ вашего сервисного аккаунта в переменные окружения:

export FOLDER_ID=<идентификатор_каталога>
export API_KEY=<API-ключ>

cURL

Python 3

curl \
  --request POST \
  --header "Authorization: Api-Key ${API_KEY}" \
  --data "@<путь_к_файлу_с_телом_запроса>" \
  "https://yandex.ru/search/xml/generative?folderid=${FOLDER_ID}"

import requests
import os

SEARCH_API_GENERATIVE = f"https://ya.ru/search/xml/generative?folderid={os.getenv('FOLDER_ID')}"


def main():
    headers = {"Authorization": f"Api-Key {os.getenv('API_KEY')}"}
    data = {
        "messages": [
           {
                "content": "Сколько стоит Search API?",
                "role": "user"
            }
        ],
        "url": "https://yandex.cloud/ru/docs/search-api/pricing"
    }

    response = requests.post(SEARCH_API_GENERATIVE, headers=headers, json=data)

    if "application/json" in response.headers["Content-Type"]:
        print(response.json()["message"]["content"])
        for i, link in enumerate(response.json()["links"], start=1):
            print(f"[{i}]: {link}")
    elif "text/xml" in response.headers["Content-Type"]:
        print("Error:", response.text)
    else:
        print("Unexpected content type:", response.text)


if __name__ == "__main__":
    main()