数字伙伴会话

文档API使用须知

host: https://yach-oapi.zhiyinlou.com 正式环境

host: https://yach-oapi-test.zhiyinlou.com 测试环境

概述

名称	值
地址	/openapi/v2/agent/chat
请求方式	POST
参数	见【参数】
返回值	见【返回值】

header

名称	值
Content-Type	application/json

参数

参数	参数类型	必须	说明
access_token	String	是	调用接口凭证
query	String	是	输入的内容
biz_id	String	是	业务方的用户标识 （工号）
chat_session_id	String	否	业务方的会话ID，注：如果不传chat_session_id时为新会话，开放平台会返回一个会话ID，业务方可以维护此ID作为一次会话
inputs	String	否	用户输入的变量（json字符串，用于兼容工作流模式的输入变量）
chat_privacy	Int	否	数据安全模式：默认为非数据安全模式。对于开启数据安全模式的请求，数字伙伴的后台无论是否开启会话记录收集，均无法在会话记录中查看相应请求。（会话层级隐藏），只影响来自接口请求产生的会话记录。由知音楼对话框场景产生的数据仍保留原有逻辑
msg_type	String	否	消息类型 text 代表文本消息，image_text代表图文混合 注：图文混合模式需要和query字段搭配通过自然语言的方式把图片传入，例："这个图片里有什么内容 image::https://yach-static.zhiyinlou.com/online/jsapi/1760166301289/bwgndqswvsq/127c1fc4-4c06-43bf-8141-0a6aeecb7daf.png::"
create_at	Int	否	会话时间戳

请求curl示例：

curl --request POST \
  --url https://yach-oapi.zhiyinlou.com/openapi/v2/agent/chat \
  --header 'Accept-Encoding: gzip, deflate, br' \
  --header 'Connection: keep-alive' \
  --header 'accept: application/json, text/plain, */*' \
  --header 'accept-language: zh-CN,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6' \
  --header 'content-type: application/json' \
  --header 'origin: http://localhost:3000' \
  --header 'priority: u=1, i' \
  --header 'referer: http://localhost:3000/' \
  --header 'sec-ch-ua: "Chromium";v="140", "Not=A?Brand";v="24", "Microsoft Edge";v="140"' \
  --header 'sec-ch-ua-mobile: ?0' \
  --header 'sec-ch-ua-platform: "macOS"' \
  --header 'sec-fetch-dest: empty' \
  --header 'sec-fetch-mode: cors' \
  --header 'sec-fetch-site: cross-site' \
  --header 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36 Edg/140.0.0.0' \
  --data '{
    "access_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "query": "你是谁",
    "biz_id": "381584",
    "chat_session_id": "1433223",
    "inputs": "{\"var1\":\"value1\",\"var2\":\"value2\"}",
    "chat_privacy": 1,
    "msg_type": "text",
    "create_at": 1694500000
}'

返回值（响应从的 200为成功，非200为不成功；返回结果流ID以及当前会话ID）

{
	"code": 200,
	"obj": {
		"stream_id": "78b59994d2085412f3d0bcfc39e7014c_5dbf893073f363f979fb31fd9d246f40_mfswsDTLzz",
		"chat_session_id": "1433223"
	},
	"msg": ""
}