Zod su JavaScript
Šiame puslapyje
Struktūrizuota išvestis JavaScript kalba
Jei kuriate naudodami JavaScript arba TypeScript, Zod yra Pydantic atitikmuo. Ši schemos validavimo biblioteka puikiai integruojasi su Grok API, kad gautumėte tipizuotą struktūrizuotą išvestį.
Diegimas
npm install zod openai
JavaScript skirtas OpenAI SDK veikia tiesiogiai su Grok API – tereikia nukreipti jį į tinkamą galutinį tašką.
Kliento konfigūravimas
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Schemos apibrėžimas naudojant Zod
Zod naudoja nuosekliąją (fluent) API schemoms apibrėžti. Kiekvienas metodas atitinka JSON tipą:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Tipų atitikimas
| Zod | JSON Schema | Pydantic (Python) |
|---|---|---|
z.string() | "type": "string" | str |
z.number() | "type": "number" | float |
z.boolean() | "type": "boolean" | bool |
z.array(z.string()) | array of strings | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Union types |
z.nullable() | anyOf su null | str | None |
Pilnas pavyzdys
import OpenAI from "openai";
import { z } from "zod";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
const Analyse = z.object({
titre: z.string(),
resume: z.string(),
sentiment: z.enum(["positif", "negatif", "neutre"]),
score: z.number(),
mots_cles: z.array(z.string()),
recommandation: z.boolean()
});
const response = await client.chat.completions.create({
model: "grok-4.20-0309-reasoning",
messages: [{
role: "user",
content: "Analyze the following text: Sales increased by 25% this quarter."
}],
response_format: {
type: "json_schema",
json_schema: {
name: "analyse",
schema: Analyse
}
}
});
const data = JSON.parse(response.choices[0].message.content);
console.log(data.sentiment); // "positive"
console.log(data.score); // 0.92
Įdėtinės schemos
Kaip ir Pydantic, Zod natūraliai tvarko įdėtumą:
const Adresse = z.object({
rue: z.string(),
ville: z.string(),
code_postal: z.string(),
pays: z.string()
});
const Contact = z.object({
nom: z.string(),
email: z.string(),
telephone: z.string().nullable(),
adresse: Adresse,
tags: z.array(z.string())
});
Neprivalomi laukai naudojant nullable
Norėdami padaryti lauką neprivalomą (galinčiu būti null), naudokite .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Validavimas kliento pusėje
Vienas iš Zod privalumų – galimybė validuoti duomenis kliento pusėje naudojant tą pačią schemą:
const rawData = JSON.parse(response.choices[0].message.content);
// Validavimas su Zod
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Validation error:", result.error);
}
Praktiškai validavimas visada bus sėkmingas, nes API garantuoja schemos laikymąsi. Tačiau šis papildomas sluoksnis yra naudingas užtikrinant patikimumą gamybinėje aplinkoje.
Svarbiausi punktai
- Zod yra JavaScript/TypeScript Pydantic atitikmuo
- Sintaksė yra nuoseklioji:
z.string(),z.number(),z.object({...}) .nullable()padaro lauką neprivalomu (gali būtinull)- Perdavekite Zod schemas į
response_format.json_schema.schema safeParse()leidžia atlikti apsauginį validavimą kliento pusėje- JavaScript skirtas OpenAI SDK veikia tiesiogiai su Grok API