Structured Data

For convenience, we use valibot as an example.

But this package uses xsschema internally, so it supports any schema library that xsschema supports: e.g. zod, valibot, arktype, etc.

See xsschema for more information.

npm i @xsai/generate-object

Examples

These below examples require you to install a standard schema to json schema parser (a separate package). As they are not provided by zod or valibot natively.

Object

import { generateObject } from '@xsai/generate-object'
import { env } from 'node:process'
import * as v from 'valibot'
 
const { object } = await generateObject({
  apiKey: env.OPENAI_API_KEY!,
  baseURL: 'https://api.openai.com/v1/',
  messages: [
    {
      content: 'Extract the event information.',
      role: 'system'
    },
    {
      content: 'Alice and Bob are going to a science fair on Friday.',
      role: 'user'
    }
  ],
  model: 'gpt-4o',
  schema: v.object({
    name: v.string(),
    date: v.string(),
    participants: v.array(v.string()),
  })
})

Array

import { generateObject } from '@xsai/generate-object'
import { env } from 'node:process'
import * as v from 'valibot'
 
const { object: objects } = await generateObject({
  apiKey: env.OPENAI_API_KEY!,
  baseURL: 'https://api.openai.com/v1/',
  messages: [
    {
      content: 'Generate 3 hero descriptions for a fantasy role playing game.',
      role: 'user'
    }
  ],
  model: 'gpt-4o',
  output: 'array', 
  schema: v.object({
    name: v.string(),
    class: v.pipe(
      v.string(),
      v.description('Character class, e.g. warrior, mage, or thief.'),
    ),
    description: v.string(),
  })
})
 
for (const object of objects) { 
  console.log(object)
}

Structured Data

Examples

Object

Array

On this page