应用发布后的会话接口 | 大装置帮助中心
跳到主要内容

应用发布后的会话接口

POST /studio/rag/data/v1/release:chat

请求头(Request Header)

Authorization 可以使用如下两种Header

-H "X-Date: $xdate" \
-H "Authorization: $auth"
  • 直接提供完整的 Authorization Header,可以通过浏览器的开发者工具DevTools查看并复制接口调用的完整信息
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'

请求体(Request Body)

名称类型必须描述
actioninteger($enum)聊天的操作类型.
contentstring用户输入的内容.
conversation_idstring聊天的对话ID.
release_keystring发布应用的密钥.
streamboolean控制是否是流式输出,默认false表示非流式输出,true表示流式输出.

其中,action的枚举值如下

枚举值数值含义
CHAT_ACTION_UNSPECIFIED0未指定
CHAT_ACTION_NEXT1如常进行下一轮对话
CHAT_ACTION_REGENERATION2重新生成上一轮对话的新响应

请求示例(Request Example)

curl 'https://aidmp.cn-sh-01.sensecoreapi.cn/studio/rag/data/v1/release:chat' \
-H 'Accept: text/event-stream' \
-H "X-Date: $xdate" \
-H "Authorization: $auth" \
-X POST \
--data-raw '{
"content":"法定结婚年龄",
"action":1,
"conversation_id":"",
"release_key":"mR2SjhfMREC2mibt2_bD"
}'

响应(Response)

名称类型描述
conversation_idstring对话ID.
seqint32对话中的序列号.
messagestring非流式请求生成的响应内容.
deltastring流式请求生成的响应内容.
finish_reasoninteger($enum)停止生成的原因.
knowledge_base_resultsarray[object]知识检索的中间结果.
history_idstring聊天历史ID.
prompt_questionsarray[string]用户下一个问题的提示.

其中,finish_reason有如下情况

枚举值数值含义
FINISH_REASON_UNSPECIFIED0未指定
FINISH_REASON_STOP1因为到达终止标记而停止生成
FINISH_REASON_LENGTH2因为达到最大长度而停止生成
FINISH_REASON_SENSITIVE3因为触发敏感词而停止生成
FINISH_REASON_CONTEXT4因为达到模型上下文长度限制而停止

其中,knowledge_base_results的参数如下

名称类型描述
page_contentstring页面内容.
documentobject相关知识文档.
confidencefloat结果置信度.
token_countint64内容的token数量.
segment_numberint32段落数量.
wordsint32段落的字数.
typeinteger($enum)段落类型.
display_typeinteger($enum)显示类型.
table_contentstring表格内容.
image_uristring图片URI.
image_keystring图片键.
image_keysarray[string]图片键集合.
display_contentstring显示内容.

其中,knowledge_base_results.document的参数如下

名称类型描述
document_idstring知识文档的ID.
display_namestring知识文档的名称.
typeinteger($enum)知识文档的类型.
document_sizeint64知识文档的大小.
token_countint64知识文档的令牌计数.
segment_countint64知识文档的段落计数.
dataset_idstring知识文档所属知识库的ID.
dataset_displaystring知识文档所属知识库的显示名称.
p_idstring父知识文档的ID.
data_source_typeinteger($enum)知识文档的数据源类型.
creatorstring知识文档的创建者.
create_timestring($date-time)知识文档的创建时间.
update_timestring($date-time)知识文档的更新时间.
segmentsarray[object]知识文档的段落详细信息列表.
uristring知识文档在OSS中的预签名URI.

其中,document.type有如下情况

枚举值数值含义
DOCUMENT_TYPE_UNSPECIFIED0未指定
WEBPAGE1网页
FOLDER2文件夹
TXT3文本文件
PDF4PDF文件
HTML5HTML文件
XLSX6XLSX文件
XLS7XLS文件
DOCX8DOCX文件
CSV9CSV文件
PPTX10PPTX文件
PPT11PPT文件,暂不支持
XML12XML文件
MARKDOWN13Markdown文件
MD14MD文件
JSON15Json文件

其中,document.data_source_type有如下情况

枚举值数值含义
DATA_SOURCE_TYPE_UNSPECIFIED0开始,默认
LOCAL_FILE1本地知识
WEB2网络知识
NOTION3Notion知识

其中,document.segments的参数如下

名称类型描述
segment_idstring段ID.
dataset_idstring知识库ID
document_idstring文档ID
contentstring段落内容
token_countint32词元数量
numberint32段落编号
metadataobject元数据
wordsint32单词数量
segment_typeinteger($enum)段落类型
table_contentstring表格内容
image_keystring图片键值
image_uristring图片URI
display_typeinteger($enum)显示类型
image_keysarray[string]图片键值列表
display_contentstring展示内容

其中,segments.metadata的参数如下

名称类型描述
key_wordsarray[string]关键词
image_name_valuestring图片名称
image_sizeint32图片大小
table_name_valuestring表格名称
table_rowsint32表格行数
table_columnsarray[string]表格列
scorefloat分数

其中,knowledge_base_results.typesegments.segment_type有如下情况

枚举值数值含义
SEGMENT_TYPE_UNSPECIFIED0未指定状态
SEGMENT_TYPE_TEXT1文字
SEGMENT_TYPE_IMAGE2图片
SEGMENT_TYPE_TABLE3表格
SEGMENT_TYPE_WEB_IMAGE4网页图片

其中,knowledge_base_results.display_typesegments.display_type有如下情况

枚举值数值含义
DISPLAY_TYPE_UNSPECIFIED0未指定状态
DISPLAY_TYPE_TEXT1文字
DISPLAY_TYPE_MARKDOWN2Markdown

响应示例(Response Example)

{"result":{"conversation_id":"","seq":0,"message":"","delta":" ","finish_reason":0,"knowledge_base_results":[],"history_id":"","prompt_questions":[]}},
{"result":{"conversation_id":"3ba7b7ef-ff9d-4d9d-b7ad-4079107f7f3f","seq":1,"message":"","delta":"","finish_reason":1,"knowledge_base_results":[],"history_id":"32f3d69e-f82a-4907-9e9c-9200860b2923","prompt_questions":[" 关联问题:\n1. 在哪些国家或地区,男性和女性的法定结婚年龄不同?\n2. 有没有国家或地区允许未成年人在特定条件下合法结婚?\n3. 历史上,法定结婚年龄的变化趋势是怎样的?"]}}