更新时间:2025-07-22 GMT+08:00
分享

修改提示词

功能介绍

修改提示词。

URI

PUT /v1/{project_id}/applications/{application_id}/uni-search/prompt/{prompt_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

application_id

String

参数解释:

应用ID,获取方法请参见获取应用ID

约束限制:

字符串

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

prompt_id

String

提示词ID,1~64个字符,只能包含数字、字母、中划线和下划线。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

提示词名称。

约束限制:

不涉及

取值范围:

只能包含1到64位英文字母、中文、数字、中划线或者下划线,并且以字母、数字或者中文开头。

默认取值:

不涉及

detail

String

参数解释:

提示词描述。

约束限制:

不涉及

取值范围:

最大长度为100。

默认取值:

不涉及

type

String

参数解释:

提示词类型枚举值

DEFAULT_CHAT_PROMPT 默认搜索增强提示词

DEFAULT_QA_ANSWER_PROMPT 默认qa答案生成提示词

DEFAULT_QA_QUESTION_PROMPT 默认qa问题生成提示词

CHAT_PROMPT 搜索增强提示词

QA_QUESTION_PROMPT qa答案生成提示词

QA_ANSWER_PROMPT qa问题生成提示词。

取值范围:

  • DEFAULT_CHAT_PROMPT 默认搜索增强提示词

  • DEFAULT_QA_ANSWER_PROMPT 默认qa答案生成提示词

  • DEFAULT_QA_QUESTION_PROMPT 默认qa问题生成提示词

  • CHAT_PROMPT 搜索增强提示词

  • QA_QUESTION_PROMPT qa答案生成提示词

  • QA_ANSWER_PROMPT qa问题生成提示词。

prompts

Array of PromptItem objects

参数解释:

提示词不同语言列表。

约束限制:

不涉及

取值范围:

最大长度为20。

默认取值:

不涉及

表4 PromptItem

参数

是否必选

参数类型

描述

language

String

参数解释:

语言名称。

约束限制:

不涉及

取值范围:

  • zh==CHINESE

  • en==ENGLISH

  • th==THAI

  • ar==ARABIC

  • es==SPANISH

  • pt==PORTUGUESE

默认取值:

不涉及

prompt

String

参数解释:

提示词。

约束限制:

不涉及

取值范围:

最大长度为8192。

默认取值:

不涉及

attention

String

参数解释:

注意事项。

约束限制:

不涉及

取值范围:

最大长度为65535。

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

id

String

参数解释:

提示词id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

请求示例

修改提示词。

/v1/{project_id}/applications/{application_id}/uni-search/prompt/{prompt_id}

{
  "name" : "提示词名字",
  "detail" : "提示词描述",
  "type" : "chat_prompt",
  "prompts" : [ {
    "prompt" : "中文提示词",
    "language" : "zh"
  }, {
    "prompt" : "英文提示词",
    "language" : "en"
  }, {
    "prompt" : "阿语提示词",
    "language" : "ar"
  }, {
    "prompt" : "泰语提示词",
    "language" : "th"
  }, {
    "prompt" : "西班牙语提示词",
    "language" : "es"
  }, {
    "prompt" : "葡萄牙语提示词",
    "language" : "pt"
  } ]
}

响应示例

状态码

状态码

描述

200

修改提示词返回体。

400

请求体参数错误。

500

内部异常。

错误码

请参见错误码

相关文档