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

Публичная конечная точка

Публичные конечные точки AI Search позволяют открыть доступ к возможностям AI Search без необходимости аутентификации. Это даёт возможность встраивать AI Search в общедоступные приложения или предоставлять доступ внешним пользователям.

О готовых компонентах поиска и чата, которые можно встроить на свой сайт с помощью публичных конечных точек, см. в UI-сниппеты.

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

Включите публичные конечные точки для своего экземпляра AI Search:

  1. Перейдите в AI Search в панели управления Cloudflare. Перейдите в AI Search ↗
  2. Выберите свой экземпляр AI Search.
  3. Перейдите в Настройки > Публичная конечная точка.
  4. Включите Включить публичную конечную точку.
  5. Скопируйте URL-адрес публичной конечной точки.

О таких параметрах настройки, как ограничение скорости запросов и CORS, см. в Конфигурация публичной конечной точки.

Имена хостов конечных точек

Вы можете включить публичную конечную точку для отдельного экземпляра или для всего пространство имён. Конечная точка пространства имён обслуживает те же три пути и выполняет поиск по экземплярам, которые вы разрешили в этом пространстве имён, объединяя результаты.

Cloudflare создаёт имя хоста при включении эндпойнта:

Имя хоста Описание
<PUBLIC_ENDPOINT_ID>.search.ai.cloudflare.com Обслуживает один экземпляр.
ns-<NAMESPACE_ENDPOINT_ID>.search.ai.cloudflare.com Обслуживает пространство имён, выполняя поиск сразу по нескольким экземплярам.

Форматы запроса и ответа одинаковы для обоих вариантов. В примерах на этой странице используется имя хоста экземпляра.

Использование собственного домена

Вы можете обслуживать те же эндпойнты по имени хоста, которым владеете, например search.example.com, вместо сгенерированного:

https://search.example.com/search
https://search.example.com/chat/completions
https://search.example.com/mcp

Имя хоста должно принадлежать зоне в том же аккаунте Cloudflare. Чтобы подключить пользовательский домен:

  1. Перейдите в AI Search в панели управления Cloudflare. Перейдите в AI Search ↗
  2. Выберите свой экземпляр или пространство имён.
  3. Перейдите в Публичные конечные точки и включите публичную конечную точку. Для пользовательского домена нужна активная публичная конечная точка.
  4. Перейдите в Custom Domains и подключите своё имя хоста.

Пользовательский домен маршрутизирует запросы через вашу собственную зону, поэтому вы также можете разместить перед ним Cloudflare Access перед конечной точкой и требуйте, чтобы вызывающие стороны проходили аутентификацию, прежде чем они попадут в AI Search. Access защищает только пользовательское имя хоста, поэтому настройте default_domain_enabled к false тоже. В противном случае значение по умолчанию <PUBLIC_ENDPOINT_ID>.search.ai.cloudflare.com имя хоста продолжает отвечать на неаутентифицированные запросы.

Чтобы вместо этого привязать домен через API, см. Пользовательские домены.

Chat completions

/chat/completions эндпойнт выполняет поиск по источнику данных и генерирует ответ, используя модель и найденный контекст. Он использует тот же совместимый с OpenAI формат, что и REST API.

curl https://<PUBLIC_ENDPOINT_ID>.search.ai.cloudflare.com/chat/completions \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "content": "How do I configure AI Search?",
        "role": "user"
      }
    ]
  }'

Полный список вариантов см. в Справочник по API Chat Completions.

/search эндпойнт возвращает релевантные чанки из источника данных, не генерируя ответ. Он использует тот же формат, что и REST API.

curl https://<PUBLIC_ENDPOINT_ID>.search.ai.cloudflare.com/search \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "content": "How do I configure AI Search?",
        "role": "user"
      }
    ]
  }'

Полный список вариантов см. в Справочник по API поиска.

Следующие шаги