SUSI智能助手技能开发与提交指南

SUSI智能助手技能开发与提交指南

前言

SUSI是一个开源的智能助手系统，允许开发者创建和分享对话技能。本文将详细介绍如何为SUSI服务器开发自定义对话技能，并通过规范的流程提交这些技能。

开发环境准备

系统要求

在开始开发SUSI技能前，需要确保开发环境满足以下要求：

1. Java 1.8或更高版本
2. 文本编辑器（如VS Code、Sublime等）
3. 构建工具Ant
4. 版本控制系统

本地SUSI服务器搭建

1. 获取SUSI服务器代码库
2. 使用Ant构建项目
3. 通过启动脚本运行本地服务器
4. 访问本地测试接口(http://localhost:4000)

技能开发流程

理解SUSI响应机制

SUSI采用JSON格式的API响应，关键部分包括：

• query: 用户输入的查询内容
• answers: 包含回答信息的数组
  • actions: 定义SUSI执行的操作
    • type: 操作类型(如answer)
    • expression: 实际返回给用户的文本

创建Easy Dialog(EzD)技能文件

1. 在conf/susi目录下创建新的技能文件

2. 文件命名规范建议：

   • 以数字前缀排序(如000_)
   • 包含语言标识(如en)
   • 描述性名称(如tutorial)
   • 示例：000_en_tutorial.txt

3. 技能文件内容格式：

# 注释说明技能功能
:: 用户输入模式
回答内容

技能测试方法

1. 通过本地API接口测试：

   • 访问http://localhost:4000/susi/chat.json?q=测试内容
   • 检查返回的JSON中的actions部分

2. 修改技能后可能需要重启服务器才能生效

技能提交规范

技能质量要求

1. 功能完整性：确保技能能正确处理各种输入情况
2. 语言规范性：回答内容应符合目标语言的语法和习惯
3. 命名明确性：文件名应准确反映技能内容
4. 注释完整性：文件内应包含必要的注释说明

提交前检查清单

1. 所有技能都经过充分测试
2. 文件命名符合规范
3. 不包含敏感或不适当内容
4. 遵循SUSI项目的技能编写规范

最佳实践建议

1. 技能模块化：将相关技能组织在同一个文件中
2. 错误处理：考虑用户可能的各种输入方式
3. 国际化：如有必要，为不同语言创建对应版本
4. 版本控制：使用有意义的提交信息

常见问题解决

1. 技能不生效：

   • 检查文件是否放在正确目录
   • 确认服务器已重启
   • 验证文件语法是否正确

2. API返回异常：

   • 检查Java版本是否符合要求
   • 确认服务器正常运行
   • 查看服务器日志获取详细信息

通过遵循以上指南，开发者可以高效地为SUSI智能助手创建和贡献高质量的对话技能，丰富SUSI的能力范围，为更多用户提供有价值的服务。