Interface IBot

interface IBot {
    createConversation?(): Promise<CreateConversationOutput>;
    deleteConversation?(
        input: DeleteConversationInput,
    ): Promise<DeleteConversationOutput>;
    getBotInfo?(): Promise<GetBotInfoOutput>;
    getChatRecords?(input: GetChatRecordInput): Promise<GetChatRecordOutput>;
    getConversation?(
        input: GetConversationInput,
    ): Promise<GetConversationOutput>;
    getFeedback?(input: GetFeedbackInput): Promise<GetFeedbackOutput>;
    getRecommendQuestions?(input: GetRecommendQuestionsInput): Promise<void>;
    getTextToSpeechResult?(
        input: GetTextToSpeechResultInput,
    ): Promise<GetTextToSpeechResultOutput>;
    sendFeedback?(input: SendFeedbackInput): Promise<SendFeedbackOutput>;
    sendMessage(input: SendMessageInput): Promise<void>;
    speechToText?(input: SpeechToTextInput): Promise<SpeechToTextOutput>;
    textToSpeech?(input: TextToSpeechInput): Promise<TextToSpeechOutput>;
    updateConversation?(
        input: UpdateConversationInput,
    ): Promise<UpdateConversationOutput>;
    wxSendMessage(input: WxSendMessageInput): Promise<WeChatTextOutput>;
}

Index

Methods

createConversation? deleteConversation? getBotInfo? getChatRecords? getConversation? getFeedback? getRecommendQuestions? getTextToSpeechResult? sendFeedback? sendMessage speechToText? textToSpeech? updateConversation? wxSendMessage

Methods

`Optional`createConversation

createConversation?(): Promise<CreateConversationOutput>
conversation - POST /v1/aibot/bots/:botId/conversation

创建会话

Returns Promise<CreateConversationOutput>
- Defined in bot.ts:122

`Optional`deleteConversation

deleteConversation?(
input: DeleteConversationInput,
): Promise<DeleteConversationOutput>
conversation - DELETE /v1/aibot/bots/:botId/conversation/:conversation

删除会话
Parameters
- input: DeleteConversationInput
Returns Promise<DeleteConversationOutput>
- Defined in bot.ts:149

`Optional`getBotInfo

getBotInfo?(): Promise<GetBotInfoOutput>
getBotInfo - GET /v1/aibot/bots/:botId

获取 Agent 配置实现，返回 Agent 信息

微信基础库 wx.cloud.extend.AI.bot.get API对应接口 https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/reference-sdk-api/extend/ai.html#AI-bot-get

Returns Promise<GetBotInfoOutput>
Link
https://docs.cloudbase.net/http-api/ai-bot/get-bot-info
- Defined in bot.ts:86

`Optional`getChatRecords

getChatRecords?(input: GetChatRecordInput): Promise<GetChatRecordOutput>
getChatRecords - GET /v1/aibot/bots/:botId/records

查询 Agent 历史对话信息接口实现，返回历史对话记录。

注意：需在 sendMessage 接口中实现记录对话信息，并在此接口查询对话信息并中返回

微信基础库 wx.cloud.extend.AI.bot.getChatRecords API对应接口 https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/reference-sdk-api/extend/ai.html#AI-bot-getChatRecords
Parameters
- input: GetChatRecordInput
Returns Promise<GetChatRecordOutput>
Link
https://docs.cloudbase.net/http-api/ai-bot/get-chat-history
- Defined in bot.ts:38

`Optional`getConversation

getConversation?(input: GetConversationInput): Promise<GetConversationOutput>
conversation - GET /v1/aibot/bots/:botId/conversation?limit=10&offset=0

查询会话
Parameters
- input: GetConversationInput
Returns Promise<GetConversationOutput>
- Defined in bot.ts:131

`Optional`getFeedback

getFeedback?(input: GetFeedbackInput): Promise<GetFeedbackOutput>
getFeedback - GET /v1/aibot/bots/:botId/feedback

获取用户反馈接口实现，返回用户反馈列表

微信基础库 wx.cloud.extend.AI.bot.getFeedBack API对应接口 https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/reference-sdk-api/extend/ai.html#AI-bot-getFeedBack
Parameters
- input: GetFeedbackInput
Returns Promise<GetFeedbackOutput>
Link
https://docs.cloudbase.net/http-api/ai-bot/get-feedback
- Defined in bot.ts:74

`Optional`getRecommendQuestions

getRecommendQuestions?(input: GetRecommendQuestionsInput): Promise<void>
getRecommendQuestions - POST /v1/aibot/bots/:botId/recommend-questions

获取推荐问题接口实现，返回推荐问题列表

微信基础库 wx.cloud.extend.AI.bot.getRecommendQuestions API对应接口 https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/reference-sdk-api/extend/ai.html#AI-bot-getRecommendQuestions
Parameters
- input: GetRecommendQuestionsInput
Returns Promise<void>
Link
https://docs.cloudbase.net/http-api/ai-bot/get-recommend-questions
- Defined in bot.ts:50

`Optional`getTextToSpeechResult

getTextToSpeechResult?(
input: GetTextToSpeechResultInput,
): Promise<GetTextToSpeechResultOutput>
text-to-speech - GET /v1/aibot/bots/:botId/text-to-speech

获取文字转语音结果
Parameters
- input: GetTextToSpeechResultInput
Returns Promise<GetTextToSpeechResultOutput>
Link
https://docs.cloudbase.net/http-api/ai-bot/get-text-to-speech-result
- Defined in bot.ts:113

`Optional`sendFeedback

sendFeedback?(input: SendFeedbackInput): Promise<SendFeedbackOutput>
sendFeedback - POST /v1/aibot/bots/:botId/feedback

发送用户反馈接口实现，返回发送用户反馈结果

微信基础库 wx.cloud.extend.AI.bot.sendFeedback API对应接口 https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/reference-sdk-api/extend/ai.html#AI-bot-sendFeedback
Parameters
- input: SendFeedbackInput
Returns Promise<SendFeedbackOutput>
Link
https://docs.cloudbase.net/http-api/ai-bot/send-feedback
- Defined in bot.ts:62

sendMessage

sendMessage(input: SendMessageInput): Promise<void>
sendMessage - POST /v1/aibot/bots/:botId/send-message

与 Agent 问答对话接口实现，该接口无返回值，接口内需要通过 this.sseSender 发送 Server-Sent Events 给客户端

微信基础库 wx.cloud.extend.AI.bot.sendMessage API对应接口 https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/reference-sdk-api/extend/ai.html#AI-bot-sendMessage
Parameters
- input: SendMessageInput
  发送消息的输入
Returns Promise<void>
Link
https://docs.cloudbase.net/http-api/ai-bot/send-message
- Defined in bot.ts:22

`Optional`speechToText

speechToText?(input: SpeechToTextInput): Promise<SpeechToTextOutput>
speechToText - POST /v1/aibot/bots/:botId/speechToText

语音转文字
Parameters
- input: SpeechToTextInput
Returns Promise<SpeechToTextOutput>
Link
https://docs.cloudbase.net/http-api/ai-bot/speech-to-text
- Defined in bot.ts:95

`Optional`textToSpeech

textToSpeech?(input: TextToSpeechInput): Promise<TextToSpeechOutput>
text-to-speech - POST /v1/aibot/bots/:botId/text-to-speech

文字转语音
Parameters
- input: TextToSpeechInput
Returns Promise<TextToSpeechOutput>
Link
https://docs.cloudbase.net/http-api/ai-bot/text-to-speech
- Defined in bot.ts:104

`Optional`updateConversation

updateConversation?(
input: UpdateConversationInput,
): Promise<UpdateConversationOutput>
conversation - PATCH /v1/aibot/bots/:botId/conversation/:conversation

更新会话
Parameters
- input: UpdateConversationInput
Returns Promise<UpdateConversationOutput>
- Defined in bot.ts:140

wxSendMessage

wxSendMessage(input: WxSendMessageInput): Promise<WeChatTextOutput>
Parameters
- input: WxSendMessageInput
Returns Promise<WeChatTextOutput>
- Defined in bot.ts:24

Interface IBot

Index

Methods

Methods

OptionalcreateConversation

Returns Promise<CreateConversationOutput>

OptionaldeleteConversation

Parameters

Returns Promise<DeleteConversationOutput>

OptionalgetBotInfo

Returns Promise<GetBotInfoOutput>

Link

OptionalgetChatRecords

Parameters

Returns Promise<GetChatRecordOutput>

Link

OptionalgetConversation

Parameters

Returns Promise<GetConversationOutput>

OptionalgetFeedback

Parameters

Returns Promise<GetFeedbackOutput>

Link

OptionalgetRecommendQuestions

Parameters

Returns Promise<void>

Link

OptionalgetTextToSpeechResult

Parameters

Returns Promise<GetTextToSpeechResultOutput>

Link

OptionalsendFeedback

Parameters

Returns Promise<SendFeedbackOutput>

Link

sendMessage

Parameters

Returns Promise<void>

Link

OptionalspeechToText

Parameters

Returns Promise<SpeechToTextOutput>

Link

OptionaltextToSpeech

Parameters

Returns Promise<TextToSpeechOutput>

Link

OptionalupdateConversation

Parameters

Returns Promise<UpdateConversationOutput>

wxSendMessage

Parameters

Returns Promise<WeChatTextOutput>

Settings

On This Page

`Optional`createConversation

`Optional`deleteConversation

`Optional`getBotInfo

`Optional`getChatRecords

`Optional`getConversation

`Optional`getFeedback

`Optional`getRecommendQuestions

`Optional`getTextToSpeechResult

`Optional`sendFeedback

`Optional`speechToText

`Optional`textToSpeech

`Optional`updateConversation