JSONFile

The JSONFile resource lets you generate JSON files using AI models. It supports both schema-based validation and freeform JSON generation.

Minimal Example

Generate a simple JSON configuration file:

import { JSONFile } from "alchemy/ai";

const config = await JSONFile("app-config", {
  path: "./config/app.json",
  prompt: "Generate a configuration for a web application with server settings, database connection details, and feature flags"
});

Schema Validation

Use ArkType schemas to validate and type the generated JSON:

import { JSONFile } from "alchemy/ai";
import { type } from "arktype";

const userSchema = type({
  users: [{
    id: "string",
    name: "string", 
    email: "string",
    role: "'admin' | 'user' | 'guest'",
    permissions: "string[]"
  }]
});

const userData = await JSONFile("user-data", {
  path: "./data/users.json",
  schema: userSchema,
  prompt: "Generate sample user data with various roles and permissions",
  temperature: 0.2
});

// Type-safe access
console.log(userData.json.users[0].role); // Typed as 'admin' | 'user' | 'guest'

Custom System Prompt

Customize the AI's behavior with a custom system prompt:

import { JSONFile } from "alchemy/ai";

const apiMock = await JSONFile("api-mock", {
  path: "./mocks/products.json",
  prompt: "Create mock data for a product catalog API with 10 products",
  system: "You are an API design expert. Create realistic mock JSON data that follows REST API best practices.",
  model: {
    id: "claude-3-opus-20240229",
    provider: "anthropic"
  }
});