meta prompt generator
1.0.0
Der Meta -Eingabeaufforderung Generator ist ein Python -Paket, das detaillierte Systemaufforderungen für Sprachmodelle basierend auf Aufgabenbeschreibungen oder vorhandenen Eingabeaufforderungen generiert. Es nutzt die GPT-Modelle von OpenAI, um gut strukturierte, aufgabenspezifische Eingabeaufforderungen zu erstellen, mit denen AI-Modelle beim Erfüllen verschiedener Aufgaben effektiv erledigt werden können. Sie können es auch in CLI verwenden.
Um den Meta -Eingabeaufforderung -Generator zu installieren, können Sie entweder klonen oder PIP verwenden:
Klonen Sie das Repository:
git clone https://github.com/Zakk-Yang/meta-prompt-generator.git
cd meta-prompt-generator
Installieren Sie das Paket über PIP:
pip install meta-prompt-generator --upgrade
Hier ist ein grundlegendes Beispiel für die Verwendung des Meta -Eingabeaufforderungsgenerators:
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 )Die generierte Eingabeaufforderung ist in Markdown -Codeblöcke eingewickelt.
Bevor Sie Ihre eigene Vorlage anpassen, wird empfohlen, die aktuelle Vorlage zu überprüfen.
from meta_prompt_generator . prompts import META_PROMPT
print ( META_PROMPT )Ausgabe:
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 ]
Dann können Sie Ihre eigene Vorlage ändern und sich anwenden:
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 )Ausgabe im JSON -Format: Sie überprüfen zuerst die Schema -Vorlage:
from meta_prompt_generator . prompts import META_SCHEMA_PROMPT , META_SCHEMA
print ( META_SCHEMA_PROMPT )
print ( META_SCHEMA )JSON -Ausgabe erstellen:
from meta_prompt_generator . generator import generate_meta_schema
print ( generate_meta_schema ( 'generate KPIs for a data team' ))Ausgabe:
{
"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
} Fühlen Sie sich frei, sowohl META_SCHEMA_PROMPT als auch META_SCHEMA oder andere Parameter nach dem Beispiel unten zu ändern: Task_or_prompt: str, api_key: optional [str] = none, schema_template: dict = meta_schema, prompt_template: optional [str] = meta_schema, model- und model-
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
))Verwendung in CLI:
Standardmäßig wird das gpt-4o-mini Modell verwendet.
meta-prompt " Create a prompt for generating creative short stories "Sie können ein anderes Modell verwenden.
meta-prompt " Design a system to classify customer feedback " --model-name gpt-4oEs wird nicht empfohlen, Ihre angepasste Eingabeaufforderung hier hinzuzufügen, da sie sehr langwierig sein kann.
Das Paket erfordert einen OpenAI -API -Schlüssel. Sie können es auf drei Arten zur Verfügung stellen:
Als Argument für die Funktion generate_prompt :
prompt = generate_prompt ( task , api_key = "your-api-key-here" ) Als Umgebungsvariable mit dem Namen OPENAI_API_KEY :
export OPENAI_API_KEY= " your-api-key-here "Erstellen .Env in der Wurzel, um einzuschließen
OPENAI_API_KEY = 'sk-xxx'
Hinweis: Stellen Sie sicher, dass Sie Ihre .Gitignore -Datei .EnV hinzufügen, um nicht versehentlich Ihren API -Schlüssel zu begehen.
Beiträge zum Meta -Eingabeaufforderungsgenerator sind willkommen! Bitte zögern Sie nicht, eine Pull -Anfrage einzureichen.
Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.
