Overview

Features

Getting Started

---name:basic-promptmetadata:model:name:gpt-4o-minitest_settings:props:num:3---<System>You are a math expert</System><User>What's 2 +{props.num}?</User>

Models

Built-In Model Plugins

Custom Model Plugins

Language Support

Running AgentMark

1. VSCode Extension

2. FileLoader

import{ModelPluginRegistry,FileLoader,createTemplateRunner}from"@puzzlet/agentmark";importAllModelPluginsfrom'@puzzlet/all-models';// Register modelsModelPluginRegistry.registerAll(AllModelPlugins);// Create a file loader pointing to your prompts directoryconstfileLoader=newFileLoader("./prompts",createTemplateRunner);construn=async()=>{// Load a prompt, relative to the file loader's rootconstmathPrompt=awaitfileLoader.load("math/addition.prompt.mdx");constprops={num1:5,num2:3}// Run the promptconstresult=awaitmathPrompt.run(props);console.log("Run result:",result.result);// Compile to see the AgentMark configurationconstcompiled=awaitmathPrompt.compile(props);console.log("Compiled configuration:",compiled);// Deserialize to see raw model parameters (i.e. whats sent to the LLM: OpenAI, Anthropic, etc.)constdeserialized=awaitmathPrompt.deserialize(props);console.log("Model parameters:",deserialized);}run();

3. Puzzlet Integration

import{Puzzlet}from'@puzzlet/sdk';import{ModelPluginRegistry,createTemplateRunner}from"@puzzlet/agentmark";importAllModelPluginsfrom'@puzzlet/all-models';ModelPluginRegistry.registerAll(AllModelPlugins);constpuzzletClient=newPuzzlet({apiKey:process.env.PUZZLET_API_KEY!,appId:process.env.PUZZLET_APP_ID!,},createTemplateRunner);construn=async()=>{// Load prompt from Puzzlet instead of local fileconstprompt=awaitpuzzletClient.fetchPrompt('math/addition.prompt.mdx');// Run the promptconstresult=awaitprompt.run({num1:5,num2:3});console.log("Run result:",result);// Compile the promptconstcompiled=awaitprompt.compile({num1:5,num2:3});console.log("Compiled configuration:",compiled);// Deserialize the promptconstdeserialized=awaitprompt.deserialize({num1:5,num2:3});console.log("Model parameters:",deserialized);}run();

Type Safety

---name:math-additionmetadata:model:name:gpt-4osettings:schema:type:"object"properties:sum:type:"number"description:"The sum of the two numbers"required:["sum"]input_schema:type:"object"properties:num1:type:"number"description:"First number to add"num2:type:"number"description:"Second number to add"required:["num1", "num2"]---<System>You are a helpful math assistant that performs addition.</System>

# From local filesnpx @puzzlet/cli generate-types --root-dir ./prompts> puzzlet.types.ts# From local Puzzlet servernpx @puzzlet/cli generate-types --local 9002> puzzlet.types.ts

importPuzzletTypesfrom'./puzzlet.types';import{FileLoader,createTemplateRunner}from"@puzzlet/agentmark";constfileLoader=newFileLoader<PuzzletTypes>("./prompts",createTemplateRunner);// TypeScript will enforce correct input/output typesconstprompt=awaitfileLoader.load("math/addition.prompt.mdx");constresult=awaitprompt.run({num1:5,// Must be numbernum2:3// Must be number});constsum=result.result.sum;// type-safe number

importPuzzletTypesfrom'./puzzlet.types';import{Puzzlet}from'@puzzlet/sdk';constpuzzlet=newPuzzlet<PuzzletTypes>({apiKey:process.env.PUZZLET_API_KEY!,appId:process.env.PUZZLET_APP_ID!,},createTemplateRunner);// Same type safety as FileLoaderconstprompt=awaitpuzzlet.fetchPrompt("math/addition.prompt.mdx");constresult=awaitprompt.run({num1:5,num2:3});constsum=result.result.sum;// type-safe number

Contributing

Community

License