实时会话,通过API CreateDialog创建会话后,可使用该API进行实时会话。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dianjin:RealTimeDialog | none | *全部资源 * |
| 无 |
请求语法
POST /{workspaceId}/api/realtime/dialog/chat HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
workspaceId | string | 是 | 业务空间 Id | llm-xxxxx |
body | object | 否 | 请求体参数。 | |
bizType | string | 否 | 业务类型,默认 mixIntentChat。 | mixIntentChat |
analysis | boolean | 否 | 是否分析 | false |
recommend | boolean | 否 | 推荐意图 | false |
metaData | object | 否 | 元信息,用于封装提示词。 | { "phoneTailNumber": "机主尾号:98X1", "preScreeningQuota": "预审额度:3万", "generalInterest": "平台一般利息:20.4%" } |
stream | boolean | 否 | 是否流式返回 | false |
conversationModel | array<object> | 是 | 对话列表 | |
conversationModel | object | 否 | 对话 | |
role | integer | 是 | 角色。0 表示客户,1 表示坐席。 | 0 |
customerServiceType | string | 否 | 坐席类型,0: 机器人,1: 人工。 | 0 |
customerServiceId | string | 否 | 客服 ID,必填。 | 1374683645635 |
customerId | string | 否 | 对话角色的唯一标识,必填。 | 98457834685635 |
content | string | 是 | 对话的具体内容 | 人工客服 |
type | string | 是 | 对话内容的类型[text(文本),audio(音频),image(图片)] | audio |
beginTime | string | 否 | 这句话的开始时间 | 2024-11-08 09:51:16 |
begin | integer | 否 | 本句话的开始时间,相对于会话开始点的偏移时间 ms | 5 |
end | integer | 否 | 本句话的结束时间,相对于会话开始点的偏移时间 ms | 10 |
sessionId | string | 是 | 会话 ID | 237645726354 |
dialogMemoryTurns | integer | 否 | 携带的会话历史轮数 | 3 |
返回参数
示例
正常返回示例
JSON
格式
{
"id": "eb2b6139-ddf1-91a0-a47f-df7617ae9032",
"choices": [
{
"index": 0,
"finishReason": "stop",
"message": {
"intentionCode": "1853360771162058752",
"intentionScript": "抱歉,我没有明白您的意思,或者您可以拨打我们的客服热线,请客服人员为您解答。",
"intentionName": "其它",
"recommendIntention": "null",
"recommendScript": "null",
"analysisProcess": "null",
"selfDirectedScript": "null",
"callTime": "1735139569523",
"hangUpDialog": false,
"selfDirectedScriptFullContent": "关于宇宙的大小,这是一个非常深奥的科学话题\n"
},
"delta": {
"intentionCode": "1853360771162058752",
"intentionScript": "抱歉,我没有明白您的意思,或者您可以拨打我们的客服热线,请客服人员为您解答。",
"intentionName": "其他",
"recommendIntention": "null",
"recommendScript": "null",
"analysisProcess": "null",
"selfDirectedScript": "话题",
"callTime": "null",
"hangUpDialog": false,
"selfDirectedScriptFullContent": "关于宇宙的大小,这是一个非常深奥的科学话题"
}
}
],
"created": "1735139569523",
"success": true,
"requestId": "5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658"
}
错误码
访问错误中心查看更多错误码。