meta prompt generator
1.0.0
META提示生成器是一個Python軟件包，它基於任務說明或現有提示為語言模型生成詳細的系統提示。它利用OpenAI的GPT模型創建結構良好的，特定於任務的提示，可用於指導AI模型有效地完成各種任務。您也可以在CLI中使用它。
要安裝元提示生成器，您可以克隆或使用PIP：
克隆存儲庫：
git clone https://github.com/Zakk-Yang/meta-prompt-generator.git
cd meta-prompt-generator
通過PIP安裝軟件包：
pip install meta-prompt-generator --upgrade
這是如何使用meta提示生成器的基本示例：
from meta_prompt_generator import generate_prompt
# Generate a prompt
task = "Create a prompt for generating creative short stories"
prompt = generate_prompt ( task )
print ( prompt )生成的提示包裹在降價代碼塊中。
在自定義自己的模板之前，建議檢查當前模板。
from meta_prompt_generator . prompts import META_PROMPT
print ( META_PROMPT )輸出：
Given a task description or existing prompt, produce a detailed system prompt to guide a language model in completing the task effectively.
# Guidelines
- Understand the Task: Grasp the main objective, goals, requirements, constraints, and expected output.
- Minimal Changes: If an existing prompt is provided, improve it only if it's simple. For complex prompts, enhance clarity and add missing elements without altering the original structure.
- Reasoning Before Conclusions: Encourage reasoning steps before any conclusions are reached. ATTENTION! If the user provides examples where the reasoning happens afterward, REVERSE the order! NEVER START EXAMPLES WITH CONCLUSIONS!
- Reasoning Order: Call out reasoning portions of the prompt and conclusion parts (specific fields by name). For each, determine the ORDER in which this is done, and whether it needs to be reversed.
- Conclusion, classifications, or results should ALWAYS appear last.
- Examples: Include high-quality examples if helpful, using placeholders [ in brackets ] for complex elements.
- What kinds of examples may need to be included, how many, and whether they are complex enough to benefit from placeholders.
- Clarity and Conciseness: Use clear, specific language. Avoid unnecessary instructions or bland statements.
- Formatting: Use markdown features for readability. DO NOT USE ``` CODE BLOCKS UNLESS SPECIFICALLY REQUESTED.
- Preserve User Content: If the input task or prompt includes extensive guidelines or examples, preserve them entirely, or as closely as possible. If they are vague, consider breaking down into sub-steps. Keep any details, guidelines, examples, variables, or placeholders provided by the user.
- Constants: DO include constants in the prompt, as they are not susceptible to prompt injection. Such as guides, rubrics, and examples.
- Output Format: Explicitly the most appropriate output format, in detail. This should include length and syntax (e.g. short sentence, paragraph, JSON, etc.)
- For tasks outputting well-defined or structured data (classification, JSON, etc.) bias toward outputting a JSON.
- JSON should never be wrapped in code blocks (```) unless explicitly requested.
The final prompt you output should adhere to the following structure below. Do not include any additional commentary, only output the completed system prompt. SPECIFICALLY, do not include any additional messages at the start or end of the prompt. (e.g. no "---")
[ Concise instruction describing the task - this should be the first line in the prompt, no section header ]
[ Additional details as needed. ]
[ Optional sections with headings or bullet points for detailed steps. ]
# Steps [ optional ]
[ optional: a detailed breakdown of the steps necessary to accomplish the task ]
# Output Format
[ Specifically call out how the output should be formatted, be it response length, structure e.g. JSON, markdown, etc ]
# Examples [ optional ]
[ Optional: 1-3 well-defined examples with placeholders if necessary. Clearly mark where examples start and end, and what the input and output are. User placeholders as necessary. ]
[ If the examples are shorter than what a realistic example is expected to be, make a reference with () explaining how real examples should be longer / shorter / different. AND USE PLACEHOLDERS! ]
# Notes [ optional ]
[ optional: edge cases, details, and an area to call or repeat out specific important considerations ]
然後，您可以更改自己的模板並應用：
my_meta_prompt = """ Customize your own template here """
task = "Create a prompt for generating creative short stories"
prompt = generate_prompt ( task , prompt_template = my_meta_prompt )
print ( prompt )以JSON格式輸出：您首先檢查架構模板：
from meta_prompt_generator . prompts import META_SCHEMA_PROMPT , META_SCHEMA
print ( META_SCHEMA_PROMPT )
print ( META_SCHEMA )創建JSON輸出：
from meta_prompt_generator . generator import generate_meta_schema
print ( generate_meta_schema ( 'generate KPIs for a data team' ))輸出：
{
"name" : " kpis_data_team " ,
"type" : " object " ,
"properties" : {
"kpi_list" : {
"type" : " array " ,
"description" : " A list of KPIs defined for the data team. " ,
"items" : {
"type" : " object " ,
"properties" : {
"name" : {
"type" : " string " ,
"description" : " The name of the KPI. "
},
"description" : {
"type" : " string " ,
"description" : " A brief description of what the KPI measures. "
},
"target" : {
"type" : " string " ,
"description" : " The target value or goal for the KPI. "
},
"frequency" : {
"type" : " string " ,
"description" : " The frequency of measuring this KPI (e.g., weekly, monthly). "
},
"owner" : {
"type" : " string " ,
"description" : " The individual or role responsible for this KPI. "
}
},
"required" : [
" name " ,
" description " ,
" target " ,
" frequency " ,
" owner "
],
"additionalProperties" : false
}
}
},
"required" : [
" kpi_list "
],
"additionalProperties" : false
} Feel free to change both META_SCHEMA_PROMPT and META_SCHEMA or other parameters by the example below: task_or_prompt: str, api_key: Optional[str] = None, schema_template: dict = META_SCHEMA, prompt_template: Optional[str] = META_SCHEMA_PROMPT, model_name: Optional[str] = "gpt-4o-mini",
from meta_prompt_generator . generator import generate_meta_schema
print ( generate_meta_schema ( task_or_prompt = 'generate KPIs for a data team' ,
schema_template = 'your schema template' ,
prompt_template = 'your prompt template' ,
model_name = 'your preferred openai model name' # default is gpt-4o-mini
))在CLI中使用：
默認情況下，它使用gpt-4o-mini模型。
meta-prompt " Create a prompt for generating creative short stories "您可以選擇使用其他模型。
meta-prompt " Design a system to classify customer feedback " --model-name gpt-4o不建議在此處添加您的自定義提示模板，因為它可能非常漫長。
包裝需要一個OpenAI API鍵。您可以通過三種方式提供它：
作為generate_prompt函數的參數：
prompt = generate_prompt ( task , api_key = "your-api-key-here" )作為名為OPENAI_API_KEY的環境變量：
export OPENAI_API_KEY= " your-api-key-here "創建.env在根中包括
OPENAI_API_KEY = 'sk-xxx'
注意：確保將.env添加到.gitignore文件中，以免意外地使用API鍵。
歡迎對元提示生成器的貢獻！請隨時提交拉動請求。
該項目是根據MIT許可證獲得許可的 - 有關詳細信息，請參見許可證文件。
