You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
intro: 'Store prompts directly in your GitHub repositories to leverage automated text summarization and other AI-driven functionalities.'
5
-
allowTitleToDifferFromFilename: true
6
-
versions:
7
-
fpt: '*'
8
-
ghec: '*'
9
-
---
10
-
11
-
Prompts can be stored as files directly within {% data variables.product.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.
12
-
13
-
## Benefits
14
-
15
-
* Easy integration with the new suite of AI development tools directly on {% data variables.product.github %}.
16
-
* Simple and scalable from simple to complex use cases.
17
-
* Uses a widely supported format, compatible with existing tools.
18
-
19
-
## Supported file format
20
-
21
-
Store prompts in YAML files.
22
-
23
-
The file can be located anywhere in your repository, but _must have the extension `.prompt.yml` or `.prompt.yaml`._
24
-
25
-
Example:
26
-
27
-
```yaml copy
28
1
name: Text Summarizer
29
2
description: Summarizes input text concisely
30
3
model: openai/gpt-4o-mini
@@ -37,7 +10,7 @@ messages:
37
10
content: |
38
11
Summarize the given text, beginning with "Summary -":
39
12
<text>
40
-
{% raw %}{{input}}{% endraw %}
13
+
{{input}}
41
14
</text>
42
15
testData:
43
16
- input: |
@@ -48,23 +21,3 @@ evaluators:
48
21
- name: Output should start with 'Summary -'
49
22
string:
50
23
startsWith: 'Summary -'
51
-
```
52
-
53
-
## Prompt structure
54
-
55
-
Prompts have two key parts:
56
-
57
-
* **Runtime information** (required)
58
-
* Prompt templates (system, user, etc.) using simple {% raw %}`{{variable}}`{% endraw %} placeholders
59
-
* **Development information** (optional)
60
-
* Human-readable name and description
61
-
* Model identifier and parameters
62
-
* Sample data for testing and evaluations
63
-
* Data describing the evaluators themselves
64
-
65
-
## Limitations
66
-
67
-
You cannot store prompts for:
68
-
69
-
* Complex templating languages
70
-
* Proprietary or complex file formats (such as `.ghprompt`, or `.prompty`)
0 commit comments