修改提示词 - ModifyPrompt

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID。

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

application_id

是

String

参数解释：

应用ID，获取方法请参见获取应用ID。

约束限制：

字符串

取值范围：

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

默认取值：

不涉及

prompt_id

是

String

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

X-Auth-Token

是

String

参数解释：

接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

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答案生成提示词。

默认取值：

不涉及

prompts

是

Array of PromptItem objects

参数解释：

提示词不同语言列表。

约束限制：

不涉及

取值范围：

最大长度为20。

默认取值：

不涉及

freemarker_enabled

否

Boolean

参数解释：

当前prompt是否需要使用FreeMarker语法

约束限制：

不涉及

取值范围：

• true 当前prompt使用FreeMarker语法

• false 当前prompt不使用FreeMarker语法

默认取值：

false

search_scope

否

String

参数解释：

当freeMarkerEnabled为true时，需要传递此参数。用于确定当前prompt的参考文档来源：知识库搜索(DOCUMENT)/联网搜索(WEB)

约束限制：

当freeMarkerEnabled为true时，需要传递此参数。

取值范围：

• DOCUMENT

• WEB

默认取值：

DOCUMENT

language

否

String

参数解释：

语言名称。

约束限制：

不涉及

取值范围：

• zh==CHINESE

• en==ENGLISH

• th==THAI

• ar==ARABIC

• es==SPANISH

• pt==PORTUGUESE

默认取值：

不涉及

prompt

否

String

参数解释：

提示词。

约束限制：

不涉及

取值范围：

最大长度为8192。

默认取值：

不涉及

attention

否

String

参数解释：

注意事项。

约束限制：

不涉及

取值范围：

最大长度为65535。

默认取值：

不涉及

id

String

参数解释：

提示词id。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

error_code

String

参数解释：

错误码。

取值范围：

不涉及

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及

error_code

String

参数解释：

错误码。

取值范围：

不涉及

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及

200

修改提示词返回体。

400

请求体参数错误。

500

内部异常。