structured outputs for llms
npm install kuqoi-instructor_Structured extraction in Typescript, powered by llms, designed for simplicity, transparency, and control._
---
Dive into the world of Typescript-based structured extraction, by OpenAI's function calling API and Zod, typeScript-first schema validation with static type inference. Instructor stands out for its simplicity, transparency, and user-centric design. Whether you're a seasoned developer or just starting out, you'll find Instructor's approach intuitive and steerable.
``bash`
bun add @instructor-ai/instructor zod openai
`bash`
npm i @instructor-ai/instructor zod openai
`bash`
pnpm add @instructor-ai/instructor zod openai
`typescript
import Instructor from "@instructor-ai/instructor";
import OpenAI from "openai"
import { z } from "zod"
const UserSchema = z.object({
age: z.number(),
name: z.string()
})
const oai = new OpenAI({
apiKey: process.env.OPENAI_API_KEY ?? undefined,
organization: process.env.OPENAI_ORG_ID ?? undefined
})
const client = Instructor({
client: oai,
mode: "TOOLS"
})
const UserSchema = z.object({
// Description will be used in the prompt
age: z.number().describe("The age of the user"),
name: z.string()
})
// User will be of type z.infer
const user = await client.chat.completions.create({
messages: [{ role: "user", content: "Jason Liu is 30 years old" }],
model: "gpt-3.5-turbo",
response_model: {
schema: UserSchema,
name: "User"
}
})
console.log(user)
// { age: 30, name: "Jason Liu" }
`
The question of using Instructor is fundamentally a question of why to use zod.
1. Powered by OpenAI SDK — Instructor is powered by OpenAI's API. This means you can use the same API for both prompting and extraction across multiple providers that support the OpenAI API.
2. Customizable — Zod is highly customizable. You can define your own validators, custom error messages, and more.
3. Ecosystem Zod is the most widely used data validation library for Typescript.
4. Battle Tested — Zod is downloaded over 24M times per month, and supported by a large community of contributors.
If you'd like to see more check out our cookbook.
Installing Instructor is a breeze.
If you want to help out, checkout some of the issues marked as good-first-issue or help-wanted`. Found here. They could be anything from code improvements, a guest blog post, or a new cook book.
Checkout the [contribution guide]() for details on how to set things up, testing, changesets and guidelines.
> ℹ️ Tip: Support in other languages
Check out ports to other languages below:
If you want to port Instructor to another language, please reach out to us on Twitter we'd love to help you get started!
This project is licensed under the terms of the MIT License.