Quickstart

Installation

Node.js

npm i structured-outputs

Deno

deno add jsr:@crosshatch/structured-outputs@0.1.0-beta.X

# The following will work upon stabilization.
deno add jsr:@crosshatch/structured-outputs

Node.js-specific Setup

The structured-outputs NPM package does not contain a CommonJS build; only ES Modules are supported. Therefore, we must specify module as the value of the package.json's type field.

{
  // ...
+ "type": "module"
}

Basic Example

Let's generate a character with superpowers according to the following shape:

import { ResponseFormat, T } from "structured-outputs"

const Supe = T.object({
  name: T.string`The super-abled character's name.`,
  role: T.constantUnion("Hero", "Villain", "Indifferent"),
  age: T.number`Between 18 and 200 years of age.`,
})

Create a ResponseFormat with the Supe type.

const response_format = ResponseFormat("create_supe", Supe)

Optionally give a description to the response format.

const response_format = ResponseFormat("create_supe", Supe)`
  Information about a super-abled character.
`

Use your OpenAI client normally, then unwrap the structured output choice with response_format.into.

const supe = await openai.chat.completions
  .create({
    model: "gpt-4o-mini",
    response_format,
    messages: [{ role: "system", content: [] }],
  })
  .then(response_format.into)

supe