qt-human 2.3.7-alpha → 2.3.9-alpha

package/README.md

@@ -110,12 +110,12 @@ speak(text: string, callback?: Function, opt?: {[key: string]: any}): Promise<bo
 - `opt`: 可选配置，如 `{ split: false }` 控制是否分段
 - 返回值: Promise<boolean> - 说话是否成功
 
-### ask
+### askStream
 
 进行 AI 问答
 
 ```typescript
-ask(params: QuanTe.API.AskParams, callback: (msgs: IResultData<QuanTe.API.ChatMessage[]>) => void): Promise<QuanTe.Result<QuanTe.API.AskResponse>>
+askStream(params: QuanTe.API.AskParams, callback: (msgs: IResultData<QuanTe.API.ChatMessage[]>) => void): Promise<QuanTe.Result<QuanTe.API.AskResponse>>
 ```
 
 - `params`: 问答参数
@@ -170,10 +170,9 @@ muteAction(isMute: boolean = true)
 开始录音转文本
 
 ```typescript
-startVoice2Text(callback: (data: QuanTe.Recorder.Voice2Text) => void): Promise<QuanTe.Result<QuanTe.Recorder.PermissionResult>>
+startVoice2Text(): Promise<QuanTe.Result<QuanTe.Recorder.PermissionResult>>
 ```
 
-- `callback`: 回调函数，接收语音转文本结果
 - 返回值: Promise<QuanTe.Result<QuanTe.Recorder.PermissionResult>>
 
 ### stopVoice2Text
@@ -181,9 +180,10 @@ startVoice2Text(callback: (data: QuanTe.Recorder.Voice2Text) => void): Promise<Q
 结束录音转文本
 
 ```typescript
-stopVoice2Text(): Promise<QuanTe.Result<null>>
+stopVoice2Text(callback: (data: QuanTe.Recorder.Voice2Text) => void): Promise<QuanTe.Result<null>>
 ```
 
+- `callback`: 回调函数，接收语音转文本结果
 - 返回值: Promise<QuanTe.Result<null>>
 
 ### stop
@@ -397,7 +397,7 @@ human.setCharacter('characterId');
 human.speak('你好，我是数字人');
 
 // AI问答
-human.ask({
+human.askStream({
   // 请求id,非必填
   reqId: 'abcdefg',
   message: [{ role: 'user', content: '你好' }]
@@ -414,12 +414,12 @@ human.muteAudio(true);  // 静音
 human.muteAudio(false); // 取消静音
 
 // 开始录音
-human.startVoice2Text((data: QuanTe.Recorder.Voice2Text) => {
+human.startVoice2Text()
+// 结束录音语音转文本
+human.stopVoice2Text((data: QuanTe.Recorder.Voice2Text) => {
   // 语音转文本内容
   console.log(data)
 })
-// 结束录音语音转文本
-human.stopVoice2Text()
 
 // 通过 audio 和 bs 数据驱动数字人说话
 human.speakByAudioShapes(['https://xxx/audio.wav', 'https://xxx/audio2.wav'], [[[...52个数据],[...52个数据]], [[...52个数据]]])
@@ -476,13 +476,16 @@ human.on(EmitEvent.HUMAN_READY, () => {
 ## 数字人授权接口
 
 ### 接口说明
+
 获取数字人访问令牌（token），用于初始化 Human 对象。
 
 ### 请求信息
+
 - 请求方式：POST
 - 接口地址：`https://ai.quantekeji.com/platform-api/human-auth/get-token`
 
 ### 请求参数
+
 ```typescript
 {
   // 应用秘钥（不要将秘钥保存在前端）
@@ -497,6 +500,7 @@ human.on(EmitEvent.HUMAN_READY, () => {
 ```
 
 ### 响应参数
+
 ```typescript
 {
   // 状态码：0 表示成功
@@ -510,7 +514,7 @@ human.on(EmitEvent.HUMAN_READY, () => {
 }
 ```
 
-### 使用示例
+### 代码使用示例
 
 ```typescript
 // 使用 axios 发起请求
@@ -538,13 +542,10 @@ async function getToken() {
 }
 ```
 
-### 注意事项
+### 授权接口注意事项
+
 1. secretKey 是敏感信息，不要在前端代码中直接存储，在 [qtworld](https://ai.quantekeji.com/platform/login) 平台个人中心获取
 2. visitorId 需要保证唯一性，建议使用用户ID或其他唯一标识
 3. token 有效期通常为 2 小时，过期后需要重新获取
 4. 建议在服务端调用此接口，避免暴露 secretKey
 5. 获取到 token 后，请妥善保存，用于初始化 Human 对象
-
-
-
-