流式会话接口

阅读提示

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

1 会话接口请求

1.1 请求链接

1.2 请求链接参数解释

1.3 请求体参数（JSON）

1.3.1 会话请求参数

3 响应参数说明

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

3.1 会话响应结果

3.1.1 MessageBody

3 示例

3.1 请求示例

会话接口链接：

请求体：

{
  "messageId": "9b73cec6-c6d0-4424-8427-1307eaa0b9fb",
  "action":"TongyiBeebotChat",
  "version":"2022-04-08",
  "data": [
    {
      "type": "JSON_TEXT",
      "value": "{\"InstanceId\":\"chatbot-cn-ZRmF3jbyVf\",
                \"Utterance\":\"你有什么技能？\"}"
    }
  ]
}

3.2 返回示例

{
    "data": [
        {
            "type": "JSON_TEXT",
            "value":"{\"MessageBody\":{\"DirectMessageBody\":{\"ContentType\":\"RICH_TEXT\",\"Ext\":{},\"HitSystemAskConfig\":\"GPTQA_MODEL\",\"SentenceList\":[{\"Content\":\"我作为一名人工智能助手，\"}]},\"Type\":\"Direct\"},\"MessageId\":\"d8720210-9588-4b49-b412-09648621a073\",\"SequenceId\":\"f186e72492214631a6a150b2288d269f\",\"SessionId\":\"cidu1dmqF8iUdz2gNonzzZAhsWsocstnJqThr+wp430evc=\",\"Source\":\"SYSTEM_ASK_CONFIG\",\"StreamEnd\":false}"
        }
    ],
    "messageId": "9b73cec6-c6d0-4424-8427-1307eaa0b9fb",
    "requestId": "8362abad-cde4-4350-b89a-583429d00204",
    "success": true
}

3.2.1 会话响应结果

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

{
    "MessageBody": {
        "DirectMessageBody": {
            "ContentType": "RICH_TEXT",
            "Ext": {},
            "HitSystemAskConfig": "GPTQA_MODEL",
            "SentenceList": [
                {
                    "Content": "我作为一名人工智能助手，"
                }
            ]
        },
        "Type": "Direct"
    },
    "MessageId": "d8720210-9588-4b49-b412-09648621a073",
    "SequenceId": "f186e72492214631a6a150b2288d269f",
    "SessionId": "cidu1dmqF8iUdz2gNonzzZAhsWsocstnJqThr+wp430evc=",
    "Source": "SYSTEM_ASK_CONFIG",
    "StreamEnd": false
}

3.2.2 其他的响应示例

3.2.2.1 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
}

3.2.2.2 Source=STRUCTURAL_KNOWLEDGE

{
    "MessageBody":{
      "DirectMessageBody": {
        "AnswerReference": {
          "ItemList": [
            {
              "Content": "{\"code\":\"llm-databot-card\",\"data\":{\"cellList\":[[\"学生姓名\",\"id\",\"学生id\",\"英语成绩\",\"语文成绩\",\"数学成绩\"],[\"张三\",\"4\",\"4\",\"20.0\",\"30.0\",\"40.0\"],[\"李思\",\"5\",\"6\",\"1.0\",\"3.0\",\"4.0\"],[\"王五\",\"6\",\"5\",\"0.0\",\"2.0\",\"1.0\"]],\"clickable\":false,\"drawType\":\"table\",\"nextPage\":false}}",
              "ContentType": "CARD_TEMPLATE",
              "DataSource": "EXTERNAL_DATA_SOURCE",
              "Number": 1,
              "ReferenceExt": {
                "DocName": "学生成绩表"
              },
              "Title": "学生成绩表"
            }
          ]
        },
        "CardTemplateContent": "{\"code\":\"llm-databot-card\",\"data\":\"{\\\"cellList\\\":[[\\\"学生姓名\\\"],[\\\"张三\\\"],[\\\"李思\\\"],[\\\"王五\\\"]],\\\"clickable\\\":true,\\\"drawType\\\":\\\"table\\\",\\\"nextPage\\\":false,\\\"title\\\":\\\"学生姓名 数学成绩(元数据：学生成绩表;条件：数学成绩<60)\\\"}\"}",
        "ContentType": "CARD_TEMPLATE"
      },
      "Type": "Direct",
      "VoiceConfig": {}
    },
    "MessageId":"6119d114-e53c-4259-bde5-f0d59c2244ef",
    "SequenceId":"17ae23fa40624ff6a754f1831ba9b60f",
    "SessionId":"194aa450940a11eea00ed1e090d3b275",
    "Source":"STRUCTURAL_KNOWLEDGE",
    "StreamEnd":true
}

3.2.2.3 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
}

3.2.2.4 Source=SYSTEM_ASK_CONFIG

{
    "MessageBody":{
        "DirectMessageBody":{
            "ContentType":"PLAIN_TEXT",
            "HitSystemAskConfig":"NO_ANSWER",
            "SentenceList":[
                {
                    "Content":"我还没有学会这个问题，已经记录会尽快学习为您解答，请尝试询问我其他问题"
                }
            ]
        },
        "Type":"Direct"
    },
    "MessageId":"f13833e7-9ca4-4a5b-8878-f5cc8a0a327c",
    "SequenceId":"245c39ce1f11406bb3cf60b4d017dff0",
    "SessionId":"6e7c44a0940111ee91e69d173591e2de",
    "Source":"SYSTEM_ASK_CONFIG",
    "StreamEnd":true
}

4 错误码