https://github.com/candlewill/chatscript_doc
A collection of document for ChatScript dialog engine
https://github.com/candlewill/chatscript_doc
chatbot chatscript chatscript-engine dialog dialogue-agents
Last synced: 6 months ago
JSON representation
A collection of document for ChatScript dialog engine
- Host: GitHub
- URL: https://github.com/candlewill/chatscript_doc
- Owner: candlewill
- Created: 2017-01-23T02:18:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-28T08:54:45.000Z (about 9 years ago)
- Last Synced: 2025-03-11T11:34:39.641Z (over 1 year ago)
- Topics: chatbot, chatscript, chatscript-engine, dialog, dialogue-agents
- Language: Batchfile
- Size: 12.9 MB
- Stars: 12
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ChatScript文档整理
ChatScript（下文简称CS）是一个使用C语言开发的，基于脚本的对话引擎，其代码高效，优雅。本项目用来收集[ChatScript](https://github.com/bwilcox-1234/ChatScript)的文档，以遍开发者快速上手，文档大多是英文，也有少部分是中文。
## 说明
1. 一个讲解CS原理的PPT，深入浅出，大力推荐：[Slides](./ChatScript%20Training.pdf)
2. 用手手册，非常详细长达63页: [手册](./ChatScript%20User%20Manual.pdf)
3. ChatScript官网所给的文档，原路径是：[wiki](https://github.com/bwilcox-1234/ChatScript/tree/master/WIKI)；如果不存在了，或者想集中管理，在本项目的[wiki文件夹](./wiki/)中也有已下载好的备份
4. ChatScript系统函数文档，大约37页，[ChatScript System Functions Manual](./ChatScript%20System%20Functions%20Manual.pdf)
5. ChatScript高级用户手册：[手册](./ChatScript%20Advanced%20User%20Manual.pdf)
6. [ChatScript Engine and Private Code Manual](./ChatScript%20Engine%20and%20Private%20Code%20Manual.pdf)
How the internals of the engine work and how to extend it with private code.
7. ChatScript使用JSON格式数据文档，7页: [ChatScript JSON](./ChatScript%20JSON.pdf)
这个文档主要讲述了，以JSON格式表示的事实(Facts)，如何用ChatScript操控。
更详细的一个文档，13页，见：[详细JSON](./ChatScript-Json.pdf)
8. [Chatbot Creation Options](./Chatbot%20Creation%20Options.pdf)
这是一篇论文，比较了AIML和ChatScript脚本语言各自的优缺点，总结而言：
|语言 | AIML| ChatScript|
| :------- | :---- | :--- |
| 优点| 简单| 增强模式匹配能力 |
||容易学|功能强、弹性灵活、高效|
||容易实现|文档优秀|
||存在一些预先编好的set|证实商业应用可行|
|||无需外在服务，可离线化|
||||
| 缺点|模式匹配能力弱| 难学 |
||耗时多，不好维护|无现成服务提供方，需自己集成其他组件|
||一个健壮bot需大量categories|网页端集成难|
||有限实施备选方案 ||
9. 一些ChatScript .top脚本示例：
|文件|说明|
| :------- | :---- |
|[tutorial - v0.1.top](./examples/tutorial%20-%20v0.1.top)|订票bot，使用%issue|
|[tutorial.top](./examples/tutorial.top)|订票bot，使用^respond|
10. 我们根据ChatScript提供的英文文档，整合形成了更为简洁通顺的中文文档，一方面进行知识梳理，同时便于形成体系：
入门介绍：[ChatScript 对话引擎](./ChatScript对话引擎（基础版）_v1.0.pdf)
高级特性：[ChatScript 对话引擎高级特性](./ChatScript对话引擎（高级版）.pdf)
*注意：*上述两个中文文档，我们保留翻译版权，转载使用引用等，需注明出处，谢谢
11. [Writing a Chatbot For UC Berkeley's Center for: New Media ChatScript Hackathon](./Writing%20a%20Chatbot%20For%20UC%20Berkeley's%20Center%20for%20New%20Media%20ChatScript%20Hackathon.pdf)
本文不是讲一些非常细的细节，而是之讲常用知识，从设计角度出发，让你可以快速上手开发bots。主要内容可概括为：
开发bot的流程是：1. 明确bot目标，能做什么；2. 面用什么用户；3. bot属性画像；4. 由proto script到chat script code的编写；
12. [Bot Harry - basic bot](./Bot%20Harry%20-%20basic%20bot.pdf)
本文2页内容，讲述如何对harry做一些简单修改，以便实现自己的第一个bot
13. [Winning the Loebner's](./Winning.pdf)
满满的技巧，大力推荐
14. [MAKING IT REAL: LOEBNERWINNING CHATBOT DESIGN](./ARBOR.pdf)
一篇2013年的论文，简单描述了ChatScript
15. [基于ChatScript框架的多轮对话开发](./基于ChatScript框架的多轮对话开发.pdf)
中文多轮开发
## Version
最初整理此文档时，ChatScript所处的release版本是：
[CS 7.111](https://github.com/bwilcox-1234/ChatScript/archive/7.111.tar.gz)
自2017-02-05之后，整理与更新的文档对应的ChatScript版本是：
[CS 7.12](https://github.com/bwilcox-1234/ChatScript/archive/7.12.tar.gz)
自2017-02-10之后，整理与更新的文档对应的ChatScript版本是：
[CS 7.2](https://github.com/bwilcox-1234/ChatScript/archive/7.2.tar.gz)
## 联系
何云超 (yunchaohe@gmail.com)