← Обзор / ai-search / api / items
REST API
Используйте REST API AI Search, чтобы загружать, просматривать и управлять отдельными документами в рамках экземпляра.
Аутентификация
Для всех запросов требуется токен API с AI Search:Edit и AI Search:Run разрешения.
-
В панели управления Cloudflare перейдите в My Profile > API-токены.
Перейдите в API-токены ↗ -
Выберите Create Token.
-
Выберите Create Custom Token.
-
Введите Имя токена, например
AI Search Manager. -
В разделе Разрешения, добавьте два разрешения:
- Аккаунт > AI Search:Edit
- Аккаунт > AI Search:Run
-
Выберите Continue to summary, затем выберите Create Token.
-
Скопируйте и сохраните значение токена. Это ваш
API_TOKEN.
Включите токен в Authorization заголовок для всех запросов:
Authorization: Bearer <API_TOKEN>Пути API
API AI Search доступны по двум базовым путям:
| Путь | Описание |
|---|---|
/accounts/{account_id}/ai-search/instances/{id}/ |
Работает с конкретным экземпляром |
/accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/ |
Работает с экземплярами в пределах пространство имён |
Доступные операции одинаковы для обоих путей. Для API в контексте пространства имён см. Справочник по API пространства имён.
Элементы
Загружайте, получайте списки, извлекайте, удаляйте и скачивайте элементы в экземпляре. Полную спецификацию см. в Справочник по API элементов.
| Операция | Метод | Описание |
|---|---|---|
| Загрузить | POST |
Загрузка документа для индексирования |
| Список | GET |
Получить список всех элементов в экземпляре |
| Получить | GET |
Получить информацию об элементе по ID |
| Удалить | DELETE |
Удаление элемента |
| Скачать | GET |
Скачать исходный файл |
Пример: загрузка документа
Загрузите файл в экземпляр:
curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/items" \
-H "Authorization: Bearer <API_TOKEN>" \
-F "file=@/path/to/your/file.pdf"Пример: получение списка элементов
Получите список всех элементов в экземпляре:
curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/items" \
-H "Authorization: Bearer <API_TOKEN>"Чтобы найти один элемент по точному ключу объекта, передайте key параметр query:
curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/items?key=docs/readme.md" \
-H "Authorization: Bearer <API_TOKEN>"Ключи уникальны в пределах источника данных, поэтому объединяйте key с source (например, source=builtin) чтобы устранить неоднозначность, когда один и тот же ключ встречается в нескольких источниках.