目录
服务商基于会话内容实现的产品功能中,有部分为对消息内容的AI分析。针对该部分功能,企业微信提供了数据分析专区的方案,服务商可将代码打包成镜像部署到企业微信的数据分析专区,数据分析专区与外界网络隔离,只能通过专属网络访问专区接口,以拉取消息内容到专区服务上进行分析。既保证服务商功能的完整性,同时保证数据的安全性。数据分析专区整体架构如下图所示:
合作伙伴可按照以下流程接入:
数据分析专区接口包含任务管理以及专区接口,其中任务管理接口由服务商后台调用,专区接口由专区调用。接口列表如下:
序号 | 接口 | 接口描述 | 调用来源 |
---|---|---|---|
1 | 创建任务 | 由服务商后台调用,创建专区执行的任务 | ● 服务商后台 |
2 | 获取任务结果 | 由服务商后台调用,获取专区任务执行状态以及结果 | ● 服务商后台 |
3 | 获取数据分析专区接口调用凭证 | 通过专区secret获取专区专用access_token | ● 数据分析专区 |
4 | 轮训获取任务 | 轮训到未执行的任务 | ● 数据分析专区 |
5 | 执行任务以及上报进度或结果 | 上报任务执行进度以及结果 | ● 数据分析专区 |
6 | 拉取消息 | 拉取消息明文内容 | ● 数据分析专区 |
7 | 下载消息素材 | 下载多媒体资源内容 | ● 数据分析专区 |
数据分析专区接口调用流程如下图所示:
步骤1.1 获取数据分析专区接口调用凭证 接口中的secret可由服务商管理端「数据分析专区」- 「镜像管理」中查看
步骤2.1 创建任务 时可指定需要分析的消息列表,该列表可通过会话存档接口授权中的 获取会话记录 接口获取。
● 网络限制
专区内的服务只能访问专用的接口服务
● 资源和权限限制
挂载的文件只读、独立的本地CBS磁盘(目前处于免费试用阶段,旨在供服务商调通功能,故机器资源相对有限)
● 日志限制
服务执行日志直接打到标准输出,专区框架层自动收集。每个小时一个日志文件,单个日志文件不超过1G,若达到1G的上限,后续的日志将被丢弃,直到下一个小时才生成新的文件。
日志格式:
任务id,时间,程序文件名,程序行号,错误码
日志字段 | 说明 | 长度限制(字节) |
---|---|---|
任务id | 轮询任务拿到的jobid,非法丢弃该行日志 | - |
时间 | 仅支持格式2024-01-01 10:00:01,非法丢弃该行日志 | - |
程序文件名 | 支持格式:^[A-Za-z0-9/]{0,1}[A-Za-z0-9-+_/.]{0,127}[A-Za-z0-9]$ ,否则替换为"invalid file name" | 128 |
程序行号 | 仅支持正整数,否则替换为* | 10 |
错误码 | 仅支持数字,支持负数,否则替换为* | 10 |
● 分析结果限制
任务输出的结果要指定任务类型,并且任务结果输出json格式必须跟任务类型登记的协议一致。json中每个字段长度限制为10个字节,结果总大小上限为10*任务中消息条数个字节(目前最大为10K个字节),若超过该长度则会报错。
不允许在分析结果和日志里,以任何形式(明文或编码)输出用户的消息内容,否则将限制服务商数据分析专区使用以及可能承担相应法律责任。