Kiroku：你的智能文档助手团队

在数字化办公时代，文档撰写和管理成为了日常工作中不可或缺的一部分。Kiroku，一个多智能体系统，正是一款旨在帮助用户组织和撰写文档的工具。它通过模拟学术写作的过程，让用户从构思到成文都能得到智能助手团队般的支持。本文将详细介绍Kiroku的工作原理、安装配置以及如何运行。

Kiroku简介

Kiroku的灵感来源于开发者在斯坦福大学攻读博士学位期间的学术写作经历。在这个过程中，作者和导师的角色被重新定义：作者成为导师，而多智能体系统则成为学生。这种流程带来了诸多优势，比如更有效地组织思路、通过迭代评估信息来改变沟通方式，以及利用大型语言模型（LLM）讨论复杂话题。

运行前准备

要运行Kiroku，你需要两个API密钥：OPENAI_API_KEY和TAVILY_API_KEY。

• 获取OPENAI_API_KEY：你可以访问OpenAI平台来获取你的API密钥。
• 获取TAVILY_API_KEY：访问Tavily网站并注册获取你的API密钥。

为了管理这些环境变量，你可以使用direnv这样的工具，它支持Linux、macOS和通过WSL的Windows，可以帮助你在Kiroku项目目录下自动加载这些变量。

安装与配置

Kiroku支持Python 3.7至3.11版本。以下是安装步骤：

1. 设置虚拟环境： 使用Python的venv模块创建一个隔离的环境，确保环境的清洁并避免与系统包冲突。

   bash

   cd kiroku
   python3 -m venv venv
   source venv/bin/activate
   pip install -r requirements.txt

2. 初始配置： Kiroku的初始配置在一个YAML文件中指定，包含标题建议、是否生成引用、文档类型、论文领域、章节名称、每节段落数、假设、指令、结果、引用、查询数和最大修订次数等字段。

   • 标题：建议或最终使用的标题。
   • 生成引用：如果为真，将生成引用和参考文献。
   • 文档类型：帮助Kiroku定义是否使用更多技术术语或撰写儿童故事。
   • 论文领域：与假设一起，帮助Kiroku理解要写的内容。
   • 章节名称：列出章节名称。
   • 段落数：指示Kiroku每节写多少段落。
   • 假设：告诉Kiroku你想证明的是好是坏，并定义信息。
   • 指令：与文档互动时给出的指令，比如“引言第一节应该讨论ChatGPT发布后世界的变化”。
   • 结果：你可以在这里填写结果。
   • 引用：Kiroku在搜索信息时使用的引用。
   • 查询数：告诉Kiroku将生成多少个问题给Tavily来搜索信息。
   • 最大修订次数：告诉Kiroku在分析反思结果后执行多少次反思和文档撰写。
   • 温度：LLM的温度（通常设置为较小的数字）。

运行Kiroku

推荐按照以下步骤运行Kiroku：

1. 进入Kiroku目录：

   bash

   cd {Kiroku目录所在位置}
   KIROKU_PROJECT_DIRECTORY=`pwd`/proj ./kiroku

2. 打开浏览器： 打开你的首选浏览器并访问localhost:7860。

   对于指令，你可以尝试“我喜欢标题2”或“我喜欢原标题”。

   每当你给出一个你真正喜欢的指令时，记得将其添加到指令字段。

结论

Kiroku作为一个多智能体系统，不仅能够帮助用户组织和撰写文档，还能够通过模拟学术写作的过程，提高写作效率和质量。通过智能助手团队般的支持，Kiroku使得从构思到成文的过程变得更加流畅和高效。随着技术的不断进步，Kiroku有望在未来的文档撰写和管理中发挥更大的作用，成为每个写作者不可或缺的工具。