lsm/DotNetCore.SKIT.FlurlHttpClient.Wechat
1
0
Fork 0
mirror of https://gitee.com/fudiwei/DotNetCore.SKIT.FlurlHttpClient.Wechat.git synced 2025-12-21 19:09:58 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore(openai): 文档注释

Browse Source
This commit is contained in:
Fu Diwei
2022-11-21 13:54:47 +08:00
parent 07429761cb
commit 508ef1f72a
11 changed files with 176 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Extensions/WechatOpenAIClientExecuteBotExtensions.cs
View File

@@ -10,7 +10,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
{
/// <summary>
/// <para>异步调用 [POST] /batchimportskill/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/skill/batchimportskill.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/bot/batchimportskill.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -29,7 +29,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
/// <summary>
/// <para>异步调用 [POST] /publish/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/skill/publish.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/bot/publish.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -48,7 +48,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
/// <summary>
/// <para>异步调用 [POST] /publish_progress/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/skill/publish_progress.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/bot/publish_progress.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -67,8 +67,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
/// <summary>
/// <para>异步调用 [POST] /setautoreply/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/living/setautoreply.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/skill/publish_progress.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/bot/setautoreply.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -87,7 +86,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
/// <summary>
/// <para>异步调用 [POST] /label/batchset/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/batchsetlabel.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/bot/batchsetlabel.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>

38
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Extensions/WechatOpenAIClientExecuteDialogExtensions.cs
View File

@@ -46,6 +46,25 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
return await client.SendRequestWithJsonAsync<Models.AIBotResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
/// <summary>
/// <para>异步调用 [POST] /feedback/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/dialog/feedback.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public static async Task<Models.FeedbackResponse> ExecuteFeedbackAsync(this WechatOpenAIClient client, Models.FeedbackRequest request, CancellationToken cancellationToken = default)
{
if (client is null) throw new ArgumentNullException(nameof(client));
if (request is null) throw new ArgumentNullException(nameof(request));
IFlurlRequest flurlReq = client
.CreateRequest(request, HttpMethod.Post, "feedback", client.Credentials.Token!);
return await client.SendRequestWithJsonAsync<Models.FeedbackResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
/// <summary>
/// <para>异步调用 [POST] /gethotquerylist/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/dialog/gethotquerylist.html </para>
@@ -64,5 +83,24 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
return await client.SendRequestWithJsonAsync<Models.GetHotQueryListResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
/// <summary>
/// <para>异步调用 [POST] /gethotquerydetail/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/dialog/gethotquerydetail.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public static async Task<Models.GetHotQueryDetailResponse> ExecuteGetHotQueryDetailAsync(this WechatOpenAIClient client, Models.GetHotQueryDetailRequest request, CancellationToken cancellationToken = default)
{
if (client is null) throw new ArgumentNullException(nameof(client));
if (request is null) throw new ArgumentNullException(nameof(request));
IFlurlRequest flurlReq = client
.CreateRequest(request, HttpMethod.Post, "gethotquerydetail", client.Credentials.Token!);
return await client.SendRequestWithJsonAsync<Models.GetHotQueryDetailResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
}
}

11
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Extensions/WechatOpenAIClientExecuteMpExtensions.cs
View File

@@ -13,7 +13,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
{
/// <summary>
/// <para>异步调用 [POST] /getbindlink/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/mp/getbindlink.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/mp/getbindlink.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -32,7 +32,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
/// <summary>
/// <para>异步调用 [POST] /getbindlist/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/mp/getbindlist.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/mp/getbindlist.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -51,7 +51,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
/// <summary>
/// <para>异步调用 [POST] /unbindmp/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/mp/unbindmp.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/mp/unbindmp.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -70,7 +70,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
/// <summary>
/// <para>异步调用 [POST] /geth5link/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/mp/getbindlist.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/mp/getbindlist.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -87,10 +87,9 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
return await client.SendRequestWithJsonAsync<Models.GetH5LinkResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
/// <summary>
/// <para>异步调用 [POST] /assetsupload/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/mp/assetsupload.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/mp/assetsupload.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>

7
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Extensions/WechatOpenAIClientExecuteThirdKefuExtensions.cs
View File

@@ -10,8 +10,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
{
/// <summary>
/// <para>异步调用 [POST] /sendmsg/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/thirdkefu/sendmsg.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/sendmsg.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/thirdkefu/sendmsg.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -33,7 +32,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
/// <summary>
/// <para>异步调用 [POST] /kefustate/get/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/thirdkefu/getstate.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/thirdkefu/getstate.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@@ -55,7 +54,7 @@ namespace SKIT.FlurlHttpClient.Wechat.OpenAI
/// <summary>
/// <para>异步调用 [POST] /kefustate/change/{TOKEN} 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/platform/thirdkefu/getstate.html </para>
/// <para>REF: https://developers.weixin.qq.com/doc/aispeech/confapi/thirdkefu/changestate.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>

29
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models/Dialog/FeedbackRequest.cs Normal file
View File

@@ -0,0 +1,29 @@
using System.Xml.Serialization;
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
{
/// <summary>
/// <para>表示 [POST] /feedback/{TOKEN} 接口的请求。</para>
/// </summary>
[XmlRoot("xml")]
public class FeedbackRequest : WechatOpenAIRequest, WechatOpenAIRequest.Serialization.IEncryptedXmlable
{
/// <summary>
/// 获取或设置消息 ID。
/// </summary>
[XmlElement("msgid")]
public string MessageId { get; set; } = string.Empty;
/// <summary>
/// 获取或设置反馈结果。
/// </summary>
[XmlElement("feedbackResult")]
public int FeedbackResult { get; set; }
/// <summary>
/// 获取或设置用户反馈时间戳。
/// </summary>
[XmlElement("updateAt")]
public long UpdateTimestamp { get; set; }
}
}

22
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models/Dialog/FeedbackResponse.cs Normal file
View File

@@ -0,0 +1,22 @@
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
{
/// <summary>
/// <para>表示 [POST] /feedback/{TOKEN} 接口的响应。</para>
/// </summary>
public class FeedbackResponse : WechatOpenAIResponse
{
/// <summary>
/// <inheritdoc/>
/// </summary>
[Newtonsoft.Json.JsonProperty("code")]
[System.Text.Json.Serialization.JsonPropertyName("code")]
public override int? ReturnCode { get; set; }
/// <summary>
/// 获取微信智能对话 API 返回的错误描述。
/// </summary>
[Newtonsoft.Json.JsonProperty("msg")]
[System.Text.Json.Serialization.JsonPropertyName("msg")]
public string? ReturnMessage { get; set; }
}
}

16
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models/Mp/AssetsUploadResponse.cs
View File

@@ -1,10 +1,24 @@
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
{
/// <summary>
/// <para>表示 [POST] /assetsupload/{TOKEN} 接口的响应。</para>
/// </summary>
public class AssetsUploadResponse : WechatOpenAIResponse
{
/// <summary>
/// <inheritdoc/>
/// </summary>
[Newtonsoft.Json.JsonProperty("code")]
[System.Text.Json.Serialization.JsonPropertyName("code")]
public override int? ReturnCode { get; set; }
/// <summary>
/// 获取微信智能对话 API 返回的错误描述。
/// </summary>
[Newtonsoft.Json.JsonProperty("msg")]
[System.Text.Json.Serialization.JsonPropertyName("msg")]
public string? ReturnMessage { get; set; }
/// <summary>
/// 获取或设置文件标识。
/// </summary>

16
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models/Mp/GetBindLinkResponse.cs
View File

@@ -1,10 +1,24 @@
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
{
/// <summary>
/// <para>表示 [POST] /getbindlink/{TOKEN} 接口的响应。</para>
/// </summary>
public class GetBindLinkResponse : WechatOpenAIResponse
{
/// <summary>
/// <inheritdoc/>
/// </summary>
[Newtonsoft.Json.JsonProperty("code")]
[System.Text.Json.Serialization.JsonPropertyName("code")]
public override int? ReturnCode { get; set; }
/// <summary>
/// 获取微信智能对话 API 返回的错误描述。
/// </summary>
[Newtonsoft.Json.JsonProperty("msg")]
[System.Text.Json.Serialization.JsonPropertyName("msg")]
public string? ReturnMessage { get; set; }
/// <summary>
/// 获取或设置绑定链接 URL。
/// </summary>

16
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models/Mp/GetBindListResponse.cs
View File

@@ -1,10 +1,24 @@
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
{
/// <summary>
/// <para>表示 [POST] /getbindlist/{TOKEN} 接口的响应。</para>
/// </summary>
public class GetBindListResponse : WechatOpenAIResponse
{
/// <summary>
/// <inheritdoc/>
/// </summary>
[Newtonsoft.Json.JsonProperty("code")]
[System.Text.Json.Serialization.JsonPropertyName("code")]
public override int? ReturnCode { get; set; }
/// <summary>
/// 获取微信智能对话 API 返回的错误描述。
/// </summary>
[Newtonsoft.Json.JsonProperty("msg")]
[System.Text.Json.Serialization.JsonPropertyName("msg")]
public string? ReturnMessage { get; set; }
/// <summary>
/// 获取或设置绑定列表。
/// </summary>

16
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models/Mp/GetH5LinkResponse.cs
View File

@@ -1,10 +1,24 @@
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
{
/// <summary>
/// <para>表示 [POST] /geth5link/{TOKEN} 接口的响应。</para>
/// </summary>
public class GetH5LinkResponse : WechatOpenAIResponse
{
/// <summary>
/// <inheritdoc/>
/// </summary>
[Newtonsoft.Json.JsonProperty("code")]
[System.Text.Json.Serialization.JsonPropertyName("code")]
public override int? ReturnCode { get; set; }
/// <summary>
/// 获取微信智能对话 API 返回的错误描述。
/// </summary>
[Newtonsoft.Json.JsonProperty("msg")]
[System.Text.Json.Serialization.JsonPropertyName("msg")]
public string? ReturnMessage { get; set; }
/// <summary>
/// 获取或设置机器人链接 URL。
/// </summary>

15
src/SKIT.FlurlHttpClient.Wechat.OpenAI/Models/Mp/UnbindMpResponse.cs
View File

@@ -1,9 +1,22 @@
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
namespace SKIT.FlurlHttpClient.Wechat.OpenAI.Models
{
/// <summary>
/// <para>表示 [POST] /unbindmp/{TOKEN} 接口的响应。</para>
/// </summary>
public class UnbindMpResponse : WechatOpenAIResponse
{
/// <summary>
/// <inheritdoc/>
/// </summary>
[Newtonsoft.Json.JsonProperty("code")]
[System.Text.Json.Serialization.JsonPropertyName("code")]
public override int? ReturnCode { get; set; }
/// <summary>
/// 获取微信智能对话 API 返回的错误描述。
/// </summary>
[Newtonsoft.Json.JsonProperty("msg")]
[System.Text.Json.Serialization.JsonPropertyName("msg")]
public string? ReturnMessage { get; set; }
}
}