用户API接口
✅1. 股票分析接口
接口描述
查询股票收盘价格,并分析涨跌原因. 未收盘时间查询,则返回上一个交易日收盘价格.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/stock/info
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)或Bearer cpn-xxxxxxxxxxxxxxxxxxxxxx (企业token)
Content-Type: application/json
请求参数
参数名称 | 类型 | 描述 | 是否必填 |
---|---|---|---|
stocks_code | String | 股票代码 | 必填 |
stocks_name | String | 股票名称 | 非必填 |
minimum_value | Decimal | 跌幅 (比如跌幅5% 传递0.05) | 非必填 |
maximum_value | Decimal | 涨幅 (比如涨幅5% 传递0.05) | 非必填 |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/stock/info \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"stocks_name": "平安银行",
"stocks_code":"000001",
"maximum_value": "0.05",
"minimum_value": "0.02"
}'
返回结果
{
"data": {
"answer": "### 股票: 平安银行\n\n**涨跌数据概述:**\n- **股票当日涨跌幅:** 1.00%\n- **行业当日涨跌幅:** 0.43%\n- **上证指数当日涨跌幅:** -0.44%\n\n### 新闻分析\n\n#### 1. **美联储降息预期的影响**\n新闻提到了美联储可能降息,这通常对银行业是不利的。降息会压缩银行的净息差,导致银行盈利下降。然而,今天平安银行的涨幅为1.00%,而行业整体涨幅为0.43%。这表明尽管降息预期存在,但影响可能并未在短期内充分显现,或者市场对其他利好消息反应更为强烈。\n\n#### 2. **科技创新贷款**\n新闻提到科技创新贷款的加速落地已完成首批投放,这对平安银行等参与这些项目的商业银行是利好消息,因为这将增加贷款业务和盈利机会。这可能是平安银行今天涨幅的一个原因。科技创新贷款不仅为银行带来业务增长,也可能提升银行整体市场形象和客户粘性。\n\n#### 3. **市场流动性提升**\n提到港股“双柜台模式”推出一周年,流动性提升,这是一个利好消息。国际市场流动性增强,有助于提升银行相关业务收入,特别是对于跨境业务。这对平安银行作为与国际资本市场联系紧密的银行来说,是一个积极信号。\n\n#### 4. **房地产市场活跃度提升**\n房地产市场新政带来的市场活跃度提升也是利好消息,特别是对于有较大房地产贷款业务的银行。平安银行从中受益的可能性较大,这对今天的股价上涨也可能有贡献。\n\n### 结论\n综合分析,今天平安银行股价上升1.00%的原因可能是因为多项利好因素在短期内集体发力,尤其是科技创新贷款和房地产市场的利好消息。这些利好因素在短期内盖过了美联储降息预期的利空影响。\n\n未来需要关注的是:\n- 美联储降息的进程以及对国内银行息差的具体影响。\n- 国际地缘政治动荡的潜在风险,以及可能对投资者情绪和全球金融市场的影响。\n- 国家科技创新贷款和房地产市场的持续表现。\n\n无论如何,短期内平安银行的表现相对积极,但需要综合评估中长期影响来制定更谨慎的投资策略。",
"model": "gpt-4o",
"crystalStone":100
"requestId": "ce25fa0c316f4f39a7f41e80e8663510"
},
"errorCode": 0,
"line": null,
"message": "成功",
"success": true
}
✅2.对话列表
接口描述
对话列表,包含AI伙伴,自己创建小程序和官方小程序.
接口地址
GET https://txapi.jxjia.net/ai-api/v1/chat/list
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
session_type | 是 | Int | 0: 查全部;1: AI伙伴; 2:官方小程序; 3:已创建的小程序 4分享的小程序 |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/chta/list?session\_type= \
-H "Authorization: xxxxx"
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
session_id | String | |
command_session_id | String | session_type=3时返回 |
nick_name | String | 昵称 |
header_url | String | 头像 |
session_type | int | 1: AI伙伴; 2:官方小程序; 3:已创建的小程序 4分享的小程序 |
回复示例
{
"data": [{
"session_id":"999992",
"command_session_id":"",
"nick_name":"jack",
"header_url":"https://xxx.com/xx.jpg"
"session_type":1
},{
"session_id":"99999",
"command_session_id":"22222",
"nick_name":"jack2",
"header_url":"https://xxx.com/xx.jpg"
"session_type":3
}],
"errorCode": 0,
"message": "成功",
"success": true
}
3. AI伙伴
3.1 用户跟AI伙伴对话
接口描述
用户跟智能体对话.可发送文字,文件和图片.默认带记忆,上下文.只发送本轮信息.接口较慢,超时时间建议调成2分钟.
注意: 对话过程中上传的文件图片或AI生成的文件图片,在对话框中文件图片的url3个月后失效.云空间长期保存.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/chat/completions
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
session_id | 否 | String | 对话窗口id,可实现连续对话(用户注册成功后,会自动创建AI伙伴) |
user_question | 是 | Object | 用户输入问题. |
type | 是 | Int | 传入类型: 0:文字; 1:语音 |
content | 是 | String | 用户输入文字 或 语音file_id |
mark_type | 否 | Int | 非必传,AI伙伴可根据语义执行任务.传参可更准确执行任务. |
file_attachs | 否 | Array<Object> | |
file_id | String | 文件,图片,语音 id 通过上传获取 1:文件id,支持pdf,doc,docx,ppt,pptx,csv,xlsx,wps.支持一个文件.自动进训练空间.通过云空间上传接口获取"上传"获取 (支持一个文件) 2:图片id "上传"获取 (图片最多六张) 单张30MB以下 | |
url | String | 文件url "上传"获取 | |
file_type | Int | 文件类型 1:文件、2:图片 3语音 |
mark_type | 参数描述 | 返回格式 |
---|---|---|
1 | 脑图 | Mind Map |
2 | 流程图 | mermaid |
3 | 状态图 | mermaid |
4 | 实体关系图 | mermaid |
5 | 用户旅程图 | mermaid |
6 | 甘特图 | mermaid |
7 | 饼状图 | mermaid |
9 | 时间线图 | mermaid |
900 | 股票分析 | Markdown |
901 | 股票回测 | Markdown |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"session_id":"1681207028381696108"
"user_question": {
"type": 0,
"content": "星星为什么一闪一闪的."
},
"mark_type": 2,
"file_attachs": [
{"file_id":"1753399182701993984","url":"http://xxx.xx.png","file_type":"1"},
{"file_id":"1753399182701993985","url":"http://xxx.xx.png","file_type":"2"}
]
}'
回复参数
参数名称 | 类型 | 描述 | |
---|---|---|---|
id | 回复消息id | ||
create_time | String | 答复时间 | |
message | AI助手回复内容. | ||
text | String | 文字回复,格式: Markdown,mermaid,Mind Map | |
text_type | String | 固定参数: mermaid,mindmap;返回null时,用Markdown解析. | |
file_attachs | Array<Object> | 包含文件和图片 | |
url | String | 图片或文档的url ,链接有过期时间. | |
size | String | 文档大小,图片该字段为空 | |
title | String | 文档名字,图片该字段为空 | |
file_type | Int | 文件类型:1:文件、2:图片 3:语音 | |
url_invalid | Int | 文件状态:0: 链接可用; 1:链接失效; | |
file_id | String | 文件id |
回复示例
{
"data": {
"id": "123456789123",
"create_time": "2024-01-01 01:11:11",
"message": {
"text": "经过分析,公司经营状况优秀.......",
"text_type": null,
"file_attachs": [
{
"url": "https:// xxx.xx.xx/xx/xx.pdf",
"size": "244KB",
"file_id": "888888",
"title": "2020年公司规划报告",
"file_type": 1,
"file_id": "1753399195393957888",
"url_invalid": 0
},
{
"url": "https:// xxx.xx.xx/xx/xx.jpg",
"size": null,
"file_id": "8888882",
"title": "截图1",
"file_type": 2,
"file_id": "1753399195393957889",
"url_invalid": 0
},
{
"url": "https:// xxx.xx.xx/xx/xx.mp3",
"file_id": "1753399195393957890",
"file_type": 3,
"url_invalid": 0
}
]
}
},
"errorCode": 0,
"message": "成功",
"success": true
}
3.2 文字转语音
接口描述
将文字转为语音.支持中英. 可用在用户要求返回语言的场景下使用.此接口需要轮询.文字转语音需要时间,根据文字的长短,耗时不用,未转换好返回空.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/tts
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
message | 是 | String | 需要转换成语音的文字. |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/ \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"message":"你好,我是小美AI,有什么能帮助您."
}'
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
回复示例
{
"data": {
"url":"https://xxx.com/xx.mp3"
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅3.3 查询历史聊天
接口描述
查询历史聊天记录.包含AI伙伴,小程序.
接口地址
GET https://txapi.jxjia.net/ai-api/v1/chat/msgList
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
session_id | 是 | String | session_id 或者 command_session_id |
page_size | 是 | Int | 默认 10 |
page_num | 是 | Int | 默认 1 |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/chat/msgList?session_id=88888&page_size=10&page_num=2 \
-H "Authorization: xxxxx"
回复参数
参数名称 | 类型 | 描述 | |
---|---|---|---|
id | String | 消息id | |
user_type | Int | 是AI回复,还是用户; 可选值: AI , human; | |
header_url | String | 头像(智能体) | |
message | AI助手回复内容. | ||
text | String | 文字回复,格式: Markdown,mermaid,Mind Map | |
text_type | String | 固定参数: mermaid,mindmap;返回null时,用Markdown解析. | |
file_attachs | Array(Object) | 包含文件和图片 | |
url | String | 图片或文档的url ,链接有过期时间. | |
size | String | 文档大小,图片该字段为空 | |
title | String | 文档名字,图片该字段为空 | |
file_type | String | 文件类型: 1:文件、2:图片 3:语音 | |
url_invalid | Int | 文件状态:0: 链接可用; 1:链接失效; | |
file_id | String | 文件id |
回复示例
{
"data": {
"isMore": 0,
"items": [
{
"id": "1753398356134699008",
"header_url": "https://xxx.com/x.jpg",
"message": {
"text": "经过分析,公司经营状况优秀.......",
"text_type": null,
"file_attachs": [
{
"url": "https:// xxx.xx.xx/xx/xx.pdf",
"size": "244KB",
"file_id": "888888",
"title": "2020年公司规划报告",
"file_type": 1,
"url_invalid": 0
},
{
"url": "https:// xxx.xx.xx/xx/xx.jpg",
"size": null,
"file_id": "8888882",
"title": "截图1",
"file_type": 2,
"url_invalid": 0
},
{
"url": "https:// xxx.xx.xx/xx/xx.mp3",
"file_type": 3,
"url_invalid": 0
}
]
},
"create_time": "2024-01-01 01:11:11",
"user_type": "human"
},
{
"id": "1753398356134699009",
"header_url": "https://xxx.com/x.jpg",
"message": {
"text": "经过分析,公司经营状况优秀.......",
"text_type": null,
"file_attachs": [
{
"url": "https:// xxx.xx.xx/xx/xx.pdf",
"size": "244KB",
"file_id": "888888",
"title": "2020年公司规划报告",
"file_type": 1,
"url_invalid": 0
},
{
"url": "https:// xxx.xx.xx/xx/xx.jpg",
"size": null,
"file_id": "8888882",
"title": null,
"file_type": 2,
"url_invalid": 0
}
]
},
"create_time": "2024-01-01 01:11:11",
"user_type": "AI"
}
],
"pageNum": 1,
"pageSize": 10,
"startIndex": 0,
"totalCount": 2,
"totalPage": 1
},
"errorCode": 0,
"message": "成功",
"success": true
}
4. 个性化Token生成
AI对输入的文字进行多轮扩散和深度挖掘,起到举一反三的作用,以提升AI伙伴能力.
✅4.1 上传文件生成个性化Token
接口描述
添加生成个性化Token的文件.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/aiTrainingGround/add
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/form-data
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
multipartFile | 是 | file | 需要训练的文件f,支持: pdf,doc,docx,ppt,pptx,csv,wps. (训练以文字为主,全数字文档训练无效.) |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/aiTrainingGround/add \
-H "Authorization: xxxxx" \
-F 'multipartFile=@/path/to/your/file'
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
回复示例
{
"data": null,
"errorCode": 0,
"message": "成功",
"success": true
}
✅4.2 个性化Token生成列表
接口描述
该列表显示文本的个性化Token生成状态.
接口地址
GET https://txapi.jxjia.net/ai-api/v1/aiTrainingGround/list
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
pageSize | 是 | Int | |
pageNum | 是 | Int | |
type | 是 | Int | 1-训练管理 2-训练成果 |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/aiTrainingGround/list?pageSize=10&pageNum=1 \
-H "Authorization: xxxxx"
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
fileId | String | 训练任务id |
fileName | String | 文件名 |
beBeingTrainedTime | String | 创建任务时间 |
trainedStatus | Int | 0:待训练 1:训练中;2:训练成功;3训练失败; |
fileUrl | String | 文件地址 |
回复示例
{
"data": {
"isMore": 0,
"items": [
{
"fileId":"33333333",
"fileName":"科学百科.doc",
"beBeingTrainedTime": "2024-01-01 01:11:11",
"trainedStatus": 1
},
{
"fileId":"4444444",
"fileName":"科学百科.doc",
"beBeingTrainedTime": "2024-01-01 01:11:11",
"trainedStatus": 1
}
],
"pageNum": 1,
"pageSize": 10,
"startIndex": 0,
"totalCount": 2,
"totalPage": 1
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅4.3 重启个性化Token生成失败的任务
接口描述
重新开启生成个性化Token失败的任务。只能在生成失败状态下触发.
接口地址
GET https://txapi.jxjia.net/ai-api/v1/aiTrainingGround/retry
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
fileId | 是 | String | 需要重新训练的失败任务id. |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/trainingSpace/retry?fileId= \
-H "Authorization: xxxxx"
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
回复示例
{
"data": null,
"errorCode": 0,
"message": "成功",
"success": true
}
5. 会议助手
将会议录音文件解析,生成会议原文稿,再由AI整理后输出整理稿.
5.1 创建会议
接口描述
创建会议.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/meetingAssistant/create
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
language | 否 | String | 选择语言,默认中英文. |
auto_organize | 否 | Int | 是否自动生成AI整理稿件.0:不整理;1:整理 |
meeting_name | 否 | String | 会议名称,默认为日期"2024-11-1 11:11:11" |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/meetingAssistant/create \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"language":null,
"auto_organize": 1,
"meeting_name": "技术部周会",
"":
}'
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
meeting_id | String | 会议id |
回复示例
{
"data": {
"meeting_id": "99999"
},
"errorCode": 0,
"message": "成功",
"success": true
}
5.2 上传会议语音/结束会议
接口描述
会议进行中,你可以持续上传音频。当 is\_end=true
时,会议将关闭并不再接收新的音频输入。此时,将开始异步生成会议的原文稿和整理稿。
接口地址
POST https://txapi.jxjia.net/ai-api/v1/meetingAssistant/upload
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
voice_file_ids | 否 | List <String > | 音频文件id ,请按先后顺序排序.(语音上传 获取) |
meeting_id | 是 | String | 会议id |
is_end | 否 | Boolean | 是否是最后一段录音.默认false.超过60分钟不上传将自动结束,并整理. |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/ \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"meeting_id":"88488",
"is_end":null,
"voice_file_ids":["111111","111111"
]
}'
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
回复示例
{
"data": null,
"errorCode": 0,
"message": "成功",
"success": true
}
5.3 查看会议文档
接口描述
查看会议原文稿和整理稿.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/meetingAssistant/show
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
meeting_id | 是 | String | |
forced_shutdown | 否 | Bollean | true:检查会议是否关闭,会强制关闭.(默认) false:不检查会议状态. |
doc_type | 是 | Int | 0:会议原稿; 1:AI整理稿. |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/meetingAssistant/show \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"meeting_id":"999999",
"doc_type":0
}'
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
doc | String | 会议稿内容. |
state | Int | 0:会议进行中;1:文稿整理中;2:完成;3:整理失败 |
回复示例
{
"data": {
"doc": "我是文稿xxxxxxxxx",
"state": 3
},
"errorCode": 0,
"message": "成功",
"success": true
}
5.4 会议列表
接口描述
列表展示会议.
接口地址
GET https://txapi.jxjia.net/ai-api/v1/meetingAssistant/list
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
page_size | 是 | Int | |
page_num | 是 | Int |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/aiTrainingGround/list?page_size=10&page_num=1 \ -H "Authorization: xxxxx"
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
meeting_id | String | 会议id |
meeting_name | String | 会议名称 |
create_time | String | 创建时间 |
state | Int | 0:会议进行中;1:文稿整理中;2:完成;3:整理失败 |
meeting_duration | String | 会议时长,"00:21:33" |
回复示例
{
"data": {
"isMore": 0,
"items": [
{
"meeting_id":"33333333",
"meeting_name":"技术部第一次会议",
"create_time": "2024-01-01 01:11:11",
"meeting_duration":"00:21:33",
"state": 1
},
{
"meeting_id":"33333333",
"meeting_name":"技术部第二次会议",
"create_time": "2024-01-01 01:11:11",
"meeting_duration":"00:21:33",
"state": 1
}
],
"pageNum": 1,
"pageSize": 10,
"startIndex": 0,
"totalCount": 2,
"totalPage": 1
},
"errorCode": 0,
"message": "成功",
"success": true
}
6. 小程序
小程序功能更加强大,可自定义prompt,集成python沙盒环境,可外挂文件完成指定复杂任务.小程序可以通过对话框创建,也可以直接编辑小程序配置.
调用逻辑:
- 先调用'6.1 创建小程序session_id'生成'session_id'和'command_session_id'
- 调用'6.2 对话设置小程序'接口,提出构建小程序的需求.
- 调用'6.5 小程序对话'接口来使用小程序,是否满足需求.
- 如果要修改小程序可以通过两个途径:
- 4.1 继续对话修改小程序配置 '6.2 对话设置小程序'.
- 4.2 调用'6.4 保存更新小程序设置'直接修改小程序配置项.
✅6.1 创建小程序session_id
接口描述
新建'配置小程序对话框的session_id'和'小程序对话框command_session_id'.
接口地址
GET https://txapi.jxjia.net/ai-api/v1/miniProgram/getsessionid
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
请求参数
参数名称 | 必选 | 类型 | 描述 | |
---|---|---|---|---|
nick_name | 是 | String | 昵称 | |
header_url | 否 | String | 头像 |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/miniProgram/getsessionid?nick_name= \
-H "Authorization: xxxxx"
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
session_id | String | 小程序对话框session_id(7.5使用). |
command_session_id | 构建小程序的指令对话框框session_id(7.2,7.3,7.4);该窗口是通过对话来帮助用户创建小程序. |
回复示例
{
"data": {
"session_id":"8888888",
"command_session_id":"99999"
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅6.2 对话设置小程序
接口描述
通过对话的方式,定义构建小程序的功能.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/miniProgram/create
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token) Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
command_session_id | 是 | String | 创建小程序窗口id,可实现连续对话("7.1"返回command_session_id) |
user_question | 是 | Object | 用户输入对小程序的需求. |
type | 是 | Int | 传入类型: 0:文字; 1:语音 |
content | 是 | String | 用户输入文字 或 语音file_id |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/miniProgram/create \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"command_session_id":"",
"user_question": {
"type": 0,
"content": "星星为什么一闪一闪的." //或者语音文件id "1813497918504092978"
}
}'
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
id | String | 消息id |
create_time | String | 答复时间 |
message | Object | |
text | String | 回复内容 |
回复示例
{
"data": {
"id":"",
"create_time": "2024-01-01 01:11:11",
"message": {
"text": "经过分析,公司经营状况优秀......."
}
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅6.3 查询小程序设置
接口描述
查询小程序设置.
接口地址
GET https://txapi.jxjia.net/ai-api/v1/miniProgram/getSetting
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
请求参数
参数名称 | 类型 | 描述 | |
---|---|---|---|
command_session_id | String |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/miniProgram/getsessionid?command_session_id=1 \
-H "Authorization: xxxxx"
回复参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
mini_program_name | 否 | String | 小程序名称 |
mini_program_icon | 否 | String | 小程序头像 |
mini_program_introduction | 否 | String | 小程序介绍 |
mini_program_instructions | 否 | String | 小程序使用说明 |
mini_program_setting | 否 | String | 小程序设定 |
回复示例
{
"data": {
"mini_program_instructions": "**背景 B (Background):**\n- 主题:随机写歌助手\n- 目标用户:希望获得创作灵感或完整歌曲的用户,音乐爱好者和专业音乐人\n- 用户特点:对音乐创作有兴趣,希望通过AI获得帮助\n**角色 R (Role):**\n- 你是一位音乐领域的专家,能够根据用户提供的信息,如风格、主题、情感等,生成相应的歌词和旋律。同时,你也是一名耐心且富有创造力的伙伴,可以激发用户的创作热情。\n**目标 O (Objective):**\n- 通过了解用户的创作需求,提供个性化的歌词和旋律建议,帮助用户完成音乐作品。\n- 智能判断对话内容,与当前主题无关的对话请根据用户问题正常回复。\n**关键结果 KR (Key Result):**\n1. 基于用户提供的信息,生成符合要求的歌词和旋律。\n2. 提供多种风格和主题选择,让用户自由选择并组合成完整作品。\n3. 通过与用户互动,不断调整和优化生成内容,使其更加贴合用户需求。\n4. 同样可回答客户与当前主题无关的问题,进行正常内容交互。\n**步骤 S (Steps):**\n1. 与用户沟通,收集其创作需求,包括风格、主题、情感等信息。\n2. 根据收集到的信息,进行分析并生成初步歌词和旋律片段。\n3. 向用户展示生成内容,并根据反馈进行调整优化。\n4. 最终帮助用户完成满意的音乐作品,并鼓励其继续创作更多作品。\n您好,接下来,Let's think step by step, work hard and painstakingly, 请根据上面的背景(Background),假设你是角色(Role),遵循步骤(Steps),完成目标(Objective)。这对我来说非常重要。",
"mini_program_introduction": "根据你的需求,生成随机歌词和旋律的AI助手。",
"mini_program_instructions": "使用说明:1. 提供你的创作需求:在开始时,你可以告诉我你想要什么样的歌曲,包括风格、主题、情感等。这有助于我更好地理解你的创作方向。2. 获取灵感和歌词:基于你的需求,我将为你生成相应的歌词和旋律片段。你可以询问具体的部分或整首歌曲。",
"mini_program_name": "灵感写手",
"mini_program_icon": "https://prod-aipic.jxjia.net/ai/npc_avatar/create_mini/v3_02a8_7323186e-27ef-406c-95d2-13a100f06abg21.png"
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅6.4 保存更新小程序设置
接口描述
更改小程序prompt,也可更改挂载文件.非必填参数不传则不更新.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/miniProgram/saveUpdate
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
command_session_id | 是 | String | |
mini_program_name | 否 | String | 小程序名称 |
mini_program_icon | 否 | String | 小程序头像 |
mini_program_introduction | 是 | String | 小程序介绍 |
mini_program_instructions | 是 | String | 小程序使用说明 |
mini_program_setting | 是 | String | 小程序设定 |
knowledge_base | 否 | Object | 挂载云空间的文件id(可以勾选云空间里的文档和图片,整理稿(excel,除外) |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/ \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"command_session_id": "",
"mini_program_name": "",
"mini_program_icon": "",
"mini_program_introduction": "",
"mini_program_instructions": "",
"mini_program_setting": "",
"knowledge_base": {
"fileIds": [
"1802643330484416514"
]
}
}'
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
回复示例
{
"data": null,
"errorCode": 0,
"message": "成功",
"success": true
}
✅6.5 小程序对话
接口描述
用户跟智能体对话.可发送文字,文件和图片.默认带记忆,上下文. 接口地址
POST https://txapi.jxjia.net/ai-api/v1/miniProgram/chat
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
session_id | 是 | String | 对话窗口id,可实现连续对话(7.1,7.7返回或者列表获取) |
user_question | 是 | Object | 用户输入问题.或语音file_id |
type | 是 | Int | 传入类型: 0:文字; 1:语音 |
content | 是 | String | 用户输入文字 或 语音file_id |
mark_type | 否 | String | 非必传,AI伙伴可根据语义执行任务.传参可更准确执行任务. |
file_attachs | 否 | Array <Object > | |
file_id | String | 文件,图片,语音文件id 通过上传获取 1:文件id,支持pdf,doc,docx,ppt,pptx,csv,xlsx,wps.支持一个文件.自动进训练空间.通过云空间上传接口获取"上传"获取 (支持一个文件) 2:图片id "上传"获取 (图片最多六张) 单张30MB以下 | |
url | String | "上传"获取 | |
file_type | Int | 文件类型 1:文件、2:图片 |
mark_type | 参数描述 | 返回格式 |
---|---|---|
1 | 脑图 | Mind Map |
2 | 流程图 | mermaid |
3 | 状态图 | mermaid |
4 | 实体关系图 | mermaid |
5 | 用户旅程图 | mermaid |
6 | 甘特图 | mermaid |
7 | 饼状图 | mermaid |
9 | 时间线图 | mermaid |
900 | 股票分析 | Markdown |
901 | 股票回测 | Markdown |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/miniProgram/chat \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"session_id":"1681206985633349739",
"user_question": {
"type": 0,
"content": "星星为什么一闪一闪的."
},
"mark_type": 2,
"file_attachs": [
{"file_id":"1753399182701993984","url":"http://xxx.xx.doc","file_type":1},
{"file_id":"1753399182701993985","url":"http://xxx.xx.png","file_type":2}
]
}'
回复参数
参数名称 | 类型 | 描述 | |
---|---|---|---|
id | String | 消息id | |
create_time | String | 答复时间 | |
message | String | AI助手回复内容. | |
text | String | 文字回复,格式: Markdown,mermaid,Mind Map | |
text_type | String | 固定参数: mermaid,mindmap;返回null时,用Markdown解析. | |
file_attachs | Array <Object > | 包含文件,语音和图片 | |
url | String | 图片或文档的url ,链接有过期时间. | |
size | String | 文档大小,图片该字段为空 | |
title | String | 文档名字,图片该字段为空 | |
file_type | Int | 文件类型:1:文件、2:图片 3:语音 | |
url_invalid | Int | 文件状态:0: 链接可用; 1:链接失效; | |
file_id | String | 文件id |
回复示例
{
"data": {
"id": "123456789123",
"create_time": "2024-01-01 01:11:11",
"message": {
"text": "经过分析,公司经营状况优秀.......",
"text_type": null,
"file_attachs": [
{
"url": "https:// xxx.xx.xx/xx/xx.pdf",
"size": "244KB",
"file_id": "888888",
"title": "2020年公司规划报告",
"file_type": 1,
"file_id": "1753399195393957888",
"url_invalid": 0
},
{
"url": "https:// xxx.xx.xx/xx/xx.jpg",
"size": null,
"file_id": "8888882",
"title": "截图1",
"file_type": 2,
"file_id": "1753399195393957889",
"url_invalid": 0
},
{
"url": "https:// xxx.xx.xx/xx/xx.mp3",
"file_id": "1753399195393957890",
"file_type": 3,
"url_invalid": 0
}
]
}
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅6.6 查询历史聊天记录
与'3.3 查询历史聊天记录'接口相同.
✅6.7 获取分享小程序
接口描述
添加他人分享的小程序, 对话列表中session_type=3的才可以分享.同企业,同groupid下才可以获取分享小程序.
接口地址
GET https://txapi.jxjia.net/ai-api/v1/miniProgram/share/sessionid
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
请求参数
参数名称 | 必选 | 类型 | 描述 | |
---|---|---|---|---|
session_id | 是 | String | ("2.对话列表"session_type=3的才可以) |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/miniProgram/getsessionid?session_id= \
-H "Authorization: xxxxx"
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
session_id | String | 聊天session_id(7.5小程序对话使用) |
回复示例
{
"data": {
"session_id":"8888888"
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅6.8 小程序知识库
接口描述
小程序知识库绑定文件.用户跟小程序对话时,被勾选的文档内容将全量带入到每次对话中.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/miniProgram/mount/file
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 | |
---|---|---|---|---|
session_id | 是 | String | ("2.对话列表"session_type=3的才可以) | |
knowledge_base | 否 | string | 文件id(可以勾选云空间里的文档和图片,整理稿(excel,除外) 不传参数清除挂载的文件 |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/miniProgram/mount/file \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '{
"session_id": "",
"knowledge_base": {
"fileIds": [
"1802643330484416514"
]
}
}'
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
回复示例
{
"data": null,
"errorCode": 0,
"message": "成功",
"success": true
}
7. 云空间
云空间是存储用户和AI生成文件的地方.上传到云空间的文件默认会被解析.音频,文档将会被解析成文字存储.
✅7.1 文件图片上传
接口描述
将文本上传到云空间,会自动触发文件解析.
form表单上传文件.
文件将被上传到腾讯云加密桶里,将长期保存.
使用场景: 聊天框(包含小程序对话窗口和AI伙伴对话框)文件上传,云空间文件上传.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/trainingSpace/addFileOrImg|
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/form-data
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
multipartFile | 是 | String | 需要训练的文件url,支持: jpg,pdf,doc,docx,ppt,pptx,csv,wps. (训练以文字为主,全数字文档训练无效.) |
auto_cloud_training | 是 | Int | 文件上传后,是否进入训练空间 .1不进云空间不训练 2: 进云空间不训练(对话框上传文件和云空间上传文件,会议) 3:进云空间并训练(对话框上传文件和云空间上传文件,会议); |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/trainingSpace/addFileOrImg \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-F "multipartFile=@/path/to/your/file"
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
fileId | String | 文件id |
fileUrl | String | 原文件的url.原文件解析出的文字长期有效. |
回复示例
{
"data": {
"fileId":"99999",
"fileUrl":"https://xxx.com/xx.pdf"
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅7.2语音上传
接口描述
语音上传不进云空间 不训练.
form表单上传文件.
文件将被上传到腾讯云加密桶里,将长期保存.
使用场景: 聊天框(包含小程序对话窗口和AI伙伴对话框)文件上传,会议语音文件上传.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/trainingSpace/addVoice
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/form-data
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
multipartFile | 是 | String | mp3语音 |
voiceType | 是 | Int | 语音文件类型: 1:不解析内容 2:语音需要解析 例如:对话框语音和会议语音(默认) |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/trainingSpace/addVoice \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-F "multipartFile=@/path/to/your/file"
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
fileId | String | 文件id |
fileUrl | String | 文件的url.原文件解析出的文字长期有效. |
回复示例
{
"data": {
"fileId":"99999",
"fileUrl":"https://xxx.com/xx.pdf"
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅7.3 展示云空间文件列表
接口描述
列表展示某一用户云空间文件列表.也做为小程序勾选文件使用.
接口地址
GET https://txapi.jxjia.net/ai-api/v1/cloudSpace/list
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
pageSize | 是 | Int | 每页大小 |
pageNum | 是 | Int | 当前页码 |
format | 否 | Int | 1:文件 2:图片 |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/cloudSpace/list?pageSize=10&pageNum=3 \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx"
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
fileId | String | 文件id |
fileName | String | 文件名 |
fileSize | String | 文件大小;例如"3.88MB", "4.0KB" |
createTime | String | 上传时间;"2024-07-05 16:05:28" |
fileUrl | String | 文件链接 |
回复示例
{
"data": {
"isMore": 0,
"items": [
],
"pageNum": 1,
"pageSize": 10,
"startIndex": 0,
"totalCount": 2,
"totalPage": 1
},
"errorCode": 0,
"message": "成功",
"success": true
}
✅7.4 批量删除文件
接口描述
批量删除云空间中的文件,释放空间.将删除文件解析内容和对象存储中的文件.删除后无法恢复.
接口地址
POST https://txapi.jxjia.net/ai-api/v1/cloudSpace/del
请求头
Authorization:Bearer user-xxxxxxxxxxxxxxxxxxxxxx (用户token)
Content-Type: application/json
请求参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
fileIds | 是 | List <String > | 要删除的文件id |
请求示例
curl https://txapi.jxjia.net/ai-api/v1/ \
-H "Content-Type: application/json" \
-H "Authorization: xxxxx" \
-d '["44444","33333"]'
回复参数
参数名称 | 类型 | 描述 |
---|---|---|
回复示例
{
"data": null
"errorCode": 0,
"message": "成功",
"success": true
}