instructor-js

项目介绍：instructor-js

instructor-js 是一个基于 TypeScript 的项目，它专注于通过大语言模型（LLMs）实现结构化数据提取。instructor-js 结合了 OpenAI 的函数调用 API 与 Zod 的类型验证，旨在提供简单、透明以及可控的用户体验。无论你是经验丰富的开发者还是刚入门的新手，instructor-js 都将凭借其直观的方法助你一臂之力。

核心特点

简便安装：通过几条简单的命令即可安装所需的包，你可以选择使用 npm、pnpm 或者 bun 来安装。
轻松上手：项目的基本用法展示了如何快速开始使用 Instructor 类进行数据提取，代码片段展示了如何使用 OpenAI 和 Zod 定义数据结构并提取信息。
多模式支持：instructor-js 提供多种模式（如 TOOLS、JSON、MD_JSON等）来定义与模型的交互方式，满足不同的结构化数据响应需求。
流式输出：支持数据流式提取，允许用户在数据被逐步生成时实时接收到响应，这对处理海量数据或增强用户互动体验尤为有用。

安装指导

以下是几种安装方式：

bun add @instructor-ai/instructor zod openai

npm i @instructor-ai/instructor zod openai

pnpm add @instructor-ai/instructor zod openai

使用指南

instructor-js 的基本用法示例展示了如何使用其核心功能，通过 Instructor 类来与 OpenAI 的 API 进行交互，并借助 Zod 定义数据模式以实现结构化数据的提取。

代码示例：

import Instructor from "@instructor-ai/instructor";
import OpenAI from "openai"
import { z } from "zod"

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({
  age: z.number().describe("用户的年龄"),
  name: z.string()
})

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" }