INTEGRITY Документация

NLWeb

Включите диалоговый поиск на своём сайте с помощью NLWeb и Cloudflare AI Search. Этот шаблон сканирует ваш сайт, индексирует его содержимое и разворачивает конечные точки стандарта NLWeb для обслуживания как людей, так и AI-агентов.

Что такое NLWeb

NLWeb ↗ это открытый проект Microsoft, который определяет стандартный протокол для запросов к сайтам на естественном языке. Его цель в том, чтобы сделать любой сайт таким же доступным и интерактивным, как разговорное приложение с ИИ, чтобы люди и ИИ-агенты могли надёжно запрашивать содержимое сайта. Для этого он предоставляет две ключевые конечные точки:

Как это использовать

Вы можете развернуть NLWeb на своём сайте прямо через AI Search dashboard:

  1. Войдите в свой Панель управления Cloudflare ↗.

  2. Перейдите в AI > AI Search.

    Перейдите в AI Search ↗
  3. Выберите Создайте AI Search.

  4. Выберите Сайт в качестве источника данных.

  5. Следуйте инструкциям, чтобы создать экземпляр AI Search.

  6. Перейдите в Настройки для экземпляра

  7. Найдите NLWeb Worker и выберите "Enable AI Search for your website".

После завершения AI Search развернёт для вас NLWeb Worker, который позволит использовать эндпойнты NLWeb API.

Что входит в этот шаблон

Если выбрать вариант NLWeb Website, обычный AI Search расширяется и адаптируется для сайтов с большим объёмом контента, предоставляя всё необходимое, чтобы сделать NLWeb стандартом диалогового поиска на вашем сайте. В частности, шаблон предоставляет:

Что входит в Worker

Развёрнутый Worker предоставляет два эндпойнта:

Эти эндпойнты дают людям и агентам структурированный доступ к вашему контенту.

Использование на вашем сайте

С помощью встраиваемого сниппета можно добавить интерфейс поиска прямо на свой сайт. Например:

<!-- Add css on head -->
<link rel="stylesheet" href="https://ask.example.com/nlweb-dropdown-chat.css" />
<link rel="stylesheet" href="https://ask.example.com/common-chat-styles.css" />

<!-- Add container on body -->
<div id="docs-search-container"></div>

<!-- Include JavaScript -->
<script type="module">
	import { NLWebDropdownChat } from "https://ask.example.com/nlweb-dropdown-chat.js";

	const chat = new NLWebDropdownChat({
		containerId: "docs-search-container",
		site: "https://ask.example.com",
		placeholder: "Search for docs...",
		endpoint: "https://ask.example.com",
	});
</script>

Это позволяет предоставлять диалоговый ИИ поиск прямо со своего домена и контролировать, как люди и агенты получают доступ к вашему контенту.

Изменение или обновление Worker

Иногда требуется настроить Worker, например изменить интерфейс встраиваемого сниппета. В таких случаях рекомендуем вызывать /ask эндпойнт для запросов и создание собственного пользовательского интерфейса поверх него. Однако вы также можете изменить код Worker для встраиваемого интерфейса.

Если стандарт NLWeb обновляется, вы можете обновить свой Worker, чтобы сохранить совместимость и получать последние обновления.

Проще всего применить изменения или обновления, повторно развернув шаблон Worker:

Deploy to Cloudflare

  1. Используйте Deploy to Cloudflare выше, чтобы развернуть шаблон Worker в вашем аккаунте Cloudflare.
  2. Введите название своего AI Search в RAG_ID поле переменной окружения.
  3. Нажмите Развернуть.
  4. Выберите GitHub/GitLab значок на Workers Dashboard.
  5. Клонируйте репозиторий, созданный для вашего Worker.
  6. Внесите изменения, затем сделайте commit и push, чтобы отправить их в репозиторий и обновить Worker.

Теперь вы можете использовать этот Worker в качестве нового эндпойнта NLWeb для своего сайта.