获取提示词列表 - ListPrompt
功能介绍
获取提示词列表。
URI
GET /v1/{project_id}/applications/{application_id}/uni-search/prompt
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
|
application_id |
是 |
String |
参数解释: 应用ID,获取方法请参见获取应用ID。 约束限制: 字符串 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
page_num |
否 |
Integer |
参数解释: 当前请求的页码,表示从第几页开始获取数据。默认值为1,表示第一页。 约束限制: 不涉及 取值范围: 1~65535 默认取值: 1 |
|
page_size |
否 |
Integer |
参数解释: 每页显示的记录数,表示一次请求返回的数据条数。默认值为10,表示一页展示10条数据。 约束限制: 不涉及 取值范围: 1-65535 默认取值: 10 |
|
name |
否 |
String |
参数解释: 提示词名字匹配查询。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
prompt_type |
否 |
String |
参数解释: 提示词类型匹配查询,旧的后续废弃 约束限制: 不涉及 取值范围: 提示词类型枚举值
默认取值: 不涉及 |
|
prompt_types |
否 |
Array of strings |
参数解释: 提示词类型列表,新的 约束限制: 不涉及 取值范围: 提示词类型枚举值
默认取值: 不涉及 |
|
lod |
否 |
String |
参数解释: 接口查询返回结果详细程度,用户简化接口返回内容。 约束限制: 不涉及 取值范围:
默认取值: detail |
|
create_user |
否 |
String |
参数解释: 创建者筛选。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
page_num |
String |
参数解释: 翻页标号。 取值范围: 不涉及 |
|
page_size |
String |
参数解释: 翻页大小。 取值范围: 不涉及 |
|
total |
String |
参数解释: 数据大小。 取值范围: 不涉及 |
|
data_list |
Array of GetPromptResponseBody objects |
参数解释: 提示词列表。 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 提示词id。 取值范围: 只能包含1到64位数字、字母、中划线和下划线。 |
|
name |
String |
参数解释: 提示词名称。 取值范围: 最大长度为64。 |
|
detail |
String |
参数解释: 提示词描述。 取值范围: 最大长度为64。 |
|
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答案生成提示词 MLLM_PROMPT 多模态模型提示词 取值范围:
|
|
create_time |
String |
参数解释: 提示词创建时间。 取值范围: 不涉及 |
|
update_time |
String |
参数解释: 提示词更新时间。 取值范围: 不涉及 |
|
prompts |
Array of PromptItem objects |
参数解释: 提示词多语言列表。 取值范围: 不涉及 |
|
knowledge_repos |
Array of KnowledgeRepoItem objects |
参数解释: 知识库信息。 取值范围: 不涉及 |
|
actions |
Array of strings |
参数解释: 权限列表。 取值范围: 不涉及 |
|
freemarker_enabled |
Boolean |
参数解释: 是否启用FreeMarker模板引擎。 约束限制: 不涉及 取值范围:
默认取值: false |
|
search_scope |
String |
参数解释: 搜索范围。 取值范围:
|
|
creator |
String |
参数解释: 提示词的创建者。 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
language |
String |
参数解释: 语言名称。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
prompt |
String |
参数解释: 提示词。 约束限制: 不涉及 取值范围: 最大长度为8192。 默认取值: 不涉及 |
|
attention |
String |
参数解释: 注意事项。 约束限制: 不涉及 取值范围: 最大长度为65535。 默认取值: 不涉及 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
请求示例
获取提示词列表
/v1/b25446daeb1a41a7953c5deba2b2677a/applications/5071b12e-8c5c-4181-a15b-41e6ae3915ea/uni-search/prompt?page_num=1&page_size=10
响应示例
状态码:200
获取提示词列表。
{
"page_num" : 1,
"page_size" : 10,
"total" : 1,
"data_list" : [ {
"id" : "031d77dd-66b1-49c9-a651-bca9f65f17fc",
"name" : "api_test",
"type" : "CHAT_PROMPT",
"detail" : "",
"create_time" : "1764071308539",
"update_time" : "1764071308539",
"knowledge_repos" : [ ],
"prompts" : [ {
"language" : "ar",
"prompt" : "xxxx",
"attention" : "xxxxxx"
}, {
"language" : "en",
"prompt" : "xxxx",
"attention" : "xxxxxx"
}, {
"language" : "es",
"prompt" : "xxxx",
"attention" : "xxxxxx"
}, {
"language" : "pt",
"prompt" : "xxxx",
"attention" : "xxxxxx"
}, {
"language" : "th",
"prompt" : "xxxx",
"attention" : "xxxxxx"
}, {
"language" : "zh",
"prompt" : "xxxx",
"attention" : "xxxxxx"
} ],
"search_scope" : "DOCUMENT",
"creator" : "",
"freemarker_enabled" : false
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
获取提示词列表。 |
|
400 |
请求体参数错误。 |
|
500 |
内部异常。 |
错误码
请参见错误码。