Zod met JavaScript
Op deze pagina
Gestructureerde outputs in JavaScript
Als u ontwikkelt in JavaScript of TypeScript, is Zod het equivalent van Pydantic. Deze bibliotheek voor schemavalidatie integreert naadloos met de Grok API om getypeerde gestructureerde outputs te produceren.
Installatie
npm install zod openai
De OpenAI SDK voor JavaScript werkt direct met de Grok API; u hoeft deze alleen naar het juiste eindpunt te verwijzen.
Clientconfiguratie
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Een schema definiëren met Zod
Zod gebruikt een fluïde API om schema’s te definiëren. Elke methode komt overeen met een JSON-type:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Typetoewijzing
| 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 van strings | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Unietypes |
z.nullable() | anyOf met null | str | None |
Volledig voorbeeld
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
Geneste schema’s
Net als Pydantic verwerkt Zod nesting op natuurlijke wijze:
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())
});
Optionele velden met nullable
Gebruik .nullable() om een veld optioneel te maken (het kan null zijn):
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Validatie aan de clientzijde
Een voordeel van Zod is dat u gegevens aan de clientzijde kunt valideren met hetzelfde schema:
const rawData = JSON.parse(response.choices[0].message.content);
// Validatie met Zod
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Validation error:", result.error);
}
In de praktijk zal de validatie altijd slagen omdat de API naleving van het schema garandeert. Deze extra laag is echter nuttig voor robuustheid in productieomgevingen.
Belangrijkste punten
- Zod is het JavaScript/TypeScript-equivalent van Pydantic
- De syntaxis is fluïde:
z.string(),z.number(),z.object({...}) .nullable()maakt een veld optioneel (kannullzijn)- Geef Zod-schema’s door in
response_format.json_schema.schema safeParse()maakt defensieve validatie aan de clientzijde mogelijk- De OpenAI SDK voor JavaScript werkt direct met de Grok API