流式会话接口

阅读提示

请先阅读：大模型会话接口集成概述。

集成示例

1. 网页端接入示例：【集成示例】网页端

2. 钉钉端机器人接入示例：【集成示例】钉钉端机器人

3. 微信客服接入示例：【集成示例】微信客服

4. 企业微信接入示例：【集成示例】企业微信

5. Lark机器人接入示例：【集成示例】Lark机器人

会话接口请求

请求链接

请求链接参数说明

请求体参数（JSON）

响应参数说明

[
  {
    "type": "JSON_TEXT",
    "value": ""
  }
]

{
    "skillGroup": "12",
    "ext": "abc",
    "toAgentReason": "MultiTurnNoAnswer"
}

示例说明

请求示例

会话接口链接示例：

请求体：

{
  "messageId": "9e268624-1853-4f8b-8bd6-41a7ad818d62",
  "action":"TongyiBeebotChat",
  "version":"2022-04-08",
  "data": [
    {
      "type": "JSON_TEXT",
      "value": "{\"InstanceId\":\"chatbot-cn-dDmF3jcdVf\",\"Utterance\":\"你有什么技能？\",\"VendorParam\":\"{\\\"docLabels\\\":\\\"30022351214\\\"}\",\"Perspective\":[\"cnfKrDEfFa\",\"deasdSKoipa\"]}"
    }
  ]
}

返回示例

{
    "data": [
        {
            "type": "JSON_TEXT",
            "value": "{\"IsAIGC\":true,\"MessageBody\":{\"DirectMessageBody\":{\"AnswerReference\":{\"ItemList\":[]},\"ContentType\":\"RICH_TEXT\",\"RelatedQuestionList\":[],\"SentenceList\":[{\"Content\":\"我可以扮演各种专业角色来回答你的问题。无论你需要什么方面的专业知识，我都能尽力为你提供帮助。有什么具体问题可以问我哦！\"}]},\"Type\":\"Direct\",\"VoiceConfig\":{\"AsrMaxEndSilence\":\"700\",\"CollectNumber\":false,\"CollectVoice\":false,\"HangUp\":false,\"Interruptible\":false,\"ReplyTimeout\":5}},\"MessageId\":\"7a2c9996-64d4-4f08-8b90-5d78d43f84c7\",\"SequenceId\":\"d8d33d7fe5e244a4a37656a0d80bb003\",\"SessionId\":\"10fc717a-b2ee-4914-86a4-8f1d1f2a827c\",\"Source\":\"HYBRID_KNOWLEDGE\",\"StreamEnd\":false}"
        }
    ],
    "messageId": "9e268624-1853-4f8b-8bd6-41a7ad818d62",
    "requestId": "7a2c9996-64d4-4f08-8b90-5d78d43f84c7",
    "success": true
}

会话响应结果

返回示例中的value字段去除转义字符后得到的JSON对象。

{
    "MessageBody": {
        "DirectMessageBody": {
            "AnswerReference": {
                "ItemList": [

                ]
            },
            "ContentType": "RICH_TEXT",
            "RelatedQuestionList": [

            ],
            "SentenceList": [
                {
                    "Content": "我可以扮演各种专业角色来回答你的问题。无论你需要什么方面的专业知识，我都能尽力为你提供帮助。有什么具体问题可以问我哦！"
                }
            ]
        },
        "Type": "Direct",
        "VoiceConfig": {
            "AsrMaxEndSilence": "700",
            "CollectNumber": false,
            "CollectVoice": false,
            "HangUp": false,
            "Interruptible": false,
            "ReplyTimeout": 5
        }
    },
    "MessageId": "7a2c9996-64d4-4f08-8b90-5d78d43f84c7",
    "SequenceId": "d8d33d7fe5e244a4a37656a0d80bb003",
    "SessionId": "10fc717a-b2ee-4914-86a4-8f1d1f2a827c",
    "Source": "HYBRID_KNOWLEDGE",
    "StreamEnd": false,
    "IsAIGC": true
}

其他的响应示例

Source=TASK_DRIVEN_DIALOGUE

{
    "MessageBody":{
        "Commands":{},
        "DirectMessageBody":{
            "ContentType":"PLAIN_TEXT",
            "Ext":{
                "EXTERNAL_FLAGS":{}
            },
            "SentenceList":[
                {
                    "Content":"北京市晴，气温 8 摄氏度，东风 ≤3 级"
                }
            ]
        },
        "Type":"Direct"
    },
    "MessageId":"7a2cdb51-af56-4ac9-9c6d-108905695ac9",
    "SequenceId":"4861074fe523498ba3f397e876b60105",
    "SessionId":"f3d7e960933411ee96144bea43fe4df3",
    "Source":"TASK_DRIVEN_DIALOGUE",
    "StreamEnd":true
}

Source=NON_STRUCTURAL_KNOWLEDGE

{
    "MessageBody":{
        "DirectMessageBody":{
            "AnswerReference":{
                "ItemList":[
                    {
                        "Content":"你好",
                        "ContentType":"RICH_TEXT",
                        "DataSource":"FAQ_DIRECT",
                        "Number":1,
                        "ReferenceExt":{
                            "DocName":"FAQ知识库"
                        },
                        "Title":"你好"
                    }
                ]
            },
            "ContentType":"RICH_TEXT",
            "SentenceList":[
                {
                    "Content":"你好",
                    "ReferNumber":1
                }
            ]
        },
        "Type":"Direct"
    },
    "MessageId":"808a9cfb-2cec-4230-aad1-66c28df6040e",
    "SequenceId":"32a052f098c14769b8b81ac202f38d01",
    "SessionId":"595fa8a0940611eeb59a155f6621f5d6",
    "Source":"NON_STRUCTURAL_KNOWLEDGE",
    "StreamEnd":true
}

Source=SYSTEM_ASK_CONFIG

命中异常提示话术：HitSystemAskConfig=NO_ANSWER

{
    "MessageBody": {
        "DirectMessageBody": {
            "Ext": {},
            "AnswerReference": {
                "ItemList": []
            },
            "ContentType": "RICH_TEXT",
            "SentenceList": [
                {
                    "Content": "机器人正忙，请稍后重试"
                }
            ],
            "HitSystemAskConfig": "NO_ANSWER",
            "RelatedQuestionList": []
        },
        "VoiceConfig": {
            "ReplyTimeout": 5,
            "Interruptible": false,
            "HangUp": false,
            "AsrMaxEndSilence": "700",
            "CollectVoice": false,
            "CollectNumber": false
        },
        "Type": "Direct"
    },
    "MessageId": "6B15B50A-46D0-50DD-8EB4-5E82E931B331",
    "SequenceId": "e140735e71014ff78ee84a2692a231a4",
    "SessionId": "797acf6e-96b7-435b-9156-8a92ccefba1c",
    "Source": "SYSTEM_ASK_CONFIG",
    "StreamEnd": true,
    "IsAIGC": true
}

命中安全预设话术：HitSystemAskConfig=SENSITIVE_WORD

{
    "success": true,
    "MessageBody": {
        "DirectMessageBody": {
            "AnswerReference": {
                "ItemList": []
            },
            "ContentType": "PLAIN_TEXT",
            "HitSystemAskConfig": "SENSITIVE_WORD",
            "RelatedQuestionList": [],
            "SentenceList": [
                {
                    "Content": "您说的这个问题我不能回答您，您可以尝试询问其他问题"
                }
            ]
        },
        "Type": "Direct"
    },
    "MessageId": "d163a0b1-cce4-41c3-8502-d314f464485e",
    "SequenceId": "b7d96983212340f8ad672aee03e9c28f",
    "SessionId": "c44f27edf48246b5b95c79035cbfac33",
    "Source": "SYSTEM_ASK_CONFIG",
    "StreamEnd": true,
    "IsAIGC": true
}

命中指令：HitSystemAskConfig=COMMANDS

{
    "success": true,
    "MessageBody": {
      "Commands": {
        "sysToAgent": "{\"skillGroup\":\"\",\"ext\":\"\",\"toAgentReason\":\"HitEmotion\"}"
      },
      "DirectMessageBody": {
        "AnswerReference": {
          "ItemList": []
        },
        "ContentType": "PLAIN_TEXT",
        "HitSystemAskConfig": "COMMANDS",
        "RelatedQuestionList": [],
        "SentenceList": [
          {
            "Content": "正在为您转接人工客服"
          }
        ]
      },
      "VoiceConfig": {
        "AsrMaxEndSilence": "700",
        "CollectNumber": false,
        "CollectVoice": false,
        "HangUp": false,
        "Interruptible": false,
        "ReplyTimeout": 5
      },
      "Type": "Direct"
    },
    "MessageId": "5d7db238-7c7e-4adb-b00f-fc22183dbdda",
    "SequenceId": "2be71925e6fe4556bcfcbaaa0456e6d3",
    "SessionId": "a78f6a070a574bb69cea4ee0108b2370",
    "Source": "SYSTEM_ASK_CONFIG",
    "StreamEnd": true,
    "IsAIGC": true
}

错误码

限流错误

如果并发超过版本并发，将会触发限流，相应示例如下：

{
    "code": "csQueueBusy",
    "data": [],
    "message": "排队中:服务繁忙,请等待",
    "messageId": "203bee17-c404-4b9c-ba96-cf3873237fa0",
    "requestId": "18f80b3c-ff87-468c-b90f-0d31e4ce34b8",
    "success": false
}