mirror of
https://gitee.com/fudiwei/DotNetCore.SKIT.FlurlHttpClient.Wechat.git
synced 2026-03-10 00:13:36 +08:00
docs: 完善文档
This commit is contained in:
@@ -4,9 +4,9 @@
|
|||||||
|
|
||||||
本库提供的请求模型、响应模型和接口方法,三者均保持同名。
|
本库提供的请求模型、响应模型和接口方法,三者均保持同名。
|
||||||
|
|
||||||
例如,查询技能商店列表的请求是 `SkillStoreGetListRequest`,响应是 `SkillStoreGetListResponse`,接口是 `ExecuteSkillStoreGetListAsync()`。知道其中一个,其余两个就可以快速地推断出了。
|
例如,查看用户的客服接入状态的请求是 `KefuStateGetRequest`,响应是 `KefuStateGetResponse`,接口是 `ExecuteKefuStateGetAsync()`。知道其中一个,其余两个就可以快速地推断出了。
|
||||||
|
|
||||||
再有,每个对象的命名与官方文档的接口地址大体保持一致。例如刚刚提到的查询技能商店列表,它的接口地址是 `[POST] /skill_store/get_list`,将其中的反斜杠去掉、并以大驼峰命名法的方式调整它,就可以得到前文提到的几个对象了。
|
再有,每个对象的命名与官方文档的接口地址大体保持一致。例如刚刚提到的查看用户的客服接入状态,它的接口地址是 `[POST] kefustate/get`,将其中的反斜杠去掉、并以大驼峰命名法的方式调整它,就可以得到前文提到的几个对象了。
|
||||||
|
|
||||||
完整的模型定义可以参考项目目录下的 _src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models_ 目录。
|
完整的模型定义可以参考项目目录下的 _src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models_ 目录。
|
||||||
|
|
||||||
@@ -26,24 +26,11 @@
|
|||||||
|
|
||||||
<summary>[展开查看]</summary>
|
<summary>[展开查看]</summary>
|
||||||
|
|
||||||
| | 微信 API | 开发模式 | 备注 |
|
| | 微信 API | 备注 |
|
||||||
| :-: | :---------------------: | :--------: | :--: |
|
| :-: | :---------------------: | :--: |
|
||||||
| √ | 第三方客服接入 | 平台接入 | |
|
| √ | 智能对话接口 | |
|
||||||
| √ | 直播相关接口 | 平台接入 | |
|
| √ | 第三方客服接入 | |
|
||||||
| √ | 公众号、小程序、H5 绑定 | 平台接入 | |
|
| √ | 机器人配置 | |
|
||||||
| √ | 机器人配置 | 平台接入 | |
|
| √ | 公众号、小程序、H5 绑定 | |
|
||||||
| √ | 智能对话接口 | 平台接入 | |
|
|
||||||
| √ | NLP 接口 | 平台接入 | |
|
|
||||||
| √ | 获取令牌 | 第三方接入 | |
|
|
||||||
| √ | 通用接口 | 第三方接入 | |
|
|
||||||
| √ | 机器人 | 第三方接入 | |
|
|
||||||
| √ | 技能 | 第三方接入 | |
|
|
||||||
| √ | 意图 | 第三方接入 | |
|
|
||||||
| √ | 语义槽 | 第三方接入 | |
|
|
||||||
| √ | 词典 | 第三方接入 | |
|
|
||||||
| √ | 词条 | 第三方接入 | |
|
|
||||||
| √ | 对话开放接口 | 第三方接入 | |
|
|
||||||
| √ | 技能商店 | 第三方接入 | |
|
|
||||||
| √ | 数据统计 | 第三方接入 | |
|
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|||||||
@@ -8,12 +8,6 @@
|
|||||||
|
|
||||||
- 基于微信对话开放平台 API 封装。
|
- 基于微信对话开放平台 API 封装。
|
||||||
|
|
||||||
- 支持平台接入、第三方接入两种模式。
|
|
||||||
|
|
||||||
- 对于第三方接入,请求时自动生成加密参数,无需开发者手动干预。
|
|
||||||
|
|
||||||
- 对于平台接入,请求时自动生成请求唯一标识,无需开发者手动干预。
|
|
||||||
|
|
||||||
- 提供了解析回调通知事件等扩展方法。
|
- 提供了解析回调通知事件等扩展方法。
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -38,32 +32,22 @@
|
|||||||
using SKIT.FlurlHttpClient.Wechat;
|
using SKIT.FlurlHttpClient.Wechat;
|
||||||
using SKIT.FlurlHttpClient.Wechat.OpenAI;
|
using SKIT.FlurlHttpClient.Wechat.OpenAI;
|
||||||
|
|
||||||
/* 如果是平台接入 */
|
var options = new WechatOpenAIClientOptions()
|
||||||
var options = new WechatOpenAIPlatformClientOptions()
|
|
||||||
{
|
{
|
||||||
AppId = "微信智能对话 AppId",
|
AppId = "微信智能对话 AppId",
|
||||||
Token = "微信智能对话 Token",
|
Token = "微信智能对话 Token",
|
||||||
EncodingAESKey = "微信智能对话 EncodingAESKey"
|
EncodingAESKey = "微信智能对话 EncodingAESKey"
|
||||||
};
|
};
|
||||||
var client = new WechatOpenAIPlatformClient(options);
|
var client = new WechatOpenAIClient(options);
|
||||||
|
|
||||||
/* 如果是第三方接入 */
|
|
||||||
var options = new WechatOpenAIThirdPartyClientOptions()
|
|
||||||
{
|
|
||||||
ClientId = "微信智能对话 ClientId",
|
|
||||||
ClientKey = "微信智能对话 ClientKey"
|
|
||||||
};
|
|
||||||
var client = new WechatOpenAIThirdPartyClient(options);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 请求 & 响应:
|
### 请求 & 响应:
|
||||||
|
|
||||||
```csharp
|
```csharp
|
||||||
using SKIT.FlurlHttpClient.Wechat.OpenAI;
|
using SKIT.FlurlHttpClient.Wechat.OpenAI;
|
||||||
using SKIT.FlurlHttpClient.Wechat.OpenAI.Models.Platform;
|
using SKIT.FlurlHttpClient.Wechat.OpenAI.Models;
|
||||||
using SKIT.FlurlHttpClient.Wechat.OpenAI.Models.ThirdParty;
|
|
||||||
|
|
||||||
/* 以平台接入:发送客服消息接口为例 */
|
/* 以发送客服消息接口为例 */
|
||||||
var request = new SendMessageRequest()
|
var request = new SendMessageRequest()
|
||||||
{
|
{
|
||||||
AppId = "公众号或小程序的 AppId",
|
AppId = "公众号或小程序的 AppId",
|
||||||
@@ -74,33 +58,13 @@ var request = new SendMessageRequest()
|
|||||||
var response = await client.ExecuteSendMessageAsync(request);
|
var response = await client.ExecuteSendMessageAsync(request);
|
||||||
if (response.IsSuccessful())
|
if (response.IsSuccessful())
|
||||||
{
|
{
|
||||||
Console.WriteLine("返回消息:" + response.ErrorMessage);
|
Console.WriteLine("错误代码:" + response.ErrorCode);
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
Console.WriteLine("返回代码:" + response.ReturnCode);
|
|
||||||
Console.WriteLine("返回错误:" + response.ReturnError);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* 以第三方接入:创建机器人接口为例 */
|
|
||||||
var request = new BotSaveRequest()
|
|
||||||
{
|
|
||||||
AccessToken = "微信智能对话 X-OPENAI-TOKEN",
|
|
||||||
ChineseName = "机器人中文名",
|
|
||||||
EnglishName = "机器人英文名",
|
|
||||||
Nickname = "机器人昵称",
|
|
||||||
BotType = 0,
|
|
||||||
IndustryId = 0
|
|
||||||
};
|
|
||||||
var response = await client.ExecuteBotSaveAsync(request);
|
|
||||||
if (response.IsSuccessful())
|
|
||||||
{
|
|
||||||
Console.WriteLine("机器人 ID:" + response.Data.BotId);
|
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
Console.WriteLine("错误代码:" + response.ErrorCode);
|
Console.WriteLine("错误代码:" + response.ErrorCode);
|
||||||
Console.WriteLine("错误描述:" + response.ErrorMessage);
|
Console.WriteLine("返回代码:" + response.ReturnCode);
|
||||||
|
Console.WriteLine("返回错误:" + response.ReturnError);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user