第三方应用开发
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
小程序接入对外收款
第三方应用开发
服务端API
数据与智能专区
专区程序调用sdk
通用模型
通用模型
最后更新:2026/06/15

目录

  • 创建企微通用模型任务
  • 获取企微通用模型结果
  • 频率限制说明
  • 应用在专区中的程序可调用本接口传入会话内容,使用企业微信通用的大语言模型进行会话分析,目前通用的大模型有 Hunyuan · 深度思考(灰度中)、 DeepSeek · 深度思考(灰度中) 与 Hunyuan · 快速回答 三种选项。

    详细说明

    该接口仅支持分析文本、语音、音频存档消息
    目前该接口部分字段只支持第三方应用和代开发应用进行调用
    输入协议中各类占位符完成替换后,总长度不超过大约30000个UTF-8字符,否则任务失败

    模型的输入协议由管理端的配置决定,除自定义文本外,还可以使用以下4项数据:

    • 会话内容
      识别并替换占位符 {chat},将传入的msg_list对应的会话分行拼接,示例:
      A(员工)说:今天天气真不错!
      B(客户)说:确实呀!

      识别并替换占位符 {chatcontent},将传入的msg_list对应的会话内容填入(不包含发送者),示例:
      今天天气真不错!
      确实呀!
    • 知识集文档片段
      识别并替换占位符 {knowledge},通过对比与会话内容的相似度来提取到topK个知识集文档片段,示例:
      普通知识集文件:
      文档1:文本片段1
      文档2:文本片段2

      「问答对」知识集文件:
      文档1:问题:问题1, 回答:答案1
      文档2:问题:问题2, 回答:答案2
    • 客户标签
      识别并替换占位符 {tagjson},通过将客户标签组内的标签展开并表示为 json,可以在输入协议中引导模型理解该 json,示例:
      {
          "tag_group": [{
              "group_id": "xxx",
              "group_name": "xxx",
              "tag_list": [{
                  "tag_id": "xxx",
                  "tag_name": "xxx"
              },{
                  "tag_id": "xxx",
                  "tag_name": "xxx"
              }]
          }]
      }

    • 文档检索
      识别并替换占位符{doc_fragments},按关键词搜索或指定在线文档/微盘文件拉取全文得到的文档片段,结合自行输入的文档片段(可选)重排后替换成如下格式。
      资料1[ref:{ref_id}]
      {文档片段}
      资料2[ref:{doc_url}]
      {文档片段}

      如果资料是用户传入的,那么中括号中的ref后就是用户传入的ref_id;如果资料是在专区中检索到的在线文档,那么中括号中的ref后就是企业微信文档URL;
      开发者如有生成带引用来源的回答的需要,可以根据这个结构设计提示词。

     

    • 自定义变量
      在接口中传入namevalue组成的自定义变量对,识别并替换自定义占位符,将形如 {$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_list": ["USERID2"],
              "docid_list": ["DOCID1"],
              "wedrive_fileid_list": ["WEDRIVE_FILEID1"],
              "doc_type": 8,
              "retrieved_knowledge_list":[
                    {
                        "fragment": "DOCFRAGMENT",
                        "ref_id": "REF1"
                    }
                ]
            }
    }

    参数说明:

    参数是否必须说明
    ability_id模型能力id
    调用方为第三方/代开发应用时必填;只对第三方/代开发应用有效,通过在管理端配置能力获取
    能力id的获取方式参考下文的ability_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
    kb_id、msg_list、doc_retrieval_params字段至少传入一个

    DocRetrievalParams参数说明(应用需具备「数据与智能专区权限 - 分析企业文档数据」权限,并且企业授权该「数据与智能专区」文档数据权限未过期,功能灰度中):
    两种调用模式(任选其一)
    传入了keywords字段即视为调用模式1,未传入keywords字段即视为调用模式2

    模式必填字段可用筛选条件行为
    1. 关键词检索oper_useriduser_doc_ticketkeywordscreate_time_startcreate_time_endcreator_userid_listdocid_listwedrive_fileid_listdoc_typeoper_userid 可阅读范围内按关键词检索在线文档和微盘文件;docid_list 限制在线文档,wedrive_fileid_list 限制微盘文件,doc_type/create_time_start/create_time_start/creator_userid_list 只过滤在线文档
    2. 按指定文档拉取全文oper_useriduser_doc_ticketdocid_listcreate_time_startcreate_time_endcreator_userid_listdoc_type直接按指定在线文档 docid 拉取全文

    支持的在线文档类型包括:在线文档、在线表格、智能表格、思维导图、智能文档
    支持的微盘文件类型包括:txt、pdf、excel、doc、docx、csv

    字段定义

    参数是否必须说明
    oper_userid检索人 userid
    user_doc_ticket检索人 userid 对应的 user_doc_ticket,可通过获取访问用户身份获得
    keywords否¹关键词列表,逻辑或关系;最多 20 个,总长度 ≤ 300
    docid_list否¹在线文档 id 列表,最多 1000 个
    wedrive_fileid_list否¹微盘文件 fileid 列表,最多 1000 个
    doc_type在线文档类型过滤,取值与知识集 doc_list.type 一致:8 在线文档、9 在线表格、19 智能表格、20 思维导图、21 智能文档。不传则不过滤在线文档类型
    create_time_start文档创建时间起始
    create_time_end文档创建时间截止
    creator_userid_list文档创建人列表,最多 20 人
    retrieved_knowledge_list调用方自行传入的文档片段列表,最多 100,详见 RetrievedKnowledgeItem

    ¹ keywordsdocid_listwedrive_fileid_listretrieved_knowledge_list 至少传一个。仅传 docid_list / wedrive_fileid_list 走模式 2;传 keywords 走模式 1。

    RetrievedKnowledgeItem参数说明:

    参数是否必须说明
    fragment文档片段内容,最大长度不超过10000
    ref_id引用唯一标识,用于在回答中溯源文档片段,由调用方自行维护

    ability_id字段获取示例(所有通用模型都需要,以Hunyuan · 快速回答为例)
    enter image description here在对应模型上图的界面中,点击自定义模型能力按钮,编辑提示词并完成审核发布流程,即可获取能力id(即ability_id)

    model_id字段获取示例(Hunyuan · 深度思考 和 DeepSeek · 深度思考 灰度中):
    enter image description here

    返回结果:

    {
        "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",
        "filtered_doc_list":[{
            "docid": "DOCID1",
            "errcode": 710728,
            "errmsg": "xxx"
        },{
            "wedrive_fileid": "WEDRIVE_FILEID1",
            "errcode": 710729,
            "errmsg": "xxx"
        }]
    }

    参数说明:

    参数说明
    errcode错误码
    errmsg错误码说明
    status任务执行状态
    0: 执行未完成
    1: 执行完成
    2: 执行失败
    fail_list错误的消息列表,如msgid不存在、非文本等,详见“创建企微通用模型任务”的FailMsg说明
    response_data企微通用模型的返回结果
    当"need_think_result"字段输入为true,且使用 Hunyuan · 深度思考 或 DeepSeek · 深度思考 模型时,返回的结果开头将是模型的思考过程,以<think>开头,</think>结尾
    filtered_content_list客户显式指定但因无权限、不在存档范围、时间或类型不匹配、docid无效等原因未被检索到的在线文档或微盘文件列表,详见 FilteredContentItem说明

    FilteredContentItem说明:

    参数说明
    docid客户传入的在线文档 id;与 wedrive_fileid 二选一返回
    wedrive_fileid客户传入的微盘文件 fileid;与 docid 二选一返回
    errcode过滤原因错误码
    errmsg错误码说明

    频率限制说明

    • 每企业每天不超过1万次(按调用次数限制)。
    • 每服务商每分钟调用量不超过100次,超过后将导致任务延迟或者任务失败。
    • 若资源紧张,任务重试超过24小时仍未有足够资源执行,任务将失败
    上一篇管理企业知识集
    下一篇话术推荐模型
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    小程序接入对外收款
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    数据API
    更新日志
    联系我们