SkyWalking文档ChatGPT AI助手上线

1,804 阅读2分钟

长时间以来,因为项目全球化的需求和Apache软件基金会的要求,SkyWalking社区维护的中文翻译文档停留在了8.0.0版本。这份文档的已经停止更新了3年时间。在这三年里面,虽然社区有贡献者多次试图重启文档翻译,但因为项目迭代更新快,文档量巨大,造成始终无法提供完整的版本。跟随主版本持续更新,更是无法做到。所以截止目前,所有的用户都只能选择根据中文博客或者英文文档,来学习SkyWalking。

好消息是,随着2023年,AI的快速发展,理解中文并提供经过高质量分析的英中翻译文档,在技术上成为可能。

2023年12月28日,SkyWalking维护者 Superskyyy 正式向上游提交了基于kapa.ai的文档AI助手的pull request. 大家可以在skywalking.apache.org官网的右侧悬浮窗找到AI助手的入口。

image.png

kapa.ai is ChatGPT for your developer-facing product. Kapa.ai learns from your docs, tutorials, chat logs, and GitHub issues to generate an LLM-powered chatbot that answers developer questions automatically.

下面是他的pull request原文


This PR adds support for Kapa.ai thanks to the generous support from @Emil-Sorensen, the resulted effect can be previewed once built.

image.png

The position of AI button is intentional to avoid clashing with our event-popup.

image.png

So the AI docs currently cover sources including the following data for previous testing purposes, but I do intend to add more to cover all agents and side projects. Data can be priodically refreshed to catch updated info.

Docs (v9.7): skywalking.apache.org/docs/main/v…
All Open Issues: github.com/apache/skyw…
Closed Issues from last 2 year: github.com/apache/skyw…
Discussions: github.com/apache/skyw…
Blog from last 2 years: skywalking.apache.org/blog/
Java Agent docs (v9): skywalking.apache.org/docs/skywal…

The AI will work throughout the entire website, in all docs, while being able to answer only SkyWalking related questions, it will refuse to answer if off-topic.

image.png


在AI的加持下,用户不仅仅可以更智能的搜索文档,例如搜索"data expiration time"而非官方的TTL。

image.png

也可以直接直接使用中文"SkyWalking如何设置数据有效时间?"来进行提问。

image.png

当然中文搜索的准确性和反应速度,依然不如英文。

最后,希望新的工具,能帮助大家更好的使用SkyWalking功能。