ZodGPT 使用教程

ZodGPT 使用教程

zod-gpt Get structured, fully typed, and validated JSON outputs from OpenAI and Anthropic models. 项目地址: https://gitcode.com/gh_mirrors/zo/zod-gpt

1. 项目介绍

ZodGPT 是一个开源库，用于从 OpenAI 和 Anthropic 模型中获取结构化、类型完整且经过验证的 JSON 输出。该库通过强制模型始终以函数调用的形式响应，并添加自我反思功能以及使用 Zod 进行解析和类型化，从而实现上述功能。

2. 项目快速启动

首先，确保你已经安装了 Node.js 环境。接下来，按照以下步骤进行操作：

# 安装 zod-gpt
npm i zod-gpt
# 或者
yarn add zod-gpt

# 初始化项目
mkdir my-zod-gpt-project
cd my-zod-gpt-project
npm init -y

# 安装依赖
npm i zod-gpt llm-api

接下来，创建一个名为 index.js 的文件，并添加以下代码来初始化 ZodGPT 并发送一个简单的请求：

const { OpenAIChatApi } = require('llm-api');
const { completion } = require('zod-gpt');

// 配置 OpenAI API
const openai = new OpenAIChatApi({
  apiKey: 'YOUR_OPENAI_KEY'
});

// 发送请求
const response = await completion(openai, '你好！');
console.log(response.data); // 输出：'你好！'

请替换 'YOUR_OPENAI_KEY' 为你的 OpenAI API 密钥。

3. 应用案例和最佳实践

以下是一个使用 ZodGPT 获取结构化输出的示例：

const { OpenAIChatApi } = require('llm-api');
const { completion, z } = require('zod-gpt');

// 配置 OpenAI API
const openai = new OpenAIChatApi({
  apiKey: 'YOUR_OPENAI_KEY'
});

// 定义输出结构
const startupSchema = z.object({
  name: z.string().describe('创业公司的名称'),
  description: z.string().describe('该公司做什么？')
});

// 发送请求并获取结构化输出
const response = await completion(openai, '生成一个创业想法', {
  schema: startupSchema
});

console.log(response.data); // 输出：{ name: '示例名称', description: '示例描述' }

确保为每个字段添加描述，以便模型能够理解所需的数据。

4. 典型生态项目

目前，ZodGPT 使用 llm-api 库来支持多种 LLM 提供商。你可以查看 llm-api 的文档来了解如何配置模型参数。

以上就是 ZodGPT 的基本使用教程。你可以根据自己的需求，对项目进行进一步的定制和扩展。

zod-gpt Get structured, fully typed, and validated JSON outputs from OpenAI and Anthropic models. 项目地址: https://gitcode.com/gh_mirrors/zo/zod-gpt