Zod cu JavaScript
Pe această pagină
Ieșiri structurate în JavaScript
Dacă dezvoltați în JavaScript sau TypeScript, Zod este echivalentul Pydantic. Această bibliotecă de validare a schemelor se integrează perfect cu API-ul Grok pentru a produce ieșiri structurate tipizate.
Instalare
npm install zod openai
SDK-ul OpenAI pentru JavaScript funcționează direct cu API-ul Grok; trebuie doar să îl direcționați către endpoint-ul corect.
Configurarea clientului
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Definirea unei scheme cu Zod
Zod utilizează un API fluent pentru a defini schemele. Fiecare metodă corespunde unui tip JSON:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Maparea tipurilor
| 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 de șiruri | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Tipuri Union |
z.nullable() | anyOf cu null | str | None |
Exemplu complet
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
Scheme imbricate
La fel ca Pydantic, Zod gestionează imbricarea în mod natural:
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())
});
Câmpuri opționale cu nullable
Pentru a face un câmp opțional (capabil să fie null), utilizați .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Validare lato-client
Un avantaj al Zod este că puteți valida datele lato-client folosind aceeași schemă:
const rawData = JSON.parse(response.choices[0].message.content);
// Validare cu Zod
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Validation error:", result.error);
}
În practică, validarea va reuși întotdeauna, deoarece API-ul garantează conformitatea cu schema. Totuși, acest strat suplimentar este util pentru robustețe în producție.
Puncte cheie
- Zod este echivalentul JavaScript/TypeScript al Pydantic
- Sintaxa este fluentă:
z.string(),z.number(),z.object({...}) .nullable()face un câmp opțional (poate finull)- Transmiteți schemele Zod în
response_format.json_schema.schema safeParse()permite validarea defensivă lato-client- SDK-ul OpenAI pentru JavaScript funcționează direct cu API-ul Grok