创建提示词
功能介绍
创建提示词。
URI
POST /v1/{project_id}/applications/{application_id}/uni-search/prompt
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token(X-Auth-Token) |
是 |
String |
接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
参数解释: 提示词名称。 约束限制: 不涉及 取值范围: 只允许输入的字符串以字母、数字或中文字符开头,后续可以是字母、数字、中文字符或下划线,长度不超过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 |
参数解释: 提示词多语言内容列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 提示词id。 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
请求示例
创建提示词。
/v1/{project_id}/applications/{application_id}/uni-search/prompt { "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 |
成功创建提示词,返回提示词id。 |
400 |
请求体参数错误。 |
500 |
内部异常。 |
错误码
请参见错误码。