Загрузка офлайн документации#
| Версия | Документация (zip) |
|---|---|
| v.5.185.0 | lvsm_docs_v.5.185.0 |
Документация комплекта поставки#
В данном разделе описывается пакет документации из комплекта поставки LVSM. Все документы находятся в папке "/docs" комплекта поставки.
Руководства по эксплуатации#
Нижеперечисленные руководства описывают общие процессы LVSM, архитектуру, системные требования, информацию о совместимости LUNA Vector Search Module и LUNA PLATFORM, а также примечания к выпуску.
Документы представлены в формате HTML.
| Документ | Описание |
|---|---|
| LVSM_Administrator_Manual | Руководство администратора. |
| LVSM_Release_Notes | Примечания к выпуску. |
| LVSM_System_Requirements | Системные требования. |
Руководства по установке#
Нижеперечисленные руководства описывают развертывание разными способами.
Руководства можно найти в каталоге "./docs/Installation".
Документы представлены в формате HTML.
| Документ | Описание |
|---|---|
| LVSM_Installation_Manual | Ручная установка. Описывает подготовку окружения и запуск всех Docker-контейнеров вручную на отдельном сервере. |
| LVSM_Docker_Compose_Deployment_Example | Пример развертывания с помощью Docker Compose. Описывает установку на пустой сервер с нуля с помощью примера скрипта Docker Compose из комплекта поставки. |
Справочные руководства#
В настоящее время все справочные руководства доступны только на английском языке.
Нижеприведенное руководство описывает спецификацию OpenAPI для LUNA Vector Search Module. Спецификация OpenAPI — единственный документ, предоставляющий актуальную информацию об API. Спецификация может использоваться:
- Инструментами создания документации для визуализации API.
- Инструментами генерации кода.
Все документы и код, созданные с использованием этой спецификации, могут содержать неточности, и их следует тщательно проверять.
Данное руководство расположено в директории "./docs/ReferenceManuals". В этой директории расположены документы в формате YML и HTML. Документ в формате YML содержит запросы ко всем сервисам LVSM. Его можно использовать для автоматической генерации запросов в Postman. Не гарантируется, что все запросы будут импортированы правильно, может потребоваться ручное редактирование. Документ в формате HTML используется для визуализации данных спецификации и может быть неполным.
| Руководство | Описание |
|---|---|
| LVSMReferenceManual | Описание API LUNA Vector Search Module |
Руководство для разработчиков#
Для LVSM доступно руководство разработчика. Руководство можно найти в директории "./docs/ServiceManuals".