目录
应用在专区中的程序可调用本接口传入会话内容,使用企业微信通用的大语言模型进行会话分析,目前通用的大模型有 Hunyuan · 深度思考(灰度中)、 DeepSeek · 深度思考(灰度中) 与 Hunyuan · 快速回答 三种选项。
详细说明
该接口仅支持分析文本、语音、音频存档消息
目前该接口部分字段只支持第三方应用和代开发应用进行调用
输入协议中各类占位符完成替换后,总长度不超过大约30000个UTF-8字符,否则任务失败
模型的输入协议由管理端的配置决定,除自定义文本外,还可以使用以下4项数据:
A(员工)说:今天天气真不错!
B(客户)说:确实呀!
今天天气真不错!
确实呀!
文档1:文本片段1
文档2:文本片段2
文档1:问题:问题1, 回答:答案1
文档2:问题:问题2, 回答:答案2
{
"tag_group": [{
"group_id": "xxx",
"group_name": "xxx",
"tag_list": [{
"tag_id": "xxx",
"tag_name": "xxx"
},{
"tag_id": "xxx",
"tag_name": "xxx"
}]
}]
}
资料1[ref:{ref_id}]
{文档片段}
资料2[ref:{doc_url}]
{文档片段}
name和value组成的自定义变量对,识别并替换自定义占位符,将形如 {$name$} 的占位符内容替换为value,示例:请执行{$task$}任务
"var_args": [{
"name": "task",
"value": "数据分析"
}]
请执行数据分析任务
| 应用类型 | 权限要求 |
|---|---|
| 自建应用 | 需具备「数据与智能专区权限」 |
| 代开发应用 | 需具备「数据与智能专区权限」 |
| 第三方应用 | 需具备「数据与智能专区权限」 |
请求方法
通过SDK调用,具体方式参考专区程序使用指引。
请求接口名:
create_ww_model_task
请求包体:
{
"ability_id": "ABILITY_ID",
"tag_group_list": [{
"group_id": "GROUP_ID1"
},{
"group_id": "GROUP_ID2"
}],
"kb_id": "KBID",
"kb_retrieval_words": "KB_RECALL_STRING",
"msg_list": [{
"msgid": "MSGID1",
"encrypt_info": {
"secret_key": "SECRETKEY1"
}
},{
"msgid": "MSGID2",
"encrypt_info": {
"secret_key": "SECRETKEY2"
}
}],
"model_id": "MODEL_ID",
"need_think_result": false,
"var_args": [{
"name": "VAR_ARGS_NAME1",
"value": "VAR_ARGS_VALUE1"
},{
"name": "VAR_ARGS_NAME2",
"value": "VAR_ARGS_VALUE2"
}],
"doc_retrieval_params": {
"oper_userid": "USERID1",
"user_doc_ticket": "TICKET",
"keywords": ["关键词1", "关键词2"],
"create_time_start": 1700000000,
"create_time_end": 1700100000,
"creator_userid": ["USERID2"],
"docid_list": ["DOCID1"],
"retrieved_knowledge_list":[
{
"fragment": "DOCFRAGMENT",
"ref_id": "REF1"
}
]
}
}
参数说明:
| 参数 | 是否必须 | 说明 |
|---|---|---|
| ability_id | 是 | 模型能力id 调用方为第三方/代开发应用时必填;只对第三方/代开发应用有效,通过在管理端配置能力获取 |
| kb_id | 否 | 知识集id kb_id、msg_list、doc_retrieval_params字段至少传入一个 |
| kb_retrieval_words | 否 | 用于从知识集中检索相关内容,仅当传入了kb_id时有效; 长度限制为1到1000个utf-8字符; 未传入此字段时,将使用传入的消息内容进行检索; 当未传入msg_list时,此字段必填 |
| msg_list | 否 | 消息列表,最多1000个 kb_id、msg_list、doc_retrieval_params字段至少传入一个 |
| msg_list.msgid | 是 | 每条消息对应的msgid。多次出现同一个msgid,以首次出现的为准。目前支持文本、语音、音频存档消息 |
| msg_list.encrypt_info.secret_key | 是 | 该消息的密钥,将encrypted_secret_key用RSA私钥解密后得到 |
| model_id | 否 | 调用的模型id,用于区分调用的是 Hunyuan · 深度思考(灰度中)、DeepSeek · 深度思考(灰度中)还是 Hunyuan · 快速回答 模型,在管理端获取。 只能传入 Hunyuan · 深度思考(灰度中)、DeepSeek · 深度思考(灰度中)或者 Hunyuan · 快速回答 模型的模型id,否则会报错。 不填默认为 Hunyuan · 快速回答 模型 |
| need_think_result | 否 | 是否返回模型的思考过程部分 默认为否 选择不返回思考过程部分时,模型仍将进行深度思考,只是会将输出的思考过程部分进行过滤 |
| tag_group_list | 否 | 客户标签组列表 只对第三方/代开发应用有效 |
| tag_group_list.group_id | 是 | 每个id代表一个客户标签组。 只对第三方/代开发应用有效 |
| var_args | 否 | 自定义变量列表,最多50个 只对第三方/代开发应用有效 |
| var_args.name | 是 | 自定义变量名 长度限制为1到32个字节 只对第三方/代开发应用有效 |
| var_args.value | 是 | 自定义变量值 长度限制为1到128个utf-8字符 只对第三方/代开发应用有效 |
| doc_retrieval_params | 否 | 用于从文档中检索相关内容,详见DocRetrievalParams |
DocRetrievalParams参数说明(应用需具备「数据与智能专区权限 - 分析企业文档数据」 权限,并且企业授权该「数据与智能专区」文档数据权限未过期,功能灰度中):
| 参数 | 是否必须 | 说明 |
|---|---|---|
| oper_userid | 是 | 检索人userid |
| user_doc_ticket | 是 | 检索人userid对应的user_doc_ticket,可以通过获取访问用户身份获得 |
| keywords | 是 | 检索关键词,不能超过20个。关键词总长度不能超过300,超出将无法检索文档 |
| create_time_start | 否 | 创建时间起始 |
| create_time_end | 否 | 创建时间截止 |
| creator_userid_list | 否 | 文档创建人列表,不能超过20人 |
| docid_list | 否 | 待检索的企业微信文档id列表,不能超过1000个docid;如不传入,默认检索oper_userid可查看的全部文档 |
| retrieved_knowledge_list | 否 | 本地召回的文档列表,数量不能超过100,详见RetrievedKnowledgeItem |
RetrievedKnowledgeItem参数说明:
| 参数 | 是否必须 | 说明 |
|---|---|---|
| fragment | 是 | 文档片段内容,最大长度不超过10000 |
| ref_id | 是 | 引用唯一标识,用于在回答中溯源文档片段,由调用方自行维护 |
model_id字段获取示例(Hunyuan · 深度思考 和 DeepSeek · 深度思考 灰度中):
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"jobid": "JOBID",
"fail_list":[
{
"errcode": 710601,
"errmsg": "xxx",
"msgid": "MSGID2",
"encrypt_info":{
"secret_key": "SECRETKEY2"
}
}
]
}
参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 错误码 |
| errmsg | 错误码说明 |
| jobid | 任务id。首次提交时返回 |
| fail_tag_group_id_list | 非法的客户标签组id列表 |
| fail_list | 提交出错的消息列表,只有msgid重复项返回至该列表,详见FailMsg说明 |
FailMsg说明:
| 参数 | 说明 |
|---|---|
| errcode | 错误码 |
| errmsg | 错误码说明 |
| msgid | 每条消息对应的msgid,与入参对应 |
| encrypt_info | 每条消息对应的加密信息,与入参对应 |
| encrypt_info.secret_key | 加密消息用的secret_key |
请求方法
通过SDK调用,具体方式参考专区程序使用指引。
请求接口名:
get_ww_model_result
请求包体:
{
"jobid": "JOBID"
}
参数说明:
| 参数 | 是否必须 | 说明 |
|---|---|---|
| jobid | 是 | 任务id |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"status": 1,
"fail_list":[{
"errcode": 710601,
"errmsg": "xxx",
"msgid": "MSGID"
}],
"response_data": "RESULT"
}
参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 错误码 |
| errmsg | 错误码说明 |
| status | 任务执行状态 0: 执行未完成 1: 执行完成 2: 执行失败 |
| fail_list | 错误的消息列表,如msgid不存在、非文本等,详见“创建企微通用模型任务”的FailMsg说明 |
| response_data | 企微通用模型的返回结果 当"need_think_result"字段输入为true,且使用 Hunyuan · 深度思考 或 DeepSeek · 深度思考 模型时,返回的结果开头将是模型的思考过程,以<think>开头,</think>结尾 |
