Zod med JavaScript
På denne side
Strukturerede outputs i JavaScript
Hvis du udvikler i JavaScript eller TypeScript, er Zod modstykket til Pydantic. Dette bibliotek til validering af skemaer integreres problemfrit med Grok API’en for at producere typede, strukturerede outputs.
Installation
npm install zod openai
OpenAI SDK’et til JavaScript fungerer direkte med Grok API’en – du skal blot pege det på det korrekte endpoint.
Klientkonfiguration
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "your-xai-key",
baseURL: "https://api.x.ai/v1"
});
Definition af et skema med Zod
Zod bruger et flydende API (fluent API) til at definere skemaer. Hver metode svarer til en JSON-type:
import { z } from "zod";
const MovieReview = z.object({
title: z.string(),
rating: z.number(),
summary: z.string(),
recommend: z.boolean()
});
Typemapping
| Zod | JSON-skema | Pydantic (Python) |
|---|---|---|
z.string() | "type": "string" | str |
z.number() | "type": "number" | float |
z.boolean() | "type": "boolean" | bool |
z.array(z.string()) | array af strenge | list[str] |
z.object({...}) | "type": "object" | BaseModel |
z.enum([...]) | enum | Literal[...] |
z.union([...]) | anyOf | Union-typer |
z.nullable() | anyOf med null | str | None |
Komplet eksempel
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
Næstede skemaer
Ligesom Pydantic håndterer Zod næstning naturligt:
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())
});
Valgfrie felter med nullable
For at gøre et felt valgfrit (så det kan være null), bruger du .nullable():
const Produit = z.object({
nom: z.string(),
prix: z.number(),
description: z.string().nullable(),
promotion: z.number().nullable()
});
Validering på klientsiden
En fordel ved Zod er, at du kan validere data på klientsiden ved hjælp af samme skema:
const rawData = JSON.parse(response.choices[0].message.content);
// Validering med Zod
const result = Analyse.safeParse(rawData);
if (result.success) {
console.log(result.data.titre);
} else {
console.error("Valideringsfejl:", result.error);
}
I praksis vil valideringen altid lykkes, fordi API’en garanterer overholdelse af skemaet. Dette ekstra lag er dog nyttigt for at sikre robusthed i produktion.
Vigtige pointer
- Zod er JavaScript/TypeScript-modstykket til Pydantic
- Syntaksen er flydende:
z.string(),z.number(),z.object({...}) .nullable()gør et felt valgfrit (kan værenull)- Send Zod-skemaer i
response_format.json_schema.schema safeParse()muliggør defensiv validering på klientsiden- OpenAI SDK’et til JavaScript fungerer direkte med Grok API’en