🚧 WIP

Author: maraisr

examples/ai/prompt.ts

@@ -0,0 +1,19 @@
+import {prompt} from '@github/models'
+import {generateText} from 'ai'
+import 'dotenv/config'
+
+async function main() {
+  const call = await prompt('./teacher.prompt.yml', {
+    subject: 'balloon popping',
+  })
+  const result = await generateText(call)
+
+  console.log('Text:')
+  console.log(result.text)
+  console.log()
+
+  console.log('Token usage:', result.usage)
+  console.log('Finish reason:', result.finishReason)
+}
+
+main().catch(console.error)

examples/ai/teacher.prompt.yml

@@ -0,0 +1,10 @@
+name: teacher
+model: openai/gpt-4o-mini
+modelParameters:
+  temperature: 0.7
+  maxTokens: 300
+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.

package-lock.json

@@ -32,16 +32,19 @@
   "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",
+    "zod": "^3 || ^4"
   },
   "devDependencies": {
-    "eslint-plugin-simple-import-sort": "12.1.1",
-    "tsup": "^8.3.0",
     "@github/prettier-config": "0.0.6",
     "@types/node": "^24",
     "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"
   },

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,4 +1,5 @@
 export type {GitHubModelsChatModelId} from './options'
+export {getPrompt, prompt} from './prompt'
 export {
   createGitHubModels,
   githubModels,

src/index.ts

@@ -0,0 +1,67 @@
+import {readFile} from 'node:fs/promises'
+
+import {type LanguageModelV2} from '@ai-sdk/provider'
+// eslint-disable-next-line import/no-unresolved
+import {parseYAML} from 'confbox/yaml'
+import templite from 'templite'
+import {z} from 'zod/v4'
+
+import {createGitHubModels, type GitHubModelsProviderSettings} from './provider'
+
+const message = z.discriminatedUnion('role', [
+  z.object({role: z.literal('user'), content: z.string()}),
+  z.object({role: z.literal('system'), content: z.string()}),
+])
+
+type Message = z.infer<typeof message>
+
+const schema = z.object({
+  name: z.string().optional(),
+  description: z.string().optional(),
+  model: z.string(),
+  modelParameters: z
+    .object({
+      maxTokens: z.number().positive().optional(),
+      temperature: z.number().min(0).max(1).optional(),
+      topP: z.number().min(0).max(1).optional(),
+    })
+    .optional(),
+  messages: z.array(message),
+  responseFormat: z.enum(['text']).optional(),
+})
+
+type PromptConfig = z.infer<typeof schema>
+type Variables = Record<string, string | number | boolean>
+
+export async function getPrompt(filename: string | URL, variables: Variables = {}): Promise<PromptConfig> {
+  const file = await readFile(filename, 'utf8')
+  const yml = parseYAML(file, {
+    filename: filename.toString(),
+  })
+  const p = schema.parse(yml)
+  for (const msg of p.messages) msg.content = templite(msg.content, variables)
+  return p
+}
+
+export async function prompt(
+  filename: string | URL,
+  variables: Variables = {},
+  options: GitHubModelsProviderSettings = {},
+): Promise<{
+  model: LanguageModelV2
+  messages: Message[]
+  temperature?: number
+  maxOutputTokens?: number
+  topP?: number
+}> {
+  const p = await getPrompt(filename, variables)
+  const provider = createGitHubModels(options)
+
+  return {
+    model: provider(p.model),
+    messages: p.messages,
+    temperature: p.modelParameters?.temperature,
+    maxOutputTokens: p.modelParameters?.maxTokens,
+    topP: p.modelParameters?.topP,
+  }
+}

src/prompt.ts

@@ -7,7 +7,7 @@
     "declaration": true,
     "outDir": "dist",
     "preserveConstEnums": true,
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "allowJs": true,
     "allowSyntheticDefaultImports": true,
     "allowUnreachableCode": false,