Skip to main content
Ingestion API — это лёгкий способ индексировать документы. Если нужно больше контроля, рассмотрите создание коннектора в панели администратора или руководство по API Создание коннекторов.

Когда использовать Ingestion API?

Используйте Ingestion API для:
  • Неподдерживаемые источники: добавление содержимого из систем, у которых нет встроенных коннекторов
  • Дополнительные данные: добавление контекста к данным существующего коннектора (например, файлов README для GitLab)
  • Редактирование документов: изменение документов в Yahont, когда администратор не может обновить исходный документ в источнике
  • Программные рабочие процессы: встраивание индексирования документов в существующие конвейеры данных

Руководство

Если пошаговое руководство вам не нужно, перейдите к разделу Полный код. В этом примере мы проиндексируем локальные файлы с помощью Ingestion API.
Базовый URL Ingestion API — https://your-yahont-domain.com/api/onyx-api/ingestion.
Необходимое право: «Управление коннекторами и наборами документов» (manage:connectors) или «Администратор» (admin). Менеджер группы может загружать данные в пары «коннектор — учётные данные» в группах, которыми он управляет, но не в пару по умолчанию, которая публичная.
1

Подготовьте коннектор

Поскольку мы хотим, чтобы эти файлы появились на странице коннекторов, сначала нужно создать коннектор. В этом примере мы создадим коннектор File с пробным текстовым файлом.Если у вас уже есть коннектор, с которым вы хотите связать файлы Ingestion, нажмите на коннектор и скопируйте cc_pair_id из URL.https://your-yahont-domain.com/admin/connector/308 -> cc_pair_id равен 243
2

Подготовьте запрос

3

Обработайте документы в нужный объект JSON

Если вы хотите, чтобы ваши документы появились на странице коннекторов, нужно указать cc_pair_id в теле запроса!
Подробнее об объекте IngestionDocument см. в разделе Основные понятия: документы.
JSON
4

Отправьте запрос на конечную точку /ingestion

API вернёт успешный ответ, если документ принят в обработку. Само индексирование выполняется асинхронно.

Полный код

Python

Дополнительный пример

Этот скрипт обходит указанный каталог в поиске файлов JSON и отправляет их содержимое в Ingestion API.
Python