4ebc0afdca
Co-authored-by: hubwriter <hubwriter@github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: felix <guntrip@github.com> Co-authored-by: Felix Guntrip <stevecat@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Tim Rogers <timrogers@github.com> Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com> Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> Co-authored-by: Nhu Do <nhu-do@github.com> Co-authored-by: Ellie Bennett <34038869+elliebennett@users.noreply.github.com> Co-authored-by: Janice <janiceilene@github.com> Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com> Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> Co-authored-by: Steve Ward <steveward@github.com> Co-authored-by: Vanessa <vgrl@github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Kate Catlin <KateCatlin@users.noreply.github.com> Co-authored-by: Claire W <78226508+crwaters16@users.noreply.github.com>
1.7 KiB
1.7 KiB
title, shortTitle, intro, allowTitleToDifferFromFilename, versions
| title | shortTitle | intro | allowTitleToDifferFromFilename | versions | ||||
|---|---|---|---|---|---|---|---|---|
| Storing prompts in GitHub repositories | Store prompts | Store prompts directly in your GitHub repositories to leverage automated text summarization and other AI-driven functionalities. | true |
|
Prompts can be stored as files directly within GitHub repositories. This unlocks the ability to view your prompts in an organized UI, share them with non-technical stakeholders, and run seamless iterations and comparisons on adjustments to models and prompts.
Benefits
- Easy integration with the new suite of AI development tools directly on GitHub.
- Simple and scalable from simple to complex use cases.
- Uses a widely supported format, compatible with existing tools.
Supported file format
Store prompts in markdown files with optional YAML front matter.
The file can be located anywhere in your repository, but it must have the extension .prompt.md.
Example:
---
name: Summarizer
description: Summarizes a given text
model: openai/gpt-4o
model_parameters:
temperature: 0.5
---
system:
You are a text summarizer. Your only job is to summarize a given text to you.
user:
Summarize the given text:
<text>
{% raw %}{{text}}{% endraw %}
</text>
Prompt structure
Prompts have two key parts:
- Runtime information (required)
- Prompt templates (system, user, etc.) using simple {{variable}} placeholders
- Development information (optional)
- Human-readable name and description
- Model identifier and parameters
- Sample data for testing and evaluations
Limitations
You cannot store prompts for:
- Complex templating languages
- Proprietary or complex file formats (such as
.ghprompt, or.prompty)