更新知识库应用程序

PATCH /studio/rag/data/v1/applications/{application_id}

请求头（Request Header）

Authorization 可以使用如下两种Header

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

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

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

-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'

请求参数（Request Parameters）

名称	类型	必须	描述
application_id	string	是	应用程序的ID.

请求体（Request Body）

名称	类型	必须	描述
display_name	string	是	应用程序的显示名称.
desc	string	否	应用程序的描述.
cover_image	string	否	应用程序的封面图片.
cover_image_type	integer($enum)	否	封面图片类型.

其中，cover_image_type有如下情况

状态	数值	含义
COVER_IMAGE_TYPE_UNSPECIFIED	0	开始，默认.
COVER_IMAGE_TYPE_PRESET	1	预设封面图片.
COVER_IMAGE_TYPE_CUSTOM	2	自定义封面图片.

请求示例（Request Example）

curl 'https://aidmp.cn-sh-01.sensecoreapi.cn/studio/rag/data/v1/applications/3e0b067fb6964d23b967d01f2133a5ab' \
  -H "X-Date: $xdate" \
  -H "Authorization: $auth" \
  -X 'PATCH' \
  --data-raw '{
    "application_id":"3e0b067fb6964d23b967d01f2133a5ab",
    "display_name":"0903-14234",
    "desc":"descwe",
    "cover_image":"coverImage/be63e96b-bae7-46f7-879b-a60c37130105",
    "cover_image_type":1
  }'

响应（Response）

名称	类型	描述
application_id	string	应用程序ID
display_name	string	应用程序的显示名称
desc	string	应用程序的描述
cover_image	string	应用程序的封面图片
state	integer($enum)	应用程序状态
creator	string	创建者名称
last_editor	string	最后编辑者名称
create_time	string($date-time)	创建时间
update_time	string($date-time)	更新时间
usage	int64	应用程序的使用情况
config	object	应用程序配置
cover_image_type	integer($enum)	封面图片类型

其中，state有如下情况

状态	数值	含义
STATE_UNSPECIFIED	0	开始，默认.
PEDDING_RELEASE	1	尚未发布.
RELEASE	2	已发布.

其中，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	知识库显示名称.

响应示例（Response Example）

{
  "name": "",
  "application_id": "3e0b067fb6964d23b967d01f2133a5ab",
  "display_name": "0903-14234",
  "desc": "descwe",
  "cover_image": "https://aoss.cn-sh-01.sensecoreapi-oss.cn/rag-system/coverImage/be63e96b-bae7-46f7-879b-a60c37130105?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=CD840429150E4FD2805997FE12D18A86%2F20241223%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20241223T073648Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=e9d409f67a8c2f2532455726ba66760f0fdf5606653c7fdf55176372c73ef4d9",
  "state": 1,
  "creator": "aidmpywj",
  "last_editor": "aidmpywj",
  "create_time": "2024-09-03T06:24:27.508940Z",
  "update_time": "2024-12-23T07:36:48.671907Z",
  "usage": "4",
  "config": {
    "model_config": {
      "frequency_penalty": 1.05,
      "max_tokens": 1024,
      "n": 0,
      "temperature": 1.35,
      "top_p": 0.7
    },
    "prompt": "使用如下知识的内容作为你的**知识库数据**。\n    知识：\n    {{ .Knowledge }}\n\n    回答时请遵循以下规则：\n    - 尽量使用**知识库数据**的内容来回答。\n    - 如果**知识库数据**中未提及，就用自身知识回答并且告诉用户该信息不是来自知识库。\n    - 如果不确定时，请求用户澄清问题。\n\n    请回答问题:\n    {{ .Question }}",
    "sys_prompt": "#角色设定\n    作为一个智能问答助手，你的任务是为用户提供专业、准确的建议。  \n    #组件能力\n    你能够理解和分析用户输入，提供相关且有用的答案。\n    你具备丰富的领域知识，可以回答广泛的问题。  \n    #要求与限制\n    1.输出内容的风格要求：保持友好和专业的语气。\n    2.输出内容的字数限制：尽量控制在200字以内，除非问题需要更详细的解释。\n    3. 语言处理：根据用户问题的语言进行回答。",
    "model": "SenseChat-5",
    "search_config": {
      "dataset_list": [
        {
          "id": "rag_b2ee9316445e4d9490ff3a4fe1eb2473",
          "display_name": "0903-1005"
        }
      ],
      "top_k": 3,
      "confidence": 0.5,
      "weight": 0.2,
      "open_window": false
    },
    "question_hints": [],
    "conversation_opener": "",
    "conversation_question_prompt_enabled": false
  },
  "cover_image_type": 0
}

更新知识库应用程序

请求头（Request Header）​

请求参数（Request Parameters）​

请求体（Request Body）​

请求示例（Request Example）​

响应（Response）​

响应示例（Response Example）​