API поддерживает технологические процессы для управления коллекциями и документами, обработки контента и применения возможностей ИИ, таких как ответы на вопросы, создание кратких изложений, поиск и структурированное извлечение данных. Используйте эту страницу, чтобы понять, как эти компоненты работают вместе, а затем обратитесь к справочнику API для получения подробной информации о реализации конечных точек.
Убедитесь, что у вас есть:
Если вы еще не настроили доступ к API-интерфейсу, см. раздел Настройка доступа к API-интерфейсу Knowledge Base.
Типичный рабочий процесс API-интерфейса Knowledge Base включает следующую последовательность действий:
Аутентификация → Коллекция → Документ → Индексирование → Вывод → Ответ
Коллекция определяет область знаний, с которой работает ваше приложение. При создании коллекции в ответе указывается ее уникальное пространство имен, которое используется в последующих операциях.
Например:
{
"namespace": "<collection-namespace>",
"name": "example-collection"
}
Сохраняйте пространство названий коллекции для запросов, касающихся документов и вывода.
Документы добавляются в коллекции и получают уникальные идентификаторы документов.
Ответ добавления идентифицирует документ, чтобы ваше приложение могло отслеживать обработку и ссылаться на него в последующих запросах.
{
"document_id": "<document-id>",
"document_name": "example.pdf"
}
Добавление документа и его индексирование — это отдельные этапы.
При добавлении файл передается в Knowledge Base. Индексирование извлекает содержимое файла и обрабатывает его для использования в операциях ИИ.
Ваше приложение должно подтвердить завершение обработки, прежде чем отправлять запросы на выполнение вывода по данному документу.
Операции вывода применяют возможности ИИ Knowledge Base к обработанному контенту.
Доступные операции включают:
Используйте справочник API для определения конечной точки и схемы запроса для операции, которую хотите выполнить.
Ответы вывода возвращают созданный результат и могут включать вспомогательную информацию об атрибуции.
В зависимости от операции данные атрибуции могут идентифицировать исходный контент, страницу и координаты, связанные с результатом. Ваше приложение определяет, как эта информация представляется пользователю.
Самый простой рабочий процесс приложения — создать коллекцию, добавить документ, дождаться обработки, а затем запустить операцию вывода.
Создайте коллекцию, которая будет содержать исходные документы для вашего приложения.
Сохраните пространство имен, возвращенное в ответе:
collection_namespace = <возвращенное-пространство-имен>
Вы будете использовать это значение при добавлении документов и вызове операций для коллекции.
Добавьте документ в коллекцию и сохраните возвращенный ID документа:
document_id = <returned-document-id>
ID документа идентифицирует добавленный документ независимо от его имени файла.
Запустите требуемую операцию индексации, затем проверяйте статус документа до завершения обработки.
Не предполагайте, что успешное добавление означает, что документ готов для операций ИИ.
Типичный поток приложения:
Добавить документ
↓
Запустить индексацию
↓
Проверить статус обработки
↓
Завершено
При сбое обработки, устраните проблему обработки документа перед отправкой запроса на вывод.
После завершения обработки отправьте пространство имен коллекции, ID документа и любые специфичные для операции входные данные, требуемые конечной точкой.
Например, запрос ответов на вопросы концептуально предоставляет:
Коллекция: <collection-namespace>
Документ: <document-id>
Вопрос: Каковы ключевые выводы?
Используйте справочник API для фактической схемы запроса.
Используйте полученный ответ или извлеченные данные в вашем приложении.
Если ответ включает информацию об атрибуции, вы можете использовать ее для связи созданной информации с поддерживающим содержимым документа.
Жизненный цикл документа влияет на то, когда ваше приложение может использовать добавленный контент.
| Этап | Как это работает | Действие приложения |
|---|---|---|
| Добавление | Файл добавляется в Knowledge Base и получает идентификатор документа. | Сохраните идентификатор документа. |
| Индексирование | Содержимое извлекается и обрабатывается для использования ИИ. | Отслеживайте статус документа. |
| Завершить | Обработанное содержимое доступно для вывода. | Отправляйте запросы к ИИ. |
| Не выполнено | Обработка не завершена успешно. | Устраните сбой перед продолжением. |
Это различие особенно важно для автоматизированных технологических процессов. Приложение должно проверить статус обработки, а не немедленно отправлять запрос на инференс после добавления.
Выберите операцию на основе того, что вашему приложению нужно делать с исходным содержимым.
Используйте функцию «Вопросы и ответы» для отправки вопросов на естественном языке, связанных с содержимым коллекции или документа.
API поддерживает как потоковый, так и непотоковый режим работы с вопросами и ответами.
Потоковые Q&A возвращают ответ постепенно по мере его генерации. Используйте его, когда ваш интерфейс должен отображать сгенерированный контент постепенно.
Функция потокового режима работы с вопросами и ответами также позволяет управлять применением пользовательских инструкций к запросу. Вы также можете управлять тем, генерируются ли рассуждения для потокового ответа в формате вопросов и ответов.
Непотоковые вопросы и ответы ожидают завершения генерации и возвращают готовый ответ. Используйте это, когда ваше приложение не нуждается в отображении частичного вывода.
Используйте суммирование для создания сжатого представления контента документа.
Справочник по API определяет текущие требования к запросам и поддерживаемые входные данные.
Используйте контекстный поиск для получения контента, релевантного указанному тексту поиска.
Это может помочь приложениям определить релевантный исходный материал без создания ответа в формате диалога.
Используйте извлечение, когда вашему приложению нужны структурированные значения из содержимого документа.
Определение извлечения может определять такую информацию, как:
Название свойства: contract_value
Тип: integer
Описание: стоимость соглашения
Запрос: извлечь наибольшую стоимость договора в долларах.
Возвращаемый результат может включать извлеченное значение, информацию о достоверности и ссылку на источник.
API предоставляет несколько способов определить, какое содержимое участвует в запросе.
Используйте идентификаторы коллекций и документов для определения основного содержимого, доступного для операции.
Теги связаны с документами, а не с коллекциями.
Теги документов доступны только через API-интерфейс Knowledge Base и не отображаются в стандартном пользовательском интерфейсе.
Вы можете использовать теги с поддерживаемыми операциями для фильтрации документов, рассматриваемых для запроса. Например, приложение может пометить группу документов как финансовые документы и ограничить вопрос документами с таким тегом.
Вложения отделены от документов коллекции.
Добавление вложения к диалогу не добавляет этот файл в коллекцию. Вложение все еще может предоставить контекст для созданного ответа вместе с содержимым коллекции и историей чата.
Используйте конечные точки вложений, когда приложению требуется временный или привязанный к конкретной беседе контент без его постоянного добавления в коллекцию.
Ответы на запросы вывода могут включать информацию об атрибуции, которая связывает сгенерированный результат с исходным контентом, на который опирается модель.
Данные атрибуции могут включать информацию, например:
API предоставляет эту информацию в виде данных. Ваше приложение решает, как ее представить.
Например, приложение может использовать возвращенные координаты для создания функции выделения источников, которая определяет местоположение, поддерживающее созданный ответ.
Операции API используют разрешения, доступные аутентифицированному удостоверению.
Запрос может завершиться неудачей, если у аутентифицированного субъекта нет доступа к запрашиваемой коллекции, документу или операции.
При устранении неполадок:
X-Request-ID идентифицирует запрос в службах Knowledge Base и может помочь службе поддержки исследовать неудачный запрос.
Воспользуйтесь демо-приложением на Python, если вам нужны рабочие образцы, показывающие применение этих концепций в приложении.
Начало работы с демо-приложением Knowledge Base на Python
Используйте справочник по API, когда будете готовы реализовать конкретную операцию.
