🚧 WP

Author: maraisr

examples/ai/prompt.ts

@@ -0,0 +1,18 @@
+import 'dotenv/config'
+
+import {prompt} from '@github/models'
+import {readFile} from 'node:fs/promises'
+
+const generate = prompt.fromYaml(await readFile('./teacher.prompt.yml', 'utf8'))
+
+async function main() {
+  const result = await generate({
+    subject: 'balloon popping',
+  })
+
+  console.log('Result:')
+  console.log('text' in result ? result.text : result.object)
+  console.log()
+}
+
+main().catch(console.error)

examples/ai/teacher.prompt.yml

@@ -0,0 +1,26 @@
+name: teacher
+model: openai/gpt-4.1
+responseFormat: json_schema
+jsonSchema: |-
+  {
+    "name": "explanation",
+    "strict": true,
+    "schema": {
+      "type": "object",
+      "properties": {
+        "lesson": {
+          "type": "string",
+          "description": "The lesson about the subject"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "lesson"
+      ]
+    }
+  }
+messages:
+  - role: system
+    content: You're an elementary school teacher who loves to make learning fun.
+  - role: user
+    content: Please explain {{subject}} in as little as 5 sentences and give it to be as json.

package-lock.json

@@ -39,19 +39,27 @@
   "dependencies": {
     "@ai-sdk/openai-compatible": "beta",
     "@ai-sdk/provider": "beta",
-    "@ai-sdk/provider-utils": "beta"
+    "@ai-sdk/provider-utils": "beta",
+    "confbox": "^0.2.2",
+    "templite": "^1.2.0",
+    "tiny-invariant": "^1.3.3",
+    "zod": "^3 || ^4"
+  },
+  "peerDependencies": {
+    "ai": "beta"
   },
   "devDependencies": {
     "@github/prettier-config": "0.0.6",
     "@types/node": "^24",
+    "ai": "beta",
+    "dotenv": "^17.2.0",
     "eslint": "^9",
     "eslint-plugin-github": "^6",
     "eslint-plugin-simple-import-sort": "12.1.1",
     "prettier": "^3",
     "tsup": "^8.3.0",
     "typescript": "^5.7.2",
-    "vitest": "^3",
-    "dotenv": "^17.2.0"
+    "vitest": "^3"
   },
   "engines": {
     "node": ">=20"

package.json

@@ -74,6 +74,10 @@ You can use the following optional settings to customize the GitHub Models provi
   You can use it as a middleware to intercept requests,
   or to provide a custom fetch implementation for e.g. testing.
 
+## Prompt.yaml
+
+TODO
+
 ## License
 
 Distributed under the MIT license. See [LICENSE](./license.txt) for details.

readme.md

@@ -1,2 +1,3 @@
 export type {GitHubModelsChatModelId, GitHubModelsEmbeddingModelId} from './model-id'
+export {prompt} from './prompt'
 export {createGitHubModels, githubModels, type GitHubModelsProvider, type GitHubModelsProviderOptions} from './provider'