首个接入 chatGPT 的开源文档工具来了! 可用 AI 辅助生成文档! - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
star7th
V2EX    分享创造

首个接入 chatGPT 的开源文档工具来了! 可用 AI 辅助生成文档!

  •  
  •   star7th 2023-03-03 09:08:00 +08:00 3205 次点击
    这是一个创建于 1044 天前的主题,其中的信息可能已经有所发展或是发生改变。

    地址

    官网: https://www.showdoc.com.cn

    开源地址: https://github.com/star7th/showdoc

    更新了什么

    ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有免费开源版,也有开箱可用的在线官网版。

    本次版本 v3.1.0 主要新增了 AI 助手功能,集成了 chatGPT 的能力来辅助用户生成文档内容。

    如何使用 AI 助手

    在 showdoc 的新建 /编辑页面,可以使用 AI 助手来自动补全生成一些文档内容。你可以输入一些关键字,或者几句话,然后让 AI 来帮你写完整。

    比如,你可以在输入框输入:

     请分别用 C ,C++ ,java ,php ,go ,js 生成冒泡排序代码,以 markdown 格式输出。 

    那么它就会输出几个代码块,每个代码块对应着一种语言实现的冒泡排序。

    你也可以输入:

     请根据以下关键字,生成一篇连贯的微小说,一百字左右: 地球,星空,流星,山峦,湖泊,森林 

    这样 AI 就会生成一段文字,且字数按照你的要求来生成。比如以上的关键词会生成下面的结果

     苏轻望着星空,看到流星划过夜空,他心中充满了期待与惊喜。 此时此刻,他只想要继续沉醉在大自然的宁静当中,享受这片完美的天地。 他慢慢地朝前走去,穿越山峦,来到一个绿意盎然的湖泊边,森林四周, 一片幽静。苏轻心沾湖静,感受着这片神奇的地球,他向它敬礼,以此来表达对它的尊重。 

    你甚至可以利用 AI 来做语言转换,比如:

     请把以下代码,改用 js 来实现,以 markdown 代码块输出 function send_post($url, $post_data) { $postdata = http_build_query($post_data); $optiOns= array( 'http' => array( 'method' => 'POST', 'header' => 'Content-type:application/x-www-form-urlencoded', 'content' => $postdata, 'timeout' => 15 * 60 // 超时时间(单位:s ) ) ); $cOntext= stream_context_create($options); $result = file_get_contents($url, false, $context); return $result; }; 

    得到结果(当然,太深入的代码,它生成的不会完全正确,但是在此基础上手工改正,总比从头开始写要轻松)

     // 使用 JS 实现以上功能 function send_post(url, post_data) { const postdata = new URLSearchParams(post_data).toString(); const optiOns= { method: 'POST', headers: { 'Content-Type': 'application/x-www-form-urlencoded' }, body: postdata, timeout: 15 * 60 // 超时时间(单位:s ) }; return fetch(url, options) .then(respOnse=> response.text()); } 

    其他说明

    如果你是使用官网在线服务,https://www.showdoc.com.cn/ ,则默认启动 AI 助手功能。

    如果你是部署私有版 showdoc ,你则需要有 chatGPT 账号,然后登录其官网 ,打开 https://platform.openai.com/account/api-keys 来获取 API KEY 。

    进入 showdoc 管理后台设置好 API KEY 后 ,你可能还需要解决服务器的网络问题,确保服务器正确联通 https://api.openai.com 这个地址。如果你无法解决让服务器“科学上网”的问题,可能无法使用 AI 。

    20 条回复    2023-03-07 23:56:04 +08:00
    xiaoz
        1
    xiaoz  
       2023-03-03 10:07:58 +08:00 via Android
    大佬牛逼,showdoc 简洁好用,回头我更新下。
    Wenbobobo
        2
    Wenbobobo  
       2023-03-03 11:01:41 +08:00 via Android
    坐等 obsibian (
    mydingyan
        3
    mydingyan  
       2023-03-03 11:03:44 +08:00
    已更新,但是要解决服务器的“科学上网”的问题
    star7th
        4
    star7th  
    OP
       2023-03-03 11:09:52 +08:00
    @xiaoz
    @mydingyan

    对于私有版 showdoc ,使用 AI 的难点其实在于解决服务器网络问题,要有翻墙能力。而要在服务端配置翻墙,还是有点门槛的,要多折腾一下
    xiaoz
        5
    xiaoz  
       2023-03-03 13:16:40 +08:00
    @star7th #4 ,多谢提醒,小意思。
    superliwei
        6
    superliwei  
       2023-03-03 14:12:11 +08:00
    showdoc 越来越棒了。
    Lirika
        7
    Lirika  
       2023-03-03 17:00:47 +08:00
    眼看着 showdoc 做的越来越好,真棒!
    star7th
        8
    star7th  
    OP
       2023-03-03 17:17:01 +08:00
    @superliwei
    @Lirika

    谢谢支持啊
    R6A53X
        9
    R6A53X  
       2023-03-06 14:33:22 +08:00
    支持, 为什么我使用官网在线服务,ai 生成时候,会出现一直在 《生成中..》 的现象
    star7th
        10
    star7th  
    OP
       2023-03-06 15:04:10 +08:00
    @R6A53X

    我刚去试了下,是有正常返回的。可能是你提问超时?我设置了超时时间是 10 秒。下次更新的时候给个明显的提示给用户吧
    star7th
        11
    star7th  
    OP
       2023-03-06 15:04:48 +08:00
    @R6A53X

    当大段文本或者计算量很复杂的时候,就有可能会超时。
    R6A53X
        12
    R6A53X  
       2023-03-06 18:38:32 +08:00
    @star7th 希望能继续优化,hhh 准备买个会员支持一下咯
    star7th
        13
    star7th  
    OP
       2023-03-07 08:47:52 +08:00
    @R6A53X 感谢支持
    coolair
        14
    coolair  
       2023-03-07 08:58:44 +08:00
    能不能解决下权限问题?让登录用户才能查看文档,而不是给每篇文档单独设置密码。
    star7th
        15
    star7th  
    OP
       2023-03-07 11:48:54 +08:00
    @coolair 我晚点解决这个问题。github 上也有人提了。
    kongkongye
        16
    kongkongye  
       2023-03-07 12:23:45 +08:00 via iPhone
    我以为是选中一段代码,然后点击按钮补全文档
    star7th
        17
    star7th  
    OP
       2023-03-07 13:04:56 +08:00
    @kongkongye

    从代码中生成文档,是很难的。因为不同语言不同框架有不同的使用方式。估计 AI 也无法做。而且,入参出参的描述含义等等,这些都只能人去写。就算程序辅助生成了,也还是需要人去补充。
    cnsdytedison
        18
    cnsdytedison  
       2023-03-07 13:31:48 +08:00
    有个前端的小问题,就是网页 win+左箭头键分到左边后,文档区沉下去了,没办法导航栏一起显示。这个有办法优化一下吗。 真的很棒,是会推荐别人付费购买的应用。
    star7th
        19
    star7th  
    OP
       2023-03-07 13:52:40 +08:00
    @cnsdytedison
    你分到左边后,显示的大小就变为屏幕的一半了。你在这个屏幕大小下刷新一下,重新加载页面让页面适应这个画面大小
    cnsdytedison
        20
    cnsdytedison  
       2023-03-07 23:56:04 +08:00 via Android
    @star7th 好的,谢谢(*`*)
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2753 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 29ms UTC 02:30 PVG 10:30 LAX 18:30 JFK 21:30
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86