docs: 完善文档

This commit is contained in:
Fu Diwei
2022-11-21 16:10:33 +08:00
parent 9741b34642
commit b2e421fa09
2 changed files with 15 additions and 64 deletions

View File

@@ -4,9 +4,9 @@
本库提供的请求模型、响应模型和接口方法,三者均保持同名。
例如,查询技能商店列表的请求是 `SkillStoreGetListRequest`,响应是 `SkillStoreGetListResponse`,接口是 `ExecuteSkillStoreGetListAsync()`。知道其中一个,其余两个就可以快速地推断出了。
例如,查看用户的客服接入状态的请求是 `KefuStateGetRequest`,响应是 `KefuStateGetResponse`,接口是 `ExecuteKefuStateGetAsync()`。知道其中一个,其余两个就可以快速地推断出了。
再有,每个对象的命名与官方文档的接口地址大体保持一致。例如刚刚提到的查询技能商店列表,它的接口地址是 `[POST] /skill_store/get_list`,将其中的反斜杠去掉、并以大驼峰命名法的方式调整它,就可以得到前文提到的几个对象了。
再有,每个对象的命名与官方文档的接口地址大体保持一致。例如刚刚提到的查看用户的客服接入状态,它的接口地址是 `[POST] kefustate/get`,将其中的反斜杠去掉、并以大驼峰命名法的方式调整它,就可以得到前文提到的几个对象了。
完整的模型定义可以参考项目目录下的 _src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models_ 目录。
@@ -26,24 +26,11 @@
<summary>[展开查看]</summary>
| | 微信 API | 开发模式 | 备注 |
| :-: | :---------------------: | :--------: | :--: |
| √ | 第三方客服接入 | 平台接入 | |
| √ | 直播相关接口 | 平台接入 | |
| √ | 公众号、小程序、H5 绑定 | 平台接入 | |
| √ | 机器人配置 | 平台接入 | |
| √ | 智能对话接口 | 平台接入 | |
| √ | NLP 接口 | 平台接入 | |
| √ | 获取令牌 | 第三方接入 | |
| √ | 通用接口 | 第三方接入 | |
| √ | 机器人 | 第三方接入 | |
| √ | 技能 | 第三方接入 | |
| √ | 意图 | 第三方接入 | |
| √ | 语义槽 | 第三方接入 | |
| √ | 词典 | 第三方接入 | |
| √ | 词条 | 第三方接入 | |
| √ | 对话开放接口 | 第三方接入 | |
| √ | 技能商店 | 第三方接入 | |
| √ | 数据统计 | 第三方接入 | |
| | 微信 API | 备注 |
| :-: | :---------------------: | :--: |
| √ | 智能对话接口 | |
| √ | 第三方客服接入 | |
| √ | 机器人配置 | |
| √ | 公众号、小程序、H5 绑定 | |
</details>