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

目录

  • 创建企微通用模型任务
  • 获取企微通用模型结果
  • 频率限制说明
  • 应用在专区中的程序可调用本接口传入会话内容,使用企业微信通用的大语言模型进行会话分析。

    详细说明

    该接口仅支持分析文本消息
    目前该接口部分字段只支持第三方应用和代开发应用进行调用
    输入协议中各类占位符完成替换后,总长度不超过大约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"
      		}]
      	}]
      }
    • 自定义变量
      在接口中传入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"
    		}
    	}],
    	"var_args": [{
    		"name": "VAR_ARGS_NAME1",
    		"value": "VAR_ARGS_VALUE1"
    	},{
    		"name": "VAR_ARGS_NAME2",
    		"value": "VAR_ARGS_VALUE2"
    	}]
    }

    参数说明:

    参数是否必须说明
    ability_id模型能力id
    调用方为第三方/代开发应用时必填;只对第三方/代开发应用有效,通过在管理端配置能力获取
    kb_id知识集id
    此字段和msg_list字段至少传入一个
    kb_retrieval_words用于从知识集中检索相关内容,仅当传入了kb_id时有效;
    长度限制为1到1000个utf-8字符;
    未传入此字段时,将使用传入的消息内容进行检索;
    当未传入msg_list时,此字段必填
    msg_list消息列表,最多1000个
    此字段和kb_id字段至少传入一个
    msg_list.msgid每条消息对应的msgid。多次出现同一个msgid,以首次出现的为准
    msg_list.encrypt_info.secret_key该消息的密钥,将encrypted_secret_key用RSA私钥解密后得到
    tag_group_list客户标签组列表
    只对第三方/代开发应用有效
    tag_group_list.group_id每个id代表一个客户标签组
    只对第三方/代开发应用有效
    var_args自定义变量列表,最多50个
    只对第三方/代开发应用有效
    var_args.name自定义变量名
    只对第三方/代开发应用有效
    var_args.value自定义变量值
    只对第三方/代开发应用有效

    返回结果:

    {
        "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企微通用模型的返回结果

    频率限制说明

    • 每企业每天不超过1千次(按调用次数限制)
    上一篇管理企业知识集
    下一篇话术推荐模型
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    小程序接入对外收款
    客户端API
    小程序
    基础
    连接微信
    办公
    WECOM-JSSDK
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们