创建会话

接口信息

接口地址:/api/v1/conversation/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "variables": {},
  "devMode": true
}

请求参数

请求头

参数名	类型	必填	描述	示例值
Authorization	string	是	API Key	`Bearer ak-xxxxeyJhbGciOiJIUzI1NiJ9`

请求参数:

参数名称	参数说明	是否必须	数据类型
variables	智能体设置的会话变量内容，可选，需要用户传入的变量可以在会话创建的时候传入	false	object
devMode	开发模式，为true时，智能体无需发布，变更实时生效	false	boolean

响应参数:

参数名称	参数说明	类型	schema
code	业务状态码，0000 表示成功，其余失败	string
displayCode	源系统状态码，用于问题跟踪	string
message	错误描述信息	string
data	创建的会话ID	integer(int64)	integer(int64)
tid	跟踪唯一标识	string
success		boolean

响应示例:

javascript

{
	"code": "0000",
	"displayCode": "0000",
	"message": "",
	"data": 0,
	"tid": "",
	"success": true
}

CURL示例

shell

curl 'http://127.0.0.1:8081/api/v1/conversation/create' \
  -H 'Accept: */*' \
  -H 'Accept-Language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: keep-alive' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: ak-97a75429000f43908565ffbde9b09b93' \
  --data-raw $'{\n  "variables": {},\n  "devMode": false\n}'

{"code":"0000","displayCode":"0000","message":"成功","data":1440548,"tid":"100571751960713603","success":true}

TS模板示例

// 参数接口
export interface CreateParams {
  /*会话变量内容 */
  variables?: Record<string, unknown>;

  /*开发模式，为true时，智能体无需发布，变更实时生效 */
  devMode?: boolean;
}

// 响应接口
export interface CreateRes {}

/** 
 * 创建会话
 * @param {object} params ConvCreateDto
 * @param {object} params.variables 会话变量内容
 * @param {boolean} params.devMode 开发模式，为true时，智能体无需发布，变更实时生效
 * @returns
 */
export function create(params: CreateParams): Promise<CreateRes> {
  return request.post(`/api/v1/conversation/create`, params);
}

创建会话 ​

接口信息 ​

请求参数 ​

创建会话

接口信息

请求参数