服务说明

关于Web接口的说明:

1. 必须符合 websocket 协议规范（rfc6455）。
2. websocket握手成功后用户在60秒内没有发送请求数据，服务侧会主动断开。
3. 本接口默认采用短链接的模式，即接口每次将结果完整返回给用户后会主动断开链接，用户在下次发送请求的时候需要重新握手链接。

关于SDK的说明:

1. 高效接入：SDK统一封装鉴权模块，接口简单最快三步完成SDK集成接入
2. 稳定可靠： 统一连接池保障连接时效性，httpDNS保障请求入口高可用性
3. 配套完善：支持多路并发用户回调上下文绑定，交互历史管理及排障日志回传收集
4. 多平台兼容：覆盖Windows，Linux，Android，iOS以及其他交叉编译平台

**关于tokens的说明(重要)**：

1. 接口采用tokens方式计费。
2. tokens与词表、分词方案相关，没有精确的计算方式，但是接口会返回本次计费的tokens数（详见接口文档响应参数描述)。
3. 接口计费会将请求text字段下所有的content内容均计费，开发者需要酌情考虑保留的历史对话信息数量，避免浪费tokens（最大的输入tokens见接口文档参数描述）。

**关于文本审核说明(重要)**：

1. 接口会对用户输入和AI输出内容进行文本审核，会对包括但不限于：(1) 涉及国家安全的信息；(2) 涉及政治与宗教类的信息；(3) 涉及暴力与恐怖主义的信息；(4) 涉及黄赌毒类的信息；(5) 涉及不文明的信息 的输入输出赋予错误码返回（详见错误码部分10013和10014说明）

关于错误码说明

---

服务错误码：

错误码	错误信息
0	成功
10000	升级为ws出现错误
10001	通过ws读取用户的消息出错
10002	通过ws向用户发送消息 错
10003	用户的消息格式有错误
10004	用户数据的schema错误
10005	用户参数值有错误
10006	用户并发错误：当前用户已连接，同一用户不能多处同时连接。
10007	用户流量受限：服务正在处理用户当前的问题，需等待处理完成后再发送新的请求。（必须要等大模型完全回复之后，才能发送下一个问题）
10008	服务容量不足，联系工作人员
10009	和引擎建立连接失败
10010	接收引擎数据的错误
10011	发送数据给引擎的错误
10012	引擎内部错误
10013	输入内容审核不通过，涉嫌违规，请重新调整输入内容
10014	输出内容涉及敏感信息，审核不通过，后续结果无法展示给用户
10015	appid在黑名单中
10016	appid授权类的错误。比如：未开通此功能，未开通对应版本，token不足，并发超过授权 等等
10017	清除历史失败
10019	表示本次会话内容有涉及违规信息的倾向；建议开发者收到此错误码后给用户一个输入涉及违规的提示
10110	服务忙，请稍后再试
10163	请求引擎的参数异常 引擎的schema 检查不通过
10222	引擎网络异常
10907	token数量超过上限。对话历史+问题的字数太多，需要精简输入
11200	授权错误：该appId没有相关功能的授权 或者 业务量超过限制
11201	授权错误：日流控超限。超过当日最大访问量的限制
11202	授权错误：秒级流控超限。秒级并发超过授权路数限制
11203	授权错误：并发流控超限。并发路数超过授权路数限制

SDK错误码：

错误码	错误信息
18300	sdk不可用
18301	sdk没有初始化
18302	sdk初始化失败
18303	sdk已经初始化
18304	sdk不合法参数
18305	sdk会话handle为空
18306	sdk会话未找到
18307	sdk会话重复终止
18308	超时错误
18309	sdk正在初始化中
18310	sdk会话重复开启
18400	工作目录无写权限
18402	文件打开失败
18403	内存分配失败
18500	未找到该参数key
18501	参数范围溢出，不满足约束条件
18502	sdk初始化参数为空
18503	sdk初始化参数中appid为空
18504	sdk初始化参数中apiKey为空
18505	sdk初始化参数中apiSecret为空
18507	input参数为空
18509	必填参数缺失
18700	通用网络错误
18701	网路不通
18702	网关检查不过
18712	http 404错误
18801	连接建立出错
18802	结果等待超时
18311	sdk同一能力并发路数超出最大限制