大模型和TTS服务参考API

API时序图

接口说明

Websocket OpenAPI

• URL
  例如：wss://test/api/v1/chat

• Query

示例
wss://test/api/v1/chat?deviceId=12345678

对话事件

上行事件

提交文本

• 事件类型：input_text
• 事件说明：提交文本内容。
• 事件结构：

• 事件示例

  {
  "id": "event_id",
  "event_type": "input_text",
  "deviceId": "12345678",
  "question": "你是谁？",
  "stream": true
  }

打断智能体输出

• 事件类型：conversation.chat.cancel
• 事件说明：发送此事件可取消正在进行的对话，中断后，服务端将会返回 conversation.chat.canceled 事件。
• 事件结构：

• 事件示例

  {
  "id": "event_id",
  "event_type": "conversation.chat.cancel"
  }

下行事件

对话连接成功

• 事件类型：chat.created
• 事件说明：流式对话接口成功建立连接后服务端会发送此事件。
• 事件结构：

• 事件示例

  {
    "id": "7446668538246561xxxx",
    "event_type": "chat.created",
    "detail": {
        "logid": "20241210152726467C48D89D6DB2F3***"    }
  }

对话开始

• 事件类型：conversation.chat.created
• 事件说明：创建对话的事件，表示对话开始。
• 事件结构：

• 事件示例

  {
  "id": "744666853824656xxx",
  "event_type": "conversation.chat.created",
  "data": {
      "id": "123",
      "conversation_id": "123"
  },
  "detail": {
      "logid": "20241210152726467C48D89D6DB2F3***"
  }    
  }

增量消息

• 事件类型：conversation.message.delta
• 事件说明：增量消息，通常是 type=answer 时的增量消息。
• 事件结构：

• 事件示例

  {
  "id": "event_1",
  "event_type": "conversation.message.delta",
  "data": {
      "id": "msg_006",
      "conversation_id": "123",
      "type": "answer",
      "content": "你好你好"
  },
  "detail": {
      "logid": "20241210152726467C48D89D6DB2F3***"
  }
  }

增量语音

• 事件类型：conversation.audio.delta
• 事件说明：增量语音，通常是 type=answer 时的增量语音。
• 事件结构：

• 事件示例

  {
  "id": "event_1",
  "event_type": "conversation.audio.delta",
  "data": {
      "id": "msg_006",
      "type": "answer",
      "content": "base64audio",
      "conversation_id": "123"
  },
  "detail": {
      "logid": "20241210152726467C48D89D6DB2F3***"
  }
  }

消息完成

• 事件类型：conversation.message.completed
• 事件说明：消息已回复完成。
• 事件结构：

• 事件示例

  {
  "id": "event_1",
  "event_type": "conversation.message.completed",
  "data": {
    "id": "msg_002",
    "conversation_id": "123"
  },
  "detail": {
      "logid": "20241210152726467C48D89D6DB2F3***"
  }
  }

语音回复完成

• 事件类型：conversation.audio.completed
• 事件说明：音频回复完成。
• 事件结构：

• 事件示例

  {
  "id": "event_1",
  "event_type": "conversation.audio.completed",
  "data": {
    "id": "msg_002",
    "conversation_id": "123"
  },
  "detail": {
      "logid": "20241210152726467C48D89D6DB2F3***"
  }
  }

对话完成

• 事件类型：conversation.chat.completed
• 事件说明：表示对话已完成。
• 事件结构：

• 事件示例

  {
  "id": "event_1",
  "event_type": "conversation.chat.completed",
  "data": {
    "id": "123",
    "conversation_id": "123"
  },
  "detail": {
      "logid": "20241210152726467C48D89D6DB2F3***"
  }   
  }

对话失败

• 事件类型：conversation.chat.failed
• 事件说明：此事件用于标识对话失败。
• 事件结构：

• 事件示例

  {
  "id": "event_1",
  "event_type": "conversation.chat.failed",
  "data": {
      "id": "123",
      "conversation_id": "123",
      "last_error": {
          "code": 1,
          "msg": "发生异常"
      }
  },
  "detail": {
      "logid": "20241210152726467C48D89D6DB2F3***"
  }   
  }

发生错误

• 事件类型：error
• 事件说明：对话过程中的错误事件。
• 事件结构：

• 事件示例

  {
  "id": "event_1",
  "event_type": "error",
  "data": {
      "code": 1,
      "msg": "发生异常"
  },
  "detail": {
      "logid": "20241210152726467C48D89D6DB2F3***"
  }
  }

智能体输出中断

• 事件类型：conversation.chat.canceled
• 事件说明：客户端提交 conversation.chat.cancel 事件，服务端完成中断后，将返回此事件。
• 事件结构：

• 事件示例

  {
  "id": "event_id",
  "event_type": "conversation.chat.canceled",
  "detail": {
      "logid": "20241210152726467C48D89D6DB2F3***"
  }
  }