Zod ar JavaScript
Šajā lapā
Structurēta izvade JavaScript valodā
Ja izstrādā JavaScript vai TypeScript vidē, Zod ir Pydantic līdzvērtīgais risinājums. Šī shēmu validācijas bibliotēka nevainojami integrējas ar Grok API, lai ģenerētu tipizētu strukturētu izvadi.
Instalācija
npm install zod openai
OpenAI SDK JavaScript valodai strādā tieši ar Grok API — tev vienkārši jānorāda pareizais galapunkts.
Klienta konfigurācija
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Shēmas definēšana ar Zod
Zod izmanto plūstošu (fluent) API shēmu definēšanai. Katra metode atbilst JSON tipam:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Tipu kartēšana
| Zod | JSON shēma | Pydantic (Python) |
|---|---|---|
z.string() | "type": "string" | str |
z.number() | "type": "number" | float |
z.boolean() | "type": "boolean" | bool |
z.array(z.string()) | virkņu array | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Apvienotie tipi |
z.nullable() | anyOf ar null | str | None |
Pilns piemērs
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
Ligzdotas shēmas
Tāpat kā Pydantic, Zod dabiski apstrādā ligzdošanu:
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())
});
Neobligāti lauki ar nullable
Lai padarītu lauku neobligātu (spējīgu būt null), izmanto .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Validācija klienta pusē
Viena no Zod priekšrocībām ir iespēja validēt datus klienta pusē, izmantojot to pašu shēmu:
const rawData = JSON.parse(response.choices[0].message.content);
// Validācija ar Zod
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Validation error:", result.error);
}
Praksē validācija vienmēr būs veiksmīga, jo API garantē atbilstību shēmai. Tomēr šis papildu slānis ir noderīgs, lai nodrošinātu robustumu ražošanas vidē.
Galvenās atziņas
- Zod ir JavaScript/TypeScript ekvivalents Pydantic
- Sintakse ir plūstoša:
z.string(),z.number(),z.object({...}) .nullable()padara lauku neobligātu (var būtnull)- Nodoj Zod shēmas parametrā
response_format.json_schema.schema safeParse()ļauj veikt aizsargājošu validāciju klienta pusē- OpenAI SDK JavaScript valodai strādā tieši ar Grok API