GitBook Integration
Let your AI assistant answer from your GitBook documentation
Обзор
The GitBook integration turns your documentation into knowledge for your AI assistant. You install Asyntai on a GitBook space, and the pages in that space become the material your assistant answers from: on your website, in your help centre and in every other channel you use.
GitBook is a knowledge source, not a channel. You do not chat with the assistant inside GitBook. Your documentation becomes the material the assistant answers from everywhere else.
Как это работает
Asyntai runs inside GitBook as an installed integration. It reads the pages of the space you installed it on, including the pages nested inside groups, and sends the text to your knowledge base. It only ever reads. It never edits, creates or deletes anything in GitBook.
Требования
- Аккаунт Asyntai. Для начала достаточно бесплатного тарифа.
- A GitBook organization with at least one space that has real text in it.
- Permission to install an integration on that organization.
Установка
Follow these steps to connect your GitBook documentation:
Find Asyntai in GitBook
In GitBook, open Integrations and choose Asyntai. Select Install.
Choose your spaces
Install it on every space, or pick the spaces you want the assistant to use. Only the spaces you choose are ever read.
Авторизовать подключение
Select Authorize. You sign in to Asyntai and choose which of your websites the pages belong to. This only has to be done once.
Дождитесь импорта
Asyntai reads the pages and adds them to your knowledge base. This takes a few seconds for a small space and a few minutes for a large one. Your assistant answers from them as soon as it finishes.
Совет: Install it on the spaces your customers ask about most: your product documentation, your help centre and your frequently asked questions. You can add other sources at any time from your Asyntai Dashboard.
Что импортируется
- The title and the text of every page in the spaces you chose
- Headings, paragraphs, lists, quotes and code blocks, in the order they appear
- Pages nested inside groups, however deep they are
- Up to 1,000 pages for each space
Что не переносится
- Any space you did not install the integration on
- Groups themselves, which are folders and hold no text of their own
- Links to other sites, which are pointers rather than content
- Почти пустые страницы, потому что они ничего не добавляют к ответу
Как поддерживать актуальность
You do not have to do anything. Every time you edit the content of a space or merge a change request, Asyntai updates the affected pages in place. Nothing is duplicated, and a page you delete in GitBook disappears from your knowledge base too.
Примеры использования
- Product documentation: visitors ask a question instead of reading through the manual
- Help centre: the answers you wrote once serve every visitor, in their own language
- API reference: developers ask how an endpoint behaves and get the answer from your own reference
- Internal handbook: your team asks a question instead of searching through nested pages
Конфиденциальность
Asyntai asks GitBook for read access only, and only to the spaces you installed it on. It never writes to your documentation. You can end the connection at any time by uninstalling the integration in GitBook, or by disconnecting it in your Asyntai dashboard, which stops the pages being sent immediately.
Тарифы и цены
The GitBook integration is available on all Asyntai plans, including Free. Each plan includes a monthly message allowance shared across all your channels and integrations. Посмотреть цены.
Удаление
Open Integrations in GitBook and uninstall Asyntai. The pages stop being sent at once. You can also disconnect it from your Asyntai dashboard, which turns off the connection from our side.
Нужна помощь?
Если у вас есть вопросы или возникли проблемы, свяжитесь с нами по адресу [email protected].