← Обзор / ai-search / get-started

REST API

Это руководство проведёт вас через создание экземпляра AI Search с помощью REST API.

Вам потребуется токен API с AI Search:Edit и AI Search:Run разрешения.

1. В панели управления Cloudflare перейдите в My Profile > API-токены.

   Перейдите в API-токены ↗

2. Выберите Create Token.

3. Выберите Create Custom Token.

4. Введите Имя токена, например AI Search Manager.

5. В разделе Разрешения, добавьте два разрешения:

   • Аккаунт > AI Search:Edit
   • Аккаунт > AI Search:Run

6. Выберите Continue to summary, затем выберите Create Token.

7. Скопируйте и сохраните значение токена. Это ваш API_TOKEN.

Используйте API для создания экземпляра и создайте инстанс. Замените <ACCOUNT_ID> с вашим ID аккаунта.

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  --data '{
    "id": "my-instance"
  }'

Вы можете создать экземпляр, подключённый к веб-сайту или бакету R2 в качестве источника данных. AI Search автоматически индексирует контент.

Сайт:

Автоматически сканируйте и индексируйте сайт которым вы владеете.

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  --data '{
    "id": "my-instance",
    "type": "web-crawler",
    "source": "example.com"
  }'

Бакет R2:

Индексация документов, хранящихся в Бакет R2. Для подключения бакета R2 требуется токен API службы. Если вы никогда раньше не создавали экземпляр на основе R2, вам нужно передать token_id поле в запросе на создание. См. настройка токена API службы для инструкций по настройке.

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  --data '{
    "id": "my-instance",
    "type": "r2",
    "source": "<R2_BUCKET_NAME>",
    "token_id": "<SERVICE_TOKEN_ID>"
  }'

Если вы не создавали экземпляр, подключённый к источнику данных, загрузите файлы с помощью API элементов. Этот шаг можно пропустить, если вы уже подключили сайт или R2 bucket.

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/my-instance/items" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -F "file=@/path/to/your/file.pdf"

AI Search автоматически индексирует загруженные файлы.

Проверьте, завершилась ли индексация вашего контента.

curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/my-instance/stats" \
  -H "Authorization: Bearer <API_TOKEN>"

После завершения индексирования выполните свой первый запрос.

curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/my-instance/search" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "content": "How do I get started?",
        "role": "user"
      }
    ]
  }'

Вы также можете тестировать запросы в dashboard, перейдя к своему экземпляру и выбрав Playground на вкладке.