1. 接口说明

注意： 该接口可以正式使用。如您需要申请使用，请点击前往产品页面 。

Tips：

1. 计费包含接口的输入和输出内容
2. 1tokens 约等于1.5个中文汉字 或者 0.8个英文单词

1.1 请求地址

传输协议 ：ws(s),为提高安全性，强烈推荐wss

ws(s)://sparkbot.xf-yun.com/v1/retrieval/chat

#1.2 接口鉴权

参考通用URL鉴权文档

1.3 接口请求

#1.3.1 请求参数

{
    "header": {
        "app_id": "12345",
        "bot_id": "bot_12345"
    },
    "parameter": {
        "prompt": "你是一位高效的文档助手",
        "chat": {
            "temperature": 0.5,
            "max_tokens": 512,
            "chat_id":""
        },
        "repo": {
            "score": 0.3,
            "top_k": 3
        }
    },
    "payload": {
        "message": {
            "text": [
                {
                    "role": "user",
                    "content": "你好"
                },
                {
                    "role": "assistant",
                    "content": "你好，我是星火大模型"
                },
                {
                    "role": "user",
                    "content": "你知道孙悟空么？"
                }
            ]
        }
    }
}

接口请求字段由三个部分组成：header，parameter, payload。 字段解释如下

header部分

parameter部分

payload.message.text部分

注：text下所有content累计内容 tokens需要控制在8192内

1.4 接口响应

# 接口为流式返回，此示例为最后一次返回结果，开发者需要将接口多次返回的结果进行拼接展示
{
    "header": {
        "code": 0,
        "message": "Success",
        "sid": "cht000cb087@dx18793cd421fb894542",
        "status": 2
    },
    "payload": {
        "choices": {
            "status": 2,
            "seq": 0,
            "text": [
                {
                    "content": "我可以帮助你的吗？",
                    "role": "assistant",
                    "index": 0
                }
            ]
        },
        "metadata": {
            "text": [
                {
                    "source_id": "sparkbot_10693",
                    "chunk": [
                        {
                            "chunk_id": "65800d6850f22773c5ecc08c",
                            "chunk_context": "健康°C%小时强力舒眠\\\\boxed{}静音新风节能定时定时类防直吹自动8111模式开/关风速舒眠强力温度自清洁静音□过滤网复位（定时开节能上下风向定时关亮度左右风向健康智眠新风<unused3>说应急开关如果遥控器遗失或有故障时，请通过该应急开关开机或关机。明HITACHIairHome<unused4>使用说明产品使用条件1.正常使用室外温度范围表1除湿模式18℃～48℃运行模式温度范围制冷模式18℃～48℃制热模式-15℃～24℃"
                        }
                    ]
                },
                {
                    "source_id": "sparkbot_10695",
                    "chunk": [
                        {
                            "chunk_id": "65800d6850f22773c5ecc08f",
                            "chunk_context": "使用安装说明书电池安装维修卡数量1个1本2节1本附件名称螺钉组件安装附件组连接电缆组件连接管组件-5-技术参数表5型号（室内机/室外机）KFR-26GW/BpDJAKFR-26GW/BpEJAKFR-35GW/BpDJAKFR-35GW/BpEJA05相单05相单）zH（率频、相022022）V（压电定额制额定总输入功率（W）7.52.4）A（流电入输总定额额定能力范围（W）00530062）W（量冷制义名7801150使1100～3100"
                        },
                        {
                            "chunk_id": "65800d6850f22773c5ecc0d9",
                            "chunk_context": "邮编：266510客户服务热线：400-860-1111电子邮件：hhcsc@hisensehitachi.com官网：http//www.hisensehitachi.com管理号：RAK/C-SJ26PHAPC-SM0025236Brev.3(2023.04.07版）如遇产品技术信息或软件升级，恕不另行通知。合格生产日期见铭牌检<unused31>江森自控日立空调（芜湖）有限公司"
                        }
                    ]
                }
            ]
        }
    }
}

接口返回字段分为两个部分，header，payload。字段解释如下

header部分

payload.choices部分

payload.metadata部分(需要开启引用归属功能，在第一帧结果返回)