Zod s JavaScriptom
Na tejto strane
Štruktúrované výstupy v JavaScripte
Ak vyvíjaš v JavaScripte alebo TypeScripte, Zod je ekvivalentom knižnice Pydantic. Táto knižnica na validáciu schém sa bezproblémovo integruje s API Grok a umožňuje generovať typované štruktúrované výstupy.
Inštalácia
npm install zod openai
JavaScript SDK od OpenAI funguje priamo s API Grok – stačí ho nasmerovať na správny koncový bod.
Konfigurácia klienta
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Definícia schémy pomocou Zod
Zod využíva fluentné rozhranie (fluent API) na definovanie schém. Každá metóda zodpovedá typu JSON:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Mapovanie typov
| 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 reťazcov | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Zjednotené typy (Union types) |
z.nullable() | anyOf s null | str | None |
Kompletný príklad
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
Vnorené schémy
Rovnako ako Pydantic, aj Zod prirodzene spracováva vnorenie:
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())
});
Voliteľné polia pomocou nullable
Ak chceš, aby bolo pole voliteľné (mohlo mať hodnotu null), použi metódu .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Validácia na strane klienta
Jednou z výhod Zod je možnosť validovať dáta priamo na strane klienta pomocou tej istej schémy:
const rawData = JSON.parse(response.choices[0].message.content);
// Validácia pomocou Zod
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Chyba validácie:", result.error);
}
V praxi bude validácia vždy úspešná, pretože API garantuje dodržanie schémy. Táto dodatočná vrstva sa však hodí pre zvýšenie robustnosti v produkčnom prostredí.
Kľúčové poznatky
- Zod je ekvivalentom Pydantic pre JavaScript a TypeScript
- Syntax je fluentná:
z.string(),z.number(),z.object({...}) - Metóda
.nullable()robí pole voliteľným (môže byťnull) - Schémy Zod odovzdávaj v
response_format.json_schema.schema safeParse()umožňuje obrannú validáciu na strane klienta- JavaScript SDK od OpenAI funguje priamo s API Grok