获取应用发布详情

POST /studio/rag/chat/v1/applications/release:describe

请求头（Request Header）

Authorization 可以使用如下两种Header

动态生成 Authorization Header, 参考认证（authentication）

-H "X-Date: $xdate" \
-H "Authorization: $auth" 

直接提供完整的 Authorization Header,可以通过浏览器的开发者工具DevTools查看并复制接口调用的完整信息

-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'

请求参数（Request Parameters）

无请求参数

请求体（Request Body）

名称	类型	必须	描述
release_key	string	是	应用发布的release key.

请求示例（Request Example）

curl 'https://rag.cn-sh-01.sensecoreapi.cn/studio/rag/chat/v1/applications/release:describe' \
    -H "X-Date: $xdate" \
    -H "Authorization: $auth" \
    -X 'POST' \
    --data-raw  '{
    "release_key":""
}'

响应（Response）

名称	类型	描述
application_id	string	应用程序的ID.
release_id	string	应用发布的ID.
platform	integer($enum)	第三方平台.
config	object	应用程序配置.
state	integer($enum)	应用发布状态.
creator	string	创建者.
last_editor	string	最后编辑者.
create_time	string	创建时间.
update_time	string	更新时间.
release_key	string	发布密钥.

其中，releases.platform有如下情况

枚举值	数值	含义
THIRD_PARTY_PLATFORM_UNSPECIFIED	0	默认值，不会发布任何平台
THIRD_PARTY_PLATFORM_WEB	1	Sensecore 网页
THIRD_PARTY_PLATFORM_WECOM	2	企业微信，暂未支持

其中，releases.config的参数如下

名称	类型	描述
model_config	object	模型配置.
prompt	string	知识库提示，改写用户问题，增加知识库检索到的知识信息.
sys_prompt	string	人设提示，大模型所需要扮演的人设信息.
model	string	模型名称.
search_config	object	搜索知识配置.
question_hints	array[string]	会话开始前显示的问题提示.
conversation_opener	string	对话的开场白.
conversation_question_prompt_enabled	bool	是否提供用户可能想问的三个问题.

其中，config.model_config的参数如下

名称	类型	描述
frequency_penalty	float	重复惩罚系数.
max_tokens	int32	在聊天补全中生成的最大token数，默认值为102.
n	int32	为每条输入消息生成的聊天补全选择数量.
temperature	float	使用的采样温度，范围在0到2之间.
top_p	float	采样温度的替代方案，称为核采样.

其中，config.search_config的参数如下

名称	类型	描述
dataset_list	array[object]	要搜索的知识库列表.
top_k	int32	返回结果的Top K值.
confidence	float	置信度.
weight	float	权重：表示两种方法之间的比例.
open_window	bool	是否在提示中包含检索段的前后片段.

其中，search_config.dataset_list的参数如下

名称	类型	描述
id	string	知识库ID.
display_name	string	知识库显示名称.

其中，releases.state有如下情况

枚举值	数值	含义
RELEASE_STATE_UNSPECIFIED	0	默认开始状态
RELEASE_STATE_RELEASED	1	应用已发布
RELEASE_STATE_DELETED	2	应用发布已删除

响应示例（Response Example）

{
    "name": "",
    "application_id": "4c4ed98aa2a14860b2509c5b8cc87686",
    "release_id": "51de6892e3e648a1beb39eb034bdbaf7",
    "platform": 1,
    "config": {
        "model_config": null,
        "prompt": "",
        "sys_prompt": "",
        "model": "",
        "search_config": null,
        "question_hints": [],
        "conversation_opener": "对话开场白",
        "conversation_question_prompt_enabled": false
    },
    "state": 1,
    "creator": "",
    "last_editor": "",
    "create_time": null,
    "update_time": null,
    "release_key": "YfUCAPzqSyixc8Qz_POW"
}

获取应用发布详情

请求头（Request Header）​

请求参数（Request Parameters）​

请求体（Request Body）​

请求示例（Request Example）​

响应（Response）​

响应示例（Response Example）​