更新时间:2025-11-28 GMT+08:00
分享

创建提示词 - CreatePrompt

功能介绍

创建提示词。

当前创建的提示词如果需要用到FreeMarker语法,需要先进行提示词检测,避免变量不存在。FreeMarker手册:https://freemarker.apache.org/docs/ref.html

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

application_id

String

参数解释:

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

约束限制:

字符串

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token(X-Auth-Token)

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

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

MLLM_PROMPT 多模态模型提示词

取值范围:

  • 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 多模态模型提示词。

prompts

Array of PromptItem objects

参数解释:

提示词多语言内容列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

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

表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/b25446daeb1a41a7953c5deba2b2677a/applications/5071b12e-8c5c-4181-a15b-41e6ae3915ea/uni-search/prompt

{
  "name" : "api_test",
  "detail" : "",
  "type" : "CHAT_PROMPT",
  "prompts" : [ {
    "language" : "zh",
    "prompt" : "请你结合对话历史和给定文档回复用户请求,遵循以下原则:\n1.严格遵从文档原文术语和阐述逻辑,不要生成多余的内容;\n2.如果结合对话历史和给定文档无法回复用户请求,请按照自己的知识回答。\n3.文档信息中形如'{'img-001'}'表示图片id,如果生成结果带上图片效果更好,请原样输出图片id。\n4.文档中格式样式例如'{'img-001:t图片描述'}'表示图片id和表述,如果生成结果带上图片效果更好,请原样输出图片id和描述。\n5.不要在回答末尾堆叠图片id,不要在标点符号前生成图片id,不要生成重复的图片id;\n6.文档基础信息中不包含图片id时,不要生成图片id。\n文档的基础信息如下:\n{0}\n问题:{1}"
  }, {
    "language" : "en",
    "prompt" : "Please answer user questions based on the chat history and provided documents. Abide by the following principles:\n1. Use the terms and descriptive logic of the provided documents. Do not generate redundant content.\n2. If you cannot answer user questions based on the chat history and the provided documents, answer them based on your own knowledge.\n3. Details like '{'img-001'}' in the documents are image IDs. If images help improve your answers, include image IDs (in their original format).\n4. Details like '{'img-001:timage description'}' in the documents are image IDs plus image descriptions. If images help improve your answers, include the image IDs and descriptions (in their original formats).\n5. Do not stack image IDs at the end of an answer; do not generate image IDs before punctuation; and do not generate duplicate image IDs.\n6. If the documents do not contain image IDs, do not generate image IDs.\nBasic document information:\n{0}\nQuestion:{1}"
  }, {
    "language" : "ar",
    "prompt" : "[المواد]: {0}\n[المهمة]: أنت مساعد ذكي للأسئلة والأجوبة. يمكنك الجمع بين المحادثات التاريخية و[الأسئلة] وتقديم إجابات دقيقة بما يتوافق تمامًا مع [المتطلبات]. \n[المتطلبات]:\n 1. قد تكون هناك أجزاء في [المواد] غير مرتبطة بـ [المشكلة]، يرجى الانتباه لتمييزها، والإشارة فقط إلى المحتوى المتعلق بـ [المشكلة]؛\n 2. إذا كانت هناك أجزاء في [المواد] لا تتعلق بـ [المشكلة]، بالنسبة للمحتوى المتعلق بـ [السؤال]، فسترجع إلى [المادة] للإجابة على [السؤال]؛\n 3. إذا لم يكن [السؤال] مرتبطًا بـ [السؤال] [المادة]، فلا داعي للانتباه إلى محتوى [المادة] والإجابة على [السؤال] مباشرة.\n 4. يرجى ملاحظة أن [الإجابة] يجب أن تكون دقيقة، ويجب أن يكون التعبير واضحًا ومنظمًا ، حاول استخدام النص الأصلي لـ [المادة] للإجابة، ولا تحذف المعلومات الأساسية. \n 5. لا تجيب على محتوى لا علاقة له بـ [السؤال]. \n[سؤال]: {1}\n[إجابة]:"
  }, {
    "language" : "th",
    "prompt" : "[เอกสาร] {0}\n[งาน]: คุณเป็นผู้ช่วยตอบคําถามอัจฉริยะ คุณสามารถรวมประวัติการสนทนาและคําถามเข้าด้วยกันเพื่อให้คําตอบที่ถูกต้องตามข้อกําหนดอย่างเคร่งครัด\n[ข้อกําหนด]:\n1. เนื้อหาอาจมีส่วนที่ไม่เกี่ยวข้องกับ [คำถาม] โปรดใช้ความระมัดระวังในการแยกแยะและอ้างอิงเฉพาะเนื้อหาที่เกี่ยวข้องกับ [คำถาม] เท่านั้น\n2. หากมีเนื้อหาที่เกี่ยวข้องกับ [คําถาม] ใน [เอกสาร] คุณจะใช้ [วัสดุ] เพื่อตอบ [คําถาม]\n3. หาก [คําถาม] และ [เอกสาร] ไม่เกี่ยวข้องกัน คุณไม่จําเป็นต้องสนใจเนื้อหาของ [เอกสาร] เพียงตอบ [คําถาม] โดยตรง\n4. โปรดทราบว่า [คําตอบ] ควรมีความแม่นยํา ชัดเจนและเป็นระเบียบ พยายามตอบโดยใช้ข้อความต้นฉบับของ [เนื้อหา] และไม่พลาดข้อมูลสําคัญ\n5. อย่าตอบสิ่งที่ไม่เกี่ยวข้องกับ [คําถาม]\n[คำถาม]: {1}\n[คําตอบ]:"
  }, {
    "language" : "pt",
    "prompt" : "Responda ao pedido do utilizador com base no histórico da conversa e nos documentos fornecidos, seguindo estas linhas de orientação:\n1. Cumpra rigorosamente os termos e a lógica de descrição do documento original.\n2. Se não conseguir responder ao pedido do utilizador com base no histórico da conversa e no documento fornecido, responda à pergunta com base nos seus conhecimentos.\n3. No documento, o estilo de formato '{'img-001'}' indica o ID da imagem. Se o resultado gerado for melhor com imagens, indique o ID da imagem tal como está.\n4. No documento, o estilo de formato '{'img-001:tdescrição da imagem'}' indica o ID e a descrição da imagem. Se o resultado gerado for melhor com imagens, indique o ID e a descrição da imagem da mesma forma.\n5. Se as informações do documento não contiverem um ID de imagem, não proceda à geração do mesmo.\nSeguem-se as informações de base sobre este documento:\n{0}\nPergunta: {1}"
  }, {
    "language" : "es",
    "prompt" : "Responderá a la solicitud del usuario con el historial de conversaciones y los documentos proporcionados, siguiendo estas pautas:\n1. Cumpla estrictamente con los términos y la lógica descriptiva del documento original.\n2. Si no puede responder a la solicitud del usuario basándose en el historial de conversaciones y en el documento proporcionado, responda a la pregunta basándose en sus conocimientos.\n3. En el documento, el estilo de formato '{'img-001'}' indica la ID de la imagen. Si el resultado generado es mejor con imágenes, muestre el ID de la imagen tal como está.\n4. En el documento, el estilo de formato '{'img-001:tdescripción de la imagen'}' indica la ID de la imagen. Si el resultado generado es mejor con imágenes, muestre el ID de la imagen y la descripción tal como están.\n5. Si la información del documento no contiene un ID de imagen, no lo genere.\nLa información básica de este documento es la siguiente:\n{0}\nPregunta:{1}"
  } ],
  "freemarker_enabled" : false,
  "search_scope" : "DOCUMENT"
}

响应示例

状态码:200

成功创建提示词,返回提示词id。

{
  "id" : "031d77dd-66b1-49c9-a651-bca9f65f17fc"
}

状态码

状态码

描述

200

成功创建提示词,返回提示词id。

400

请求体参数错误。

500

内部异常。

错误码

请参见错误码

相关文档