创建知识库应用程序
POST /studio/rag/data/v1/applications
请求头（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）
| 名称 | 类型 | 必须 | 描述 |
|---|---|---|---|
| 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' \
-H "X-Date: $xdate" \
-H "Authorization: $auth" \
-X POST \
--data-raw '{
"display_name":"api-test",
"desc":"测试openapi",
"cover_image":"coverImage/0002bf40-95cd-4685-9636-34ac32e0b345",
"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": "ede20b6215a34f40866d3b30bfb2d8ab",
"display_name": "api-test",
"desc": "测试openapi",
"cover_image": "https://aoss.cn-sh-01.sensecoreapi-oss.cn/rag-system/coverImage/0002bf40-95cd-4685-9636-34ac32e0b345?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=6D0C134C3FF84DDDB6BCFC02B8FF6C10%2F20240925%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20240925T070830Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=bad2d7d73ccb48582d9a80a2578d9ea23e74eb2a28513389be2ae0b4f2abd88b",
"state": 1,
"creator": "adimp0224",
"last_editor": "adimp0224",
"create_time": "2024-09-25T07:08:30.424919733Z",
"update_time": "2024-09-25T07:08:30.424944876Z",
"usage": "0",
"config": null,
"cover_image_type": 1
}