SseChat - 问答接口_大模型服务平台百炼(Model Studio)-阿里云帮助中心

SSE问答接口。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
bailianchatbot:SseChat	none	全部资源 ``	无	无

请求语法

POST /sse/bailian/chat HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID，通过控制台创建和查询，仅支持传单个 ID。	chatbot-cn-dDmF3jcdVf
Utterance	string	是	机器人访问者的输入	你有什么技能？
SessionId	string	否	会话 ID，⽤于标识⼀个访问者的会话和保持上下⽂信息。	15e04f27-acd7-489d-872f-1d68f7535e33
SenderId	string	否	访问者 ID。⽤于识别当前会话中的⽤户	uid129312098593
SenderNick	string	否	访问者昵称	张三
VendorParam	string	否	是一个 JSON 格式的用户自定义参数集（随路参数），可以传入用户自定义的参数到各对话引擎，例如：参数为单个值：{"phone":123456789} 参数为数组：{"name":["a","b","c"]} 文档标签：{"docLabels":"标签 1,标签 2"}	{"docLabels":"标签1,标签2"}
Command	string	否	请求的指令信息。当前支持传入 TIMEOUT：触发对话工厂超时话术。 GUIDEPOST：触发流程异步服务，详见异步服务使用手册。	TIMEOUT
WorkspaceId	string	是	百炼业务空间唯一标识：获取 workspaceId	llm-g7jspxljq8k909h3

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	30D68C4C-4512-58A7-A328-568015B39A02
Data	any	返回的数据。	详见返回参数补充说明
Success	boolean	是否成功	True
Message	string	错误说明	success
Code	string	结果码	200

示例说明

返回示例

{
    "MessageBody": {
        "DirectMessageBody": {
            "ContentType": "RICH_TEXT",
            "Ext": {},
            "HitSystemAskConfig": "GPTQA_MODEL",
            // 大模型输出的答案：把 SentenceList 列表每一个 content 为一个段落。
            "SentenceList": [
                {
                    "Content": "我作为一名人工智能助手，"
                }
            ]
        },
        "Type": "Direct"
    },
    "MessageId": "d8720210-9588-4b49-b412-09648621a073",
    "SequenceId": "f186e72492214631a6a150b2288d269f",
    "SessionId": "cidu1dmqF8iUdz2gNonzzZAhsWsocstnJqThr+wp430evc=",
    "Source": "SYSTEM_ASK_CONFIG",
    "StreamEnd": false
}

其他的响应示例

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

{
    "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
}

示例

正常返回示例

JSON格式

{
  "RequestId": "30D68C4C-4512-58A7-A328-568015B39A02",
  "Data": "详见返回参数补充说明",
  "Success": true,
  "Message": "success",
  "Code": 200
}

错误码

访问错误中心查看更多错误码。