开源文档软件,首个接入 ChatGPT 的开源文档工具来了, 可用 AI 辅助生成文档

科技资讯 投稿 26900 0 评论

开源文档软件,首个接入 ChatGPT 的开源文档工具来了, 可用 AI 辅助生成文档

更新了什么

开源文档软件,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(;
}

其他说明

如果你是使用官网在线服务,则默认启动 AI 助手功能。

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

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

编程笔记 » 开源文档软件,首个接入 ChatGPT 的开源文档工具来了, 可用 AI 辅助生成文档

赞同 (34) or 分享 (0)
游客 发表我的评论   换个身份
取消评论

表情
(0)个小伙伴在吐槽